DrgAttachment¶
- class oci.core.models.DrgAttachment(**kwargs)¶
Bases:
objectA DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, IPSec tunnel, remote peering connection, or virtual circuit.
For more information, see Overview of the Networking Service.
Attributes:
A constant which can be used with the lifecycle_state property of a DrgAttachment.
A constant which can be used with the lifecycle_state property of a DrgAttachment.
A constant which can be used with the lifecycle_state property of a DrgAttachment.
A constant which can be used with the lifecycle_state property of a DrgAttachment.
[Required] Gets the compartment_id of this DrgAttachment.
Gets the defined_tags of this DrgAttachment.
Gets the display_name of this DrgAttachment.
Gets the does_preserve_original_routes_with_nat of this DrgAttachment.
[Required] Gets the drg_id of this DrgAttachment.
Gets the drg_nat_policy_id of this DrgAttachment.
Gets the drg_route_table_id of this DrgAttachment.
Gets the export_drg_route_distribution_id of this DrgAttachment.
Gets the freeform_tags of this DrgAttachment.
[Required] Gets the id of this DrgAttachment.
Gets the is_cross_tenancy of this DrgAttachment.
[Required] Gets the lifecycle_state of this DrgAttachment.
Gets the network_details of this DrgAttachment.
Gets the route_table_id of this DrgAttachment.
Gets the time_created of this DrgAttachment.
Gets the vcn_id of this DrgAttachment.
Methods:
__init__(**kwargs)Initializes a new DrgAttachment object with values from keyword arguments.
- LIFECYCLE_STATE_ATTACHED = 'ATTACHED'¶
A constant which can be used with the lifecycle_state property of a DrgAttachment. This constant has a value of “ATTACHED”
- LIFECYCLE_STATE_ATTACHING = 'ATTACHING'¶
A constant which can be used with the lifecycle_state property of a DrgAttachment. This constant has a value of “ATTACHING”
- LIFECYCLE_STATE_DETACHED = 'DETACHED'¶
A constant which can be used with the lifecycle_state property of a DrgAttachment. This constant has a value of “DETACHED”
- LIFECYCLE_STATE_DETACHING = 'DETACHING'¶
A constant which can be used with the lifecycle_state property of a DrgAttachment. This constant has a value of “DETACHING”
- __init__(**kwargs)¶
Initializes a new DrgAttachment object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this DrgAttachment.
display_name (str) – The value to assign to the display_name property of this DrgAttachment.
drg_id (str) – The value to assign to the drg_id property of this DrgAttachment.
id (str) – The value to assign to the id property of this DrgAttachment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DrgAttachment. Allowed values for this property are: “ATTACHING”, “ATTACHED”, “DETACHING”, “DETACHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this DrgAttachment.
drg_route_table_id (str) – The value to assign to the drg_route_table_id property of this DrgAttachment.
network_details (oci.core.models.DrgAttachmentNetworkDetails) – The value to assign to the network_details property of this DrgAttachment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DrgAttachment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DrgAttachment.
route_table_id (str) – The value to assign to the route_table_id property of this DrgAttachment.
vcn_id (str) – The value to assign to the vcn_id property of this DrgAttachment.
drg_nat_policy_id (str) – The value to assign to the drg_nat_policy_id property of this DrgAttachment.
does_preserve_original_routes_with_nat (bool) – The value to assign to the does_preserve_original_routes_with_nat property of this DrgAttachment.
export_drg_route_distribution_id (str) – The value to assign to the export_drg_route_distribution_id property of this DrgAttachment.
is_cross_tenancy (bool) – The value to assign to the is_cross_tenancy property of this DrgAttachment.
- property compartment_id¶
[Required] Gets the compartment_id of this DrgAttachment. The OCID of the compartment containing the DRG attachment.
- Returns
The compartment_id of this DrgAttachment.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this DrgAttachment. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this DrgAttachment.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this DrgAttachment. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this DrgAttachment.
- Return type
str
- property does_preserve_original_routes_with_nat¶
Gets the does_preserve_original_routes_with_nat of this DrgAttachment. By default, only translated DrgNatRule CIDRs are imported into the DrgRouteTable to prevent routing complications. Enable this option to also preserve original CIDRs. The original source CIDRs is not advertised if this value is set to false, else it is advertised. default: false
- Returns
The does_preserve_original_routes_with_nat of this DrgAttachment.
- Return type
bool
- property drg_id¶
[Required] Gets the drg_id of this DrgAttachment. The OCID of the DRG.
- Returns
The drg_id of this DrgAttachment.
- Return type
str
- property drg_nat_policy_id¶
Gets the drg_nat_policy_id of this DrgAttachment. The OCID of the DRG attachment’s DRG NAT policy.
- Returns
The drg_nat_policy_id of this DrgAttachment.
- Return type
str
- property drg_route_table_id¶
Gets the drg_route_table_id of this DrgAttachment. The OCID of the DRG route table that is assigned to this attachment.
The DRG route table manages traffic inside the DRG.
- Returns
The drg_route_table_id of this DrgAttachment.
- Return type
str
- property export_drg_route_distribution_id¶
Gets the export_drg_route_distribution_id of this DrgAttachment. 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.
- Returns
The export_drg_route_distribution_id of this DrgAttachment.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this DrgAttachment. 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”}
- Returns
The freeform_tags of this DrgAttachment.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DrgAttachment. The DRG attachment’s Oracle ID (OCID).
- Returns
The id of this DrgAttachment.
- Return type
str
- property is_cross_tenancy¶
Gets the is_cross_tenancy of this DrgAttachment. Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG.
Example: false
- Returns
The is_cross_tenancy of this DrgAttachment.
- Return type
bool
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DrgAttachment. The DRG attachment’s current state.
Allowed values for this property are: “ATTACHING”, “ATTACHED”, “DETACHING”, “DETACHED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this DrgAttachment.
- Return type
str
- property network_details¶
Gets the network_details of this DrgAttachment.
- Returns
The network_details of this DrgAttachment.
- Return type
- property route_table_id¶
Gets the route_table_id of this DrgAttachment. The OCID of the route table the DRG attachment is using.
For information about why you would associate a route table with a DRG attachment, see:
This field is deprecated. Instead, use the networkDetails field to view the OCID of the attached resource.
- Returns
The route_table_id of this DrgAttachment.
- Return type
str