CreateVirtualCircuitDetails¶

class oci.core.models.CreateVirtualCircuitDetails(**kwargs)¶

Bases: object

CreateVirtualCircuitDetails model.

Attributes

`ROUTING_POLICY_GLOBAL`	A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails.
`ROUTING_POLICY_MARKET_LEVEL`	A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails.
`ROUTING_POLICY_ORACLE_SERVICE_NETWORK`	A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails.
`ROUTING_POLICY_REGIONAL`	A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails.
`TYPE_PRIVATE`	A constant which can be used with the type property of a CreateVirtualCircuitDetails.
`TYPE_PUBLIC`	A constant which can be used with the type property of a CreateVirtualCircuitDetails.
`bandwidth_shape_name`	Gets the bandwidth_shape_name of this CreateVirtualCircuitDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateVirtualCircuitDetails.
`cross_connect_mappings`	Gets the cross_connect_mappings of this CreateVirtualCircuitDetails.
`customer_asn`	Gets the customer_asn of this CreateVirtualCircuitDetails.
`customer_bgp_asn`	Gets the customer_bgp_asn of this CreateVirtualCircuitDetails.
`defined_tags`	Gets the defined_tags of this CreateVirtualCircuitDetails.
`display_name`	Gets the display_name of this CreateVirtualCircuitDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVirtualCircuitDetails.
`gateway_id`	Gets the gateway_id of this CreateVirtualCircuitDetails.
`provider_name`	Gets the provider_name of this CreateVirtualCircuitDetails.
`provider_service_id`	Gets the provider_service_id of this CreateVirtualCircuitDetails.
`provider_service_key_name`	Gets the provider_service_key_name of this CreateVirtualCircuitDetails.
`provider_service_name`	Gets the provider_service_name of this CreateVirtualCircuitDetails.
`public_prefixes`	Gets the public_prefixes of this CreateVirtualCircuitDetails.
`region`	Gets the region of this CreateVirtualCircuitDetails.
`routing_policy`	Gets the routing_policy of this CreateVirtualCircuitDetails.
`type`	[Required] Gets the type of this CreateVirtualCircuitDetails.

Methods

__init__(**kwargs) Initializes a new CreateVirtualCircuitDetails object with values from keyword arguments.

ROUTING_POLICY_GLOBAL = 'GLOBAL'¶: A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails. This constant has a value of “GLOBAL”

ROUTING_POLICY_MARKET_LEVEL = 'MARKET_LEVEL'¶: A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails. This constant has a value of “MARKET_LEVEL”

ROUTING_POLICY_ORACLE_SERVICE_NETWORK = 'ORACLE_SERVICE_NETWORK'¶: A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails. This constant has a value of “ORACLE_SERVICE_NETWORK”

ROUTING_POLICY_REGIONAL = 'REGIONAL'¶: A constant which can be used with the routing_policy property of a CreateVirtualCircuitDetails. This constant has a value of “REGIONAL”

TYPE_PRIVATE = 'PRIVATE'¶: A constant which can be used with the type property of a CreateVirtualCircuitDetails. This constant has a value of “PRIVATE”

TYPE_PUBLIC = 'PUBLIC'¶: A constant which can be used with the type property of a CreateVirtualCircuitDetails. This constant has a value of “PUBLIC”

__init__(**kwargs)¶

Initializes a new CreateVirtualCircuitDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

bandwidth_shape_name (str) – The value to assign to the bandwidth_shape_name property of this CreateVirtualCircuitDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateVirtualCircuitDetails.
cross_connect_mappings (list[oci.core.models.CrossConnectMapping]) – The value to assign to the cross_connect_mappings property of this CreateVirtualCircuitDetails.
routing_policy (list[str]) – The value to assign to the routing_policy property of this CreateVirtualCircuitDetails. Allowed values for items in this list are: “ORACLE_SERVICE_NETWORK”, “REGIONAL”, “MARKET_LEVEL”, “GLOBAL”
customer_bgp_asn (int) – The value to assign to the customer_bgp_asn property of this CreateVirtualCircuitDetails.
customer_asn (int) – The value to assign to the customer_asn property of this CreateVirtualCircuitDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateVirtualCircuitDetails.
display_name (str) – The value to assign to the display_name property of this CreateVirtualCircuitDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateVirtualCircuitDetails.
gateway_id (str) – The value to assign to the gateway_id property of this CreateVirtualCircuitDetails.
provider_name (str) – The value to assign to the provider_name property of this CreateVirtualCircuitDetails.
provider_service_id (str) – The value to assign to the provider_service_id property of this CreateVirtualCircuitDetails.
provider_service_key_name (str) – The value to assign to the provider_service_key_name property of this CreateVirtualCircuitDetails.
provider_service_name (str) – The value to assign to the provider_service_name property of this CreateVirtualCircuitDetails.
public_prefixes (list[oci.core.models.CreateVirtualCircuitPublicPrefixDetails]) – The value to assign to the public_prefixes property of this CreateVirtualCircuitDetails.
region (str) – The value to assign to the region property of this CreateVirtualCircuitDetails.
type (str) – The value to assign to the type property of this CreateVirtualCircuitDetails. Allowed values for this property are: “PUBLIC”, “PRIVATE”

bandwidth_shape_name¶

Gets the bandwidth_shape_name of this CreateVirtualCircuitDetails. The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see list_fast_connect_provider_virtual_circuit_bandwidth_shapes().

Example: 10 Gbps

Returns:	The bandwidth_shape_name of this CreateVirtualCircuitDetails.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CreateVirtualCircuitDetails. The OCID of the compartment to contain the virtual circuit.

Returns:	The compartment_id of this CreateVirtualCircuitDetails.
Return type:	str

cross_connect_mappings¶

Gets the cross_connect_mappings of this CreateVirtualCircuitDetails. Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

Returns:	The cross_connect_mappings of this CreateVirtualCircuitDetails.
Return type:	list[oci.core.models.CrossConnectMapping]

customer_asn¶

Gets the customer_asn of this CreateVirtualCircuitDetails. Your BGP ASN (either public or private). Provide this value only if there’s a BGP session that goes from your edge router to Oracle. Otherwise, leave this empty or null. Can be a 2-byte or 4-byte ASN. Uses “asplain” format.

Example: 12345 (2-byte) or 1587232876 (4-byte)

Returns:	The customer_asn of this CreateVirtualCircuitDetails.
Return type:	int

customer_bgp_asn¶

Gets the customer_bgp_asn of this CreateVirtualCircuitDetails. Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.

Returns:	The customer_bgp_asn of this CreateVirtualCircuitDetails.
Return type:	int

defined_tags¶

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

display_name¶

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

Returns:	The display_name of this CreateVirtualCircuitDetails.
Return type:	str

freeform_tags¶

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

gateway_id¶

Gets the gateway_id of this CreateVirtualCircuitDetails. For private virtual circuits only. The OCID of the Drg that this virtual circuit uses.

Returns:	The gateway_id of this CreateVirtualCircuitDetails.
Return type:	str

provider_name¶

Gets the provider_name of this CreateVirtualCircuitDetails. Deprecated. Instead use providerServiceId. To get a list of the provider names, see list_fast_connect_provider_services().

Returns:	The provider_name of this CreateVirtualCircuitDetails.
Return type:	str

provider_service_id¶

Gets the provider_service_id of this CreateVirtualCircuitDetails. The OCID of the service offered by the provider (if you’re connecting via a provider). To get a list of the available service offerings, see list_fast_connect_provider_services().

Returns:	The provider_service_id of this CreateVirtualCircuitDetails.
Return type:	str

provider_service_key_name¶

Gets the provider_service_key_name of this CreateVirtualCircuitDetails. The service key name offered by the provider (if the customer is connecting via a provider).

Returns:	The provider_service_key_name of this CreateVirtualCircuitDetails.
Return type:	str

provider_service_name¶

Gets the provider_service_name of this CreateVirtualCircuitDetails. Deprecated. Instead use providerServiceId. To get a list of the provider names, see list_fast_connect_provider_services().

Returns:	The provider_service_name of this CreateVirtualCircuitDetails.
Return type:	str

public_prefixes¶

Gets the public_prefixes of this CreateVirtualCircuitDetails. For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

Returns:	The public_prefixes of this CreateVirtualCircuitDetails.
Return type:	list[oci.core.models.CreateVirtualCircuitPublicPrefixDetails]

region¶

Gets the region of this CreateVirtualCircuitDetails. The Oracle Cloud Infrastructure region where this virtual circuit is located. Example: phx

Returns:	The region of this CreateVirtualCircuitDetails.
Return type:	str

routing_policy¶

Gets the routing_policy of this CreateVirtualCircuitDetails. The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: ORACLE_SERVICE_NETWORK, REGIONAL, MARKET_LEVEL, and GLOBAL. See Route Filtering for details. By default, routing information is shared for all routes in the same market.

Allowed values for items in this list are: “ORACLE_SERVICE_NETWORK”, “REGIONAL”, “MARKET_LEVEL”, “GLOBAL”

Returns:	The routing_policy of this CreateVirtualCircuitDetails.
Return type:	list[str]

type¶

[Required] Gets the type of this CreateVirtualCircuitDetails. The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

Allowed values for this property are: “PUBLIC”, “PRIVATE”

Returns:	The type of this CreateVirtualCircuitDetails.
Return type:	str