Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. LocalPeeringGateway
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Core.LocalPeeringGateway

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Local Peering Gateway resource in Oracle Cloud Infrastructure Core service.

    Creates a new local peering gateway (LPG) for the specified VCN.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testLocalPeeringGateway = new oci.core.LocalPeeringGateway("test_local_peering_gateway", {
    compartmentId: compartmentId,
    vcnId: testVcn.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: localPeeringGatewayDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    peerId: testLocalPeeringGateway2.id,
    routeTableId: testRouteTable.id,
});

    import pulumi
import pulumi_oci as oci

test_local_peering_gateway = oci.core.LocalPeeringGateway("test_local_peering_gateway",
    compartment_id=compartment_id,
    vcn_id=test_vcn["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=local_peering_gateway_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    peer_id=test_local_peering_gateway2["id"],
    route_table_id=test_route_table["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.NewLocalPeeringGateway(ctx, "test_local_peering_gateway", &Core.LocalPeeringGatewayArgs{
			CompartmentId: pulumi.Any(compartmentId),
			VcnId:         pulumi.Any(testVcn.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(localPeeringGatewayDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			PeerId:       pulumi.Any(testLocalPeeringGateway2.Id),
			RouteTableId: pulumi.Any(testRouteTable.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testLocalPeeringGateway = new Oci.Core.LocalPeeringGateway("test_local_peering_gateway", new()
    {
        CompartmentId = compartmentId,
        VcnId = testVcn.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = localPeeringGatewayDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        PeerId = testLocalPeeringGateway2.Id,
        RouteTableId = testRouteTable.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.LocalPeeringGateway;
import com.pulumi.oci.Core.LocalPeeringGatewayArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testLocalPeeringGateway = new LocalPeeringGateway("testLocalPeeringGateway", LocalPeeringGatewayArgs.builder()
            .compartmentId(compartmentId)
            .vcnId(testVcn.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(localPeeringGatewayDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .peerId(testLocalPeeringGateway2.id())
            .routeTableId(testRouteTable.id())
            .build());

    }
}

    resources:
  testLocalPeeringGateway:
    type: oci:Core:LocalPeeringGateway
    name: test_local_peering_gateway
    properties:
      compartmentId: ${compartmentId}
      vcnId: ${testVcn.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${localPeeringGatewayDisplayName}
      freeformTags:
        Department: Finance
      peerId: ${testLocalPeeringGateway2.id}
      routeTableId: ${testRouteTable.id}

    Create LocalPeeringGateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LocalPeeringGateway(name: string, args: LocalPeeringGatewayArgs, opts?: CustomResourceOptions);
    @overload
def LocalPeeringGateway(resource_name: str,
                        args: LocalPeeringGatewayArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def LocalPeeringGateway(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        compartment_id: Optional[str] = None,
                        vcn_id: Optional[str] = None,
                        defined_tags: Optional[Mapping[str, str]] = None,
                        display_name: Optional[str] = None,
                        freeform_tags: Optional[Mapping[str, str]] = None,
                        peer_id: Optional[str] = None,
                        route_table_id: Optional[str] = None)
    func NewLocalPeeringGateway(ctx *Context, name string, args LocalPeeringGatewayArgs, opts ...ResourceOption) (*LocalPeeringGateway, error)
    public LocalPeeringGateway(string name, LocalPeeringGatewayArgs args, CustomResourceOptions? opts = null)
    public LocalPeeringGateway(String name, LocalPeeringGatewayArgs args)
public LocalPeeringGateway(String name, LocalPeeringGatewayArgs args, CustomResourceOptions options)

    type: oci:Core:LocalPeeringGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LocalPeeringGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LocalPeeringGatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LocalPeeringGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocalPeeringGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocalPeeringGatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var localPeeringGatewayResource = new Oci.Core.LocalPeeringGateway("localPeeringGatewayResource", new()
{
    CompartmentId = "string",
    VcnId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    PeerId = "string",
    RouteTableId = "string",
});

    example, err := Core.NewLocalPeeringGateway(ctx, "localPeeringGatewayResource", &Core.LocalPeeringGatewayArgs{
	CompartmentId: pulumi.String("string"),
	VcnId:         pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PeerId:       pulumi.String("string"),
	RouteTableId: pulumi.String("string"),
})

    var localPeeringGatewayResource = new LocalPeeringGateway("localPeeringGatewayResource", LocalPeeringGatewayArgs.builder()
    .compartmentId("string")
    .vcnId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .peerId("string")
    .routeTableId("string")
    .build());

    local_peering_gateway_resource = oci.core.LocalPeeringGateway("localPeeringGatewayResource",
    compartment_id="string",
    vcn_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    peer_id="string",
    route_table_id="string")

    const localPeeringGatewayResource = new oci.core.LocalPeeringGateway("localPeeringGatewayResource", {
    compartmentId: "string",
    vcnId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    peerId: "string",
    routeTableId: "string",
});

    type: oci:Core:LocalPeeringGateway
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    peerId: string
    routeTableId: string
    vcnId: string

    LocalPeeringGateway Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LocalPeeringGateway resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    VcnId string

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    PeerId string
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    RouteTableId string

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    CompartmentId string
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    VcnId string

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    PeerId string
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    RouteTableId string

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    compartmentId String
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    vcnId String

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    peerId String
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    routeTableId String

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    compartmentId string
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    vcnId string

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    peerId string
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    routeTableId string

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    compartment_id str
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    vcn_id str

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    peer_id str
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    route_table_id str

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    compartmentId String
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    vcnId String

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    peerId String
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    routeTableId String

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LocalPeeringGateway resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IsCrossTenancyPeering bool
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    PeerAdvertisedCidr string
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    PeerAdvertisedCidrDetails List<string>
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    PeeringStatus string
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    PeeringStatusDetails string
    Additional information regarding the peering status, if applicable.
    State string
    The LPG's current lifecycle state.
    TimeCreated string
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    IsCrossTenancyPeering bool
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    PeerAdvertisedCidr string
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    PeerAdvertisedCidrDetails []string
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    PeeringStatus string
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    PeeringStatusDetails string
    Additional information regarding the peering status, if applicable.
    State string
    The LPG's current lifecycle state.
    TimeCreated string
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    isCrossTenancyPeering Boolean
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peerAdvertisedCidr String
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peerAdvertisedCidrDetails List<String>
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peeringStatus String
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peeringStatusDetails String
    Additional information regarding the peering status, if applicable.
    state String
    The LPG's current lifecycle state.
    timeCreated String
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    isCrossTenancyPeering boolean
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peerAdvertisedCidr string
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peerAdvertisedCidrDetails string[]
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peeringStatus string
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peeringStatusDetails string
    Additional information regarding the peering status, if applicable.
    state string
    The LPG's current lifecycle state.
    timeCreated string
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    is_cross_tenancy_peering bool
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peer_advertised_cidr str
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peer_advertised_cidr_details Sequence[str]
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peering_status str
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peering_status_details str
    Additional information regarding the peering status, if applicable.
    state str
    The LPG's current lifecycle state.
    time_created str
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    isCrossTenancyPeering Boolean
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peerAdvertisedCidr String
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peerAdvertisedCidrDetails List<String>
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peeringStatus String
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peeringStatusDetails String
    Additional information regarding the peering status, if applicable.
    state String
    The LPG's current lifecycle state.
    timeCreated String
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing LocalPeeringGateway Resource

    Get an existing LocalPeeringGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LocalPeeringGatewayState, opts?: CustomResourceOptions): LocalPeeringGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_cross_tenancy_peering: Optional[bool] = None,
        peer_advertised_cidr: Optional[str] = None,
        peer_advertised_cidr_details: Optional[Sequence[str]] = None,
        peer_id: Optional[str] = None,
        peering_status: Optional[str] = None,
        peering_status_details: Optional[str] = None,
        route_table_id: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vcn_id: Optional[str] = None) -> LocalPeeringGateway
    func GetLocalPeeringGateway(ctx *Context, name string, id IDInput, state *LocalPeeringGatewayState, opts ...ResourceOption) (*LocalPeeringGateway, error)
    public static LocalPeeringGateway Get(string name, Input<string> id, LocalPeeringGatewayState? state, CustomResourceOptions? opts = null)
    public static LocalPeeringGateway get(String name, Output<String> id, LocalPeeringGatewayState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCrossTenancyPeering bool
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    PeerAdvertisedCidr string
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    PeerAdvertisedCidrDetails List<string>
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    PeerId string
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    PeeringStatus string
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    PeeringStatusDetails string
    Additional information regarding the peering status, if applicable.
    RouteTableId string

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    State string
    The LPG's current lifecycle state.
    TimeCreated string
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsCrossTenancyPeering bool
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    PeerAdvertisedCidr string
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    PeerAdvertisedCidrDetails []string
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    PeerId string
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    PeeringStatus string
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    PeeringStatusDetails string
    Additional information regarding the peering status, if applicable.
    RouteTableId string

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    State string
    The LPG's current lifecycle state.
    TimeCreated string
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    VcnId string

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCrossTenancyPeering Boolean
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peerAdvertisedCidr String
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peerAdvertisedCidrDetails List<String>
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peerId String
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    peeringStatus String
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peeringStatusDetails String
    Additional information regarding the peering status, if applicable.
    routeTableId String

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    state String
    The LPG's current lifecycle state.
    timeCreated String
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCrossTenancyPeering boolean
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peerAdvertisedCidr string
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peerAdvertisedCidrDetails string[]
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peerId string
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    peeringStatus string
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peeringStatusDetails string
    Additional information regarding the peering status, if applicable.
    routeTableId string

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    state string
    The LPG's current lifecycle state.
    timeCreated string
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId string

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_cross_tenancy_peering bool
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peer_advertised_cidr str
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peer_advertised_cidr_details Sequence[str]
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peer_id str
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    peering_status str
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peering_status_details str
    Additional information regarding the peering status, if applicable.
    route_table_id str

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    state str
    The LPG's current lifecycle state.
    time_created str
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcn_id str

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment containing the local peering gateway (LPG).
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isCrossTenancyPeering Boolean
    Whether the VCN at the other end of the peering is in a different tenancy. Example: false
    peerAdvertisedCidr String
    The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered. Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1
    peerAdvertisedCidrDetails List<String>
    The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [192.168.0.0/16, 172.16.0.0/24]
    peerId String
    The OCID of the LPG you want to peer with. Specifying a peer_id connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
    peeringStatus String
    Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.
    peeringStatusDetails String
    Additional information regarding the peering status, if applicable.
    routeTableId String

    (Updatable) The OCID of the route table the LPG will use.

    If you don't specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the LPG.

    For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

    state String
    The LPG's current lifecycle state.
    timeCreated String
    The date and time the LPG was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    vcnId String

    The OCID of the VCN the LPG belongs to.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    LocalPeeringGateways can be imported using the id, e.g.

    $ pulumi import oci:Core/localPeeringGateway:LocalPeeringGateway test_local_peering_gateway "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci