CreateVirtualCircuitDetails¶

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

Bases: object

CreateVirtualCircuitDetails model.

Attributes:

`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_bgp_asn`	Gets the customer_bgp_asn of this CreateVirtualCircuitDetails.
`display_name`	Gets the display_name of this CreateVirtualCircuitDetails.
`gateway_id`	Gets the gateway_id of this CreateVirtualCircuitDetails.
`is_transport_mode`	Gets the is_transport_mode 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_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.
`type`	[Required] Gets the type of this CreateVirtualCircuitDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateVirtualCircuitDetails object with values from keyword arguments.

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.vn_monitoring.models.CrossConnectMapping]) – The value to assign to the cross_connect_mappings property of this CreateVirtualCircuitDetails.
is_transport_mode (bool) – The value to assign to the is_transport_mode property of this CreateVirtualCircuitDetails.
customer_bgp_asn (int) – The value to assign to the customer_bgp_asn property of this CreateVirtualCircuitDetails.
display_name (str) – The value to assign to the display_name 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_name (str) – The value to assign to the provider_service_name property of this CreateVirtualCircuitDetails.
public_prefixes (list[oci.vn_monitoring.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”

property 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

property 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

property 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.vn_monitoring.models.CrossConnectMapping]

property customer_bgp_asn¶

Gets the customer_bgp_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.

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

property 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

property 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

property is_transport_mode¶

Gets the is_transport_mode of this CreateVirtualCircuitDetails. Set to true for the virtual circuit to carry only encrypted traffic, or set to false for the virtual circuit to carry unencrypted traffic. If this is not set, the default is false.

Returns: The is_transport_mode of this CreateVirtualCircuitDetails.
Return type: bool

property 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

property 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

property 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

property 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.vn_monitoring.models.CreateVirtualCircuitPublicPrefixDetails]

property 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

property 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