Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. DrgAttachment
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Core.DrgAttachment

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Drg Attachment resource in Oracle Cloud Infrastructure Core service.

Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG at a time, but a DRG can be attached to more than one VCN. The response includes a DrgAttachment object with its own OCID. For more information about DRGs, see Dynamic Routing Gateways (DRGs).

You may optionally specify a display name for the attachment, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

For the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment. For more information about compartments and access control, see Overview of the IAM Service.

Create DrgAttachment Resource

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

Constructor syntax

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

@overload
def DrgAttachment(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  drg_id: Optional[str] = None,
                  defined_tags: Optional[Mapping[str, str]] = None,
                  display_name: Optional[str] = None,
                  drg_route_table_id: Optional[str] = None,
                  export_drg_route_distribution_id: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None,
                  network_details: Optional[_core.DrgAttachmentNetworkDetailsArgs] = None,
                  remove_export_drg_route_distribution_trigger: Optional[bool] = None,
                  route_table_id: Optional[str] = None,
                  vcn_id: Optional[str] = None)
func NewDrgAttachment(ctx *Context, name string, args DrgAttachmentArgs, opts ...ResourceOption) (*DrgAttachment, error)
public DrgAttachment(string name, DrgAttachmentArgs args, CustomResourceOptions? opts = null)
public DrgAttachment(String name, DrgAttachmentArgs args)
public DrgAttachment(String name, DrgAttachmentArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DrgAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DrgAttachmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DrgAttachmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DrgAttachmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DrgAttachmentArgs
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 drgAttachmentResource = new Oci.Core.DrgAttachment("drgAttachmentResource", new()
{
    DrgId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    DrgRouteTableId = "string",
    ExportDrgRouteDistributionId = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    NetworkDetails = new Oci.Core.Inputs.DrgAttachmentNetworkDetailsArgs
    {
        Type = "string",
        Id = "string",
        Ids = new[]
        {
            "string",
        },
        IpsecConnectionId = "string",
        RouteTableId = "string",
        TransportAttachmentId = "string",
        TransportOnlyMode = false,
        VcnRouteType = "string",
    },
    RemoveExportDrgRouteDistributionTrigger = false,
    RouteTableId = "string",
    VcnId = "string",
});
Copy
example, err := core.NewDrgAttachment(ctx, "drgAttachmentResource", &core.DrgAttachmentArgs{
	DrgId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName:                  pulumi.String("string"),
	DrgRouteTableId:              pulumi.String("string"),
	ExportDrgRouteDistributionId: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NetworkDetails: &core.DrgAttachmentNetworkDetailsArgs{
		Type: pulumi.String("string"),
		Id:   pulumi.String("string"),
		Ids: pulumi.StringArray{
			pulumi.String("string"),
		},
		IpsecConnectionId:     pulumi.String("string"),
		RouteTableId:          pulumi.String("string"),
		TransportAttachmentId: pulumi.String("string"),
		TransportOnlyMode:     pulumi.Bool(false),
		VcnRouteType:          pulumi.String("string"),
	},
	RemoveExportDrgRouteDistributionTrigger: pulumi.Bool(false),
	RouteTableId:                            pulumi.String("string"),
	VcnId:                                   pulumi.String("string"),
})
Copy
var drgAttachmentResource = new DrgAttachment("drgAttachmentResource", DrgAttachmentArgs.builder()
    .drgId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .drgRouteTableId("string")
    .exportDrgRouteDistributionId("string")
    .freeformTags(Map.of("string", "string"))
    .networkDetails(DrgAttachmentNetworkDetailsArgs.builder()
        .type("string")
        .id("string")
        .ids("string")
        .ipsecConnectionId("string")
        .routeTableId("string")
        .transportAttachmentId("string")
        .transportOnlyMode(false)
        .vcnRouteType("string")
        .build())
    .removeExportDrgRouteDistributionTrigger(false)
    .routeTableId("string")
    .vcnId("string")
    .build());
Copy
drg_attachment_resource = oci.core.DrgAttachment("drgAttachmentResource",
    drg_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    drg_route_table_id="string",
    export_drg_route_distribution_id="string",
    freeform_tags={
        "string": "string",
    },
    network_details={
        "type": "string",
        "id": "string",
        "ids": ["string"],
        "ipsec_connection_id": "string",
        "route_table_id": "string",
        "transport_attachment_id": "string",
        "transport_only_mode": False,
        "vcn_route_type": "string",
    },
    remove_export_drg_route_distribution_trigger=False,
    route_table_id="string",
    vcn_id="string")
Copy
const drgAttachmentResource = new oci.core.DrgAttachment("drgAttachmentResource", {
    drgId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    drgRouteTableId: "string",
    exportDrgRouteDistributionId: "string",
    freeformTags: {
        string: "string",
    },
    networkDetails: {
        type: "string",
        id: "string",
        ids: ["string"],
        ipsecConnectionId: "string",
        routeTableId: "string",
        transportAttachmentId: "string",
        transportOnlyMode: false,
        vcnRouteType: "string",
    },
    removeExportDrgRouteDistributionTrigger: false,
    routeTableId: "string",
    vcnId: "string",
});
Copy
type: oci:Core:DrgAttachment
properties:
    definedTags:
        string: string
    displayName: string
    drgId: string
    drgRouteTableId: string
    exportDrgRouteDistributionId: string
    freeformTags:
        string: string
    networkDetails:
        id: string
        ids:
            - string
        ipsecConnectionId: string
        routeTableId: string
        transportAttachmentId: string
        transportOnlyMode: false
        type: string
        vcnRouteType: string
    removeExportDrgRouteDistributionTrigger: false
    routeTableId: string
    vcnId: string
Copy

DrgAttachment 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 DrgAttachment resource accepts the following input properties:

DrgId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the DRG.
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.
DrgRouteTableId string

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

ExportDrgRouteDistributionId string
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
NetworkDetails DrgAttachmentNetworkDetails
(Updatable)
RemoveExportDrgRouteDistributionTrigger bool

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

RouteTableId string

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

VcnId Changes to this property will trigger replacement. string
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
DrgId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the DRG.
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.
DrgRouteTableId string

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

ExportDrgRouteDistributionId string
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
NetworkDetails DrgAttachmentNetworkDetailsArgs
(Updatable)
RemoveExportDrgRouteDistributionTrigger bool

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

RouteTableId string

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

VcnId Changes to this property will trigger replacement. string
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
drgId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the DRG.
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.
drgRouteTableId String

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

exportDrgRouteDistributionId String
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
networkDetails DrgAttachmentNetworkDetails
(Updatable)
removeExportDrgRouteDistributionTrigger Boolean

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

routeTableId String

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

vcnId Changes to this property will trigger replacement. String
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
drgId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the DRG.
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.
drgRouteTableId string

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

exportDrgRouteDistributionId string
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
networkDetails DrgAttachmentNetworkDetails
(Updatable)
removeExportDrgRouteDistributionTrigger boolean

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

routeTableId string

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

vcnId Changes to this property will trigger replacement. string
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
drg_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the DRG.
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.
drg_route_table_id str

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

export_drg_route_distribution_id str
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
network_details core.DrgAttachmentNetworkDetailsArgs
(Updatable)
remove_export_drg_route_distribution_trigger bool

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

route_table_id str

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

vcn_id Changes to this property will trigger replacement. str
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
drgId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the DRG.
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.
drgRouteTableId String

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

exportDrgRouteDistributionId String
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
networkDetails Property Map
(Updatable)
removeExportDrgRouteDistributionTrigger Boolean

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

routeTableId String

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

vcnId Changes to this property will trigger replacement. String
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.

Outputs

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

CompartmentId string
The OCID of the compartment containing the DRG attachment.
Id string
The provider-assigned unique ID for this managed resource.
IsCrossTenancy bool
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
State string
The DRG attachment's current state.
TimeCreated string
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
CompartmentId string
The OCID of the compartment containing the DRG attachment.
Id string
The provider-assigned unique ID for this managed resource.
IsCrossTenancy bool
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
State string
The DRG attachment's current state.
TimeCreated string
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartmentId String
The OCID of the compartment containing the DRG attachment.
id String
The provider-assigned unique ID for this managed resource.
isCrossTenancy Boolean
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
state String
The DRG attachment's current state.
timeCreated String
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartmentId string
The OCID of the compartment containing the DRG attachment.
id string
The provider-assigned unique ID for this managed resource.
isCrossTenancy boolean
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
state string
The DRG attachment's current state.
timeCreated string
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartment_id str
The OCID of the compartment containing the DRG attachment.
id str
The provider-assigned unique ID for this managed resource.
is_cross_tenancy bool
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
state str
The DRG attachment's current state.
time_created str
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
compartmentId String
The OCID of the compartment containing the DRG attachment.
id String
The provider-assigned unique ID for this managed resource.
isCrossTenancy Boolean
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
state String
The DRG attachment's current state.
timeCreated String
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Look up Existing DrgAttachment Resource

Get an existing DrgAttachment 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?: DrgAttachmentState, opts?: CustomResourceOptions): DrgAttachment
@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,
        drg_id: Optional[str] = None,
        drg_route_table_id: Optional[str] = None,
        export_drg_route_distribution_id: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_cross_tenancy: Optional[bool] = None,
        network_details: Optional[_core.DrgAttachmentNetworkDetailsArgs] = None,
        remove_export_drg_route_distribution_trigger: Optional[bool] = None,
        route_table_id: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vcn_id: Optional[str] = None) -> DrgAttachment
func GetDrgAttachment(ctx *Context, name string, id IDInput, state *DrgAttachmentState, opts ...ResourceOption) (*DrgAttachment, error)
public static DrgAttachment Get(string name, Input<string> id, DrgAttachmentState? state, CustomResourceOptions? opts = null)
public static DrgAttachment get(String name, Output<String> id, DrgAttachmentState state, CustomResourceOptions options)
resources:  _:    type: oci:Core:DrgAttachment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
The OCID of the compartment containing the DRG attachment.
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.
DrgId Changes to this property will trigger replacement. string
The OCID of the DRG.
DrgRouteTableId string

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

ExportDrgRouteDistributionId string
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
IsCrossTenancy bool
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
NetworkDetails DrgAttachmentNetworkDetails
(Updatable)
RemoveExportDrgRouteDistributionTrigger bool

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

RouteTableId string

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

State string
The DRG attachment's current state.
TimeCreated string
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId Changes to this property will trigger replacement. string
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
CompartmentId string
The OCID of the compartment containing the DRG attachment.
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.
DrgId Changes to this property will trigger replacement. string
The OCID of the DRG.
DrgRouteTableId string

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

ExportDrgRouteDistributionId string
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
IsCrossTenancy bool
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
NetworkDetails DrgAttachmentNetworkDetailsArgs
(Updatable)
RemoveExportDrgRouteDistributionTrigger bool

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

RouteTableId string

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

State string
The DRG attachment's current state.
TimeCreated string
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
VcnId Changes to this property will trigger replacement. string
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
compartmentId String
The OCID of the compartment containing the DRG attachment.
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.
drgId Changes to this property will trigger replacement. String
The OCID of the DRG.
drgRouteTableId String

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

exportDrgRouteDistributionId String
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
isCrossTenancy Boolean
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
networkDetails DrgAttachmentNetworkDetails
(Updatable)
removeExportDrgRouteDistributionTrigger Boolean

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

routeTableId String

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

state String
The DRG attachment's current state.
timeCreated String
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId Changes to this property will trigger replacement. String
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
compartmentId string
The OCID of the compartment containing the DRG attachment.
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.
drgId Changes to this property will trigger replacement. string
The OCID of the DRG.
drgRouteTableId string

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

exportDrgRouteDistributionId string
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
isCrossTenancy boolean
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
networkDetails DrgAttachmentNetworkDetails
(Updatable)
removeExportDrgRouteDistributionTrigger boolean

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

routeTableId string

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

state string
The DRG attachment's current state.
timeCreated string
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId Changes to this property will trigger replacement. string
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
compartment_id str
The OCID of the compartment containing the DRG attachment.
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.
drg_id Changes to this property will trigger replacement. str
The OCID of the DRG.
drg_route_table_id str

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

export_drg_route_distribution_id str
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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 bool
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
network_details core.DrgAttachmentNetworkDetailsArgs
(Updatable)
remove_export_drg_route_distribution_trigger bool

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

route_table_id str

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

state str
The DRG attachment's current state.
time_created str
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcn_id Changes to this property will trigger replacement. str
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.
compartmentId String
The OCID of the compartment containing the DRG attachment.
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.
drgId Changes to this property will trigger replacement. String
The OCID of the DRG.
drgRouteTableId String

(Updatable) The OCID of the DRG route table that is assigned to this attachment.

The DRG route table manages traffic inside the DRG.

exportDrgRouteDistributionId String
(Updatable) The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. This field cannot be set by the user while creating the resource and gets a default value on creation. This can be only be updated to its default value. If this fields needs to be set to null, remove_export_drg_route_distribution_trigger needs to be used.
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"}
isCrossTenancy Boolean
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: false
networkDetails Property Map
(Updatable)
removeExportDrgRouteDistributionTrigger Boolean

(Updatable) An optional property when set to true during update disables the export of route Distribution by setting export_drg_route_distribution_id to null.

** 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

routeTableId String

(Updatable) The OCID of the route table used by the DRG attachment.

If you don't specify a route table here, the DRG attachment is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the DRG attachment. For information about why you would associate a route table with a DRG attachment, see:

state String
The DRG attachment's current state.
timeCreated String
The date and time the DRG attachment was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
vcnId Changes to this property will trigger replacement. String
(Optional) The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to specify the OCID of the attached resource.

Supporting Types

DrgAttachmentNetworkDetails
, DrgAttachmentNetworkDetailsArgs

Type This property is required. string
(Updatable) The type can be one of these values: IPSEC_TUNNEL, LOOPBACK, REMOTE_PEERING_CONNECTION, VCN, VIRTUAL_CIRCUIT
Id Changes to this property will trigger replacement. string
The OCID of the network attached to the DRG.
Ids List<string>
The OCID of the target IPSec tunnel attachment.
IpsecConnectionId string
The IPSec connection that contains the attached IPSec tunnel.
RouteTableId string

(Updatable) This is the OCID of the route table that is used to route the traffic as it enters a VCN through this attachment.

For information about why you would associate a route table with a DRG attachment, see Advanced Scenario: Transit Routing. For information about why you would associate a route table with a DRG attachment, see:

TransportAttachmentId string
The OCID of the virtual circuit's DRG attachment.
TransportOnlyMode bool
Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: true
VcnRouteType string
(Updatable) Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.
Type This property is required. string
(Updatable) The type can be one of these values: IPSEC_TUNNEL, LOOPBACK, REMOTE_PEERING_CONNECTION, VCN, VIRTUAL_CIRCUIT
Id Changes to this property will trigger replacement. string
The OCID of the network attached to the DRG.
Ids []string
The OCID of the target IPSec tunnel attachment.
IpsecConnectionId string
The IPSec connection that contains the attached IPSec tunnel.
RouteTableId string

(Updatable) This is the OCID of the route table that is used to route the traffic as it enters a VCN through this attachment.

For information about why you would associate a route table with a DRG attachment, see Advanced Scenario: Transit Routing. For information about why you would associate a route table with a DRG attachment, see:

TransportAttachmentId string
The OCID of the virtual circuit's DRG attachment.
TransportOnlyMode bool
Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: true
VcnRouteType string
(Updatable) Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.
type This property is required. String
(Updatable) The type can be one of these values: IPSEC_TUNNEL, LOOPBACK, REMOTE_PEERING_CONNECTION, VCN, VIRTUAL_CIRCUIT
id Changes to this property will trigger replacement. String
The OCID of the network attached to the DRG.
ids List<String>
The OCID of the target IPSec tunnel attachment.
ipsecConnectionId String
The IPSec connection that contains the attached IPSec tunnel.
routeTableId String

(Updatable) This is the OCID of the route table that is used to route the traffic as it enters a VCN through this attachment.

For information about why you would associate a route table with a DRG attachment, see Advanced Scenario: Transit Routing. For information about why you would associate a route table with a DRG attachment, see:

transportAttachmentId String
The OCID of the virtual circuit's DRG attachment.
transportOnlyMode Boolean
Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: true
vcnRouteType String
(Updatable) Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.
type This property is required. string
(Updatable) The type can be one of these values: IPSEC_TUNNEL, LOOPBACK, REMOTE_PEERING_CONNECTION, VCN, VIRTUAL_CIRCUIT
id Changes to this property will trigger replacement. string
The OCID of the network attached to the DRG.
ids string[]
The OCID of the target IPSec tunnel attachment.
ipsecConnectionId string
The IPSec connection that contains the attached IPSec tunnel.
routeTableId string

(Updatable) This is the OCID of the route table that is used to route the traffic as it enters a VCN through this attachment.

For information about why you would associate a route table with a DRG attachment, see Advanced Scenario: Transit Routing. For information about why you would associate a route table with a DRG attachment, see:

transportAttachmentId string
The OCID of the virtual circuit's DRG attachment.
transportOnlyMode boolean
Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: true
vcnRouteType string
(Updatable) Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.
type This property is required. str
(Updatable) The type can be one of these values: IPSEC_TUNNEL, LOOPBACK, REMOTE_PEERING_CONNECTION, VCN, VIRTUAL_CIRCUIT
id Changes to this property will trigger replacement. str
The OCID of the network attached to the DRG.
ids Sequence[str]
The OCID of the target IPSec tunnel attachment.
ipsec_connection_id str
The IPSec connection that contains the attached IPSec tunnel.
route_table_id str

(Updatable) This is the OCID of the route table that is used to route the traffic as it enters a VCN through this attachment.

For information about why you would associate a route table with a DRG attachment, see Advanced Scenario: Transit Routing. For information about why you would associate a route table with a DRG attachment, see:

transport_attachment_id str
The OCID of the virtual circuit's DRG attachment.
transport_only_mode bool
Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: true
vcn_route_type str
(Updatable) Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.
type This property is required. String
(Updatable) The type can be one of these values: IPSEC_TUNNEL, LOOPBACK, REMOTE_PEERING_CONNECTION, VCN, VIRTUAL_CIRCUIT
id Changes to this property will trigger replacement. String
The OCID of the network attached to the DRG.
ids List<String>
The OCID of the target IPSec tunnel attachment.
ipsecConnectionId String
The IPSec connection that contains the attached IPSec tunnel.
routeTableId String

(Updatable) This is the OCID of the route table that is used to route the traffic as it enters a VCN through this attachment.

For information about why you would associate a route table with a DRG attachment, see Advanced Scenario: Transit Routing. For information about why you would associate a route table with a DRG attachment, see:

transportAttachmentId String
The OCID of the virtual circuit's DRG attachment.
transportOnlyMode Boolean
Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: true
vcnRouteType String
(Updatable) Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.

Import

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

$ pulumi import oci:Core/drgAttachment:DrgAttachment test_drg_attachment "id"
Copy

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.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci