RemotePeeringConnection

class oci.core.models.RemotePeeringConnection(**kwargs)

Bases: object

A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached to the DRG peer with a VCN in a different region. Peering means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

LIFECYCLE_STATE_AVAILABLE A constant which can be used with the lifecycle_state property of a RemotePeeringConnection.
LIFECYCLE_STATE_PROVISIONING A constant which can be used with the lifecycle_state property of a RemotePeeringConnection.
LIFECYCLE_STATE_TERMINATED A constant which can be used with the lifecycle_state property of a RemotePeeringConnection.
LIFECYCLE_STATE_TERMINATING A constant which can be used with the lifecycle_state property of a RemotePeeringConnection.
PEERING_STATUS_INVALID A constant which can be used with the peering_status property of a RemotePeeringConnection.
PEERING_STATUS_NEW A constant which can be used with the peering_status property of a RemotePeeringConnection.
PEERING_STATUS_PEERED A constant which can be used with the peering_status property of a RemotePeeringConnection.
PEERING_STATUS_PENDING A constant which can be used with the peering_status property of a RemotePeeringConnection.
PEERING_STATUS_REVOKED A constant which can be used with the peering_status property of a RemotePeeringConnection.
compartment_id [Required] Gets the compartment_id of this RemotePeeringConnection.
defined_tags Gets the defined_tags of this RemotePeeringConnection.
display_name [Required] Gets the display_name of this RemotePeeringConnection.
drg_id [Required] Gets the drg_id of this RemotePeeringConnection.
freeform_tags Gets the freeform_tags of this RemotePeeringConnection.
id [Required] Gets the id of this RemotePeeringConnection.
is_cross_tenancy_peering [Required] Gets the is_cross_tenancy_peering of this RemotePeeringConnection.
lifecycle_state [Required] Gets the lifecycle_state of this RemotePeeringConnection.
peer_id Gets the peer_id of this RemotePeeringConnection.
peer_region_name Gets the peer_region_name of this RemotePeeringConnection.
peer_tenancy_id Gets the peer_tenancy_id of this RemotePeeringConnection.
peering_status [Required] Gets the peering_status of this RemotePeeringConnection.
time_created [Required] Gets the time_created of this RemotePeeringConnection.

Methods

__init__(**kwargs) Initializes a new RemotePeeringConnection object with values from keyword arguments.
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a RemotePeeringConnection. This constant has a value of “TERMINATING”

PEERING_STATUS_INVALID = 'INVALID'

A constant which can be used with the peering_status property of a RemotePeeringConnection. This constant has a value of “INVALID”

PEERING_STATUS_NEW = 'NEW'

A constant which can be used with the peering_status property of a RemotePeeringConnection. This constant has a value of “NEW”

PEERING_STATUS_PEERED = 'PEERED'

A constant which can be used with the peering_status property of a RemotePeeringConnection. This constant has a value of “PEERED”

PEERING_STATUS_PENDING = 'PENDING'

A constant which can be used with the peering_status property of a RemotePeeringConnection. This constant has a value of “PENDING”

PEERING_STATUS_REVOKED = 'REVOKED'

A constant which can be used with the peering_status property of a RemotePeeringConnection. This constant has a value of “REVOKED”

__init__(**kwargs)

Initializes a new RemotePeeringConnection 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 RemotePeeringConnection.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RemotePeeringConnection.
  • display_name (str) – The value to assign to the display_name property of this RemotePeeringConnection.
  • drg_id (str) – The value to assign to the drg_id property of this RemotePeeringConnection.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RemotePeeringConnection.
  • id (str) – The value to assign to the id property of this RemotePeeringConnection.
  • is_cross_tenancy_peering (bool) – The value to assign to the is_cross_tenancy_peering property of this RemotePeeringConnection.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this RemotePeeringConnection. Allowed values for this property are: “AVAILABLE”, “PROVISIONING”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • peer_id (str) – The value to assign to the peer_id property of this RemotePeeringConnection.
  • peer_region_name (str) – The value to assign to the peer_region_name property of this RemotePeeringConnection.
  • peer_tenancy_id (str) – The value to assign to the peer_tenancy_id property of this RemotePeeringConnection.
  • peering_status (str) – The value to assign to the peering_status property of this RemotePeeringConnection. Allowed values for this property are: “INVALID”, “NEW”, “PENDING”, “PEERED”, “REVOKED”, ‘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 RemotePeeringConnection.
compartment_id

[Required] Gets the compartment_id of this RemotePeeringConnection. The OCID of the compartment that contains the RPC.

Returns:The compartment_id of this RemotePeeringConnection.
Return type:str
defined_tags

Gets the defined_tags of this RemotePeeringConnection. 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 RemotePeeringConnection.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this RemotePeeringConnection. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this RemotePeeringConnection.
Return type:str
drg_id

[Required] Gets the drg_id of this RemotePeeringConnection. The OCID of the DRG that this RPC belongs to.

Returns:The drg_id of this RemotePeeringConnection.
Return type:str
freeform_tags

Gets the freeform_tags of this RemotePeeringConnection. 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 RemotePeeringConnection.
Return type:dict(str, str)
id

[Required] Gets the id of this RemotePeeringConnection. The OCID of the RPC.

Returns:The id of this RemotePeeringConnection.
Return type:str
is_cross_tenancy_peering

[Required] Gets the is_cross_tenancy_peering of this RemotePeeringConnection. Whether the VCN at the other end of the peering is in a different tenancy.

Example: false

Returns:The is_cross_tenancy_peering of this RemotePeeringConnection.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this RemotePeeringConnection. The RPC’s current lifecycle state.

Allowed values for this property are: “AVAILABLE”, “PROVISIONING”, “TERMINATING”, “TERMINATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this RemotePeeringConnection.
Return type:str
peer_id

Gets the peer_id of this RemotePeeringConnection. If this RPC is peered, this value is the OCID of the other RPC.

Returns:The peer_id of this RemotePeeringConnection.
Return type:str
peer_region_name

Gets the peer_region_name of this RemotePeeringConnection. If this RPC is peered, this value is the region that contains the other RPC.

Example: us-ashburn-1

Returns:The peer_region_name of this RemotePeeringConnection.
Return type:str
peer_tenancy_id

Gets the peer_tenancy_id of this RemotePeeringConnection. If this RPC is peered, this value is the OCID of the other RPC’s tenancy.

Returns:The peer_tenancy_id of this RemotePeeringConnection.
Return type:str
peering_status

[Required] Gets the peering_status of this RemotePeeringConnection. Whether the RPC is peered with another RPC. NEW means the RPC has not yet been peered. PENDING means the peering is being established. REVOKED means the RPC at the other end of the peering has been deleted.

Allowed values for this property are: “INVALID”, “NEW”, “PENDING”, “PEERED”, “REVOKED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The peering_status of this RemotePeeringConnection.
Return type:str
time_created

[Required] Gets the time_created of this RemotePeeringConnection. The date and time the RPC was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:The time_created of this RemotePeeringConnection.
Return type:datetime