Skip to content

VpcPeerConnection

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpcPeerConnection.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.VpcPeerConnection(
  scope: Construct,
  id: str,
  accepting_vpc_id: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  accepting_ali_uid: typing.Union[typing.Union[int, float], IResolvable] = None,
  accepting_region_id: typing.Union[str, IResolvable] = None,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  link_type: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
accepting_vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property acceptingVpcId: The ID of the acceptor VPC.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the requester VPC.
accepting_ali_uid typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property acceptingAliUid: The ID of the Alibaba Cloud account to which the acceptor VPC belongs.
accepting_region_id typing.Union[str, ros_cdk_core.IResolvable] Property acceptingRegionId: The region ID of the acceptor VPC of the VPC peering connection that you want to create.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: The bandwidth of the VPC peering connection.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Specifies whether to forcefully delete the VPC peering connection.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the VPC peering connection.
link_type typing.Union[str, ros_cdk_core.IResolvable] Property linkType: The link type.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the VPC peering connection.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

accepting_vpc_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property acceptingVpcId: The ID of the acceptor VPC.


vpc_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vpcId: The ID of the requester VPC.


accepting_ali_uidOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property acceptingAliUid: The ID of the Alibaba Cloud account to which the acceptor VPC belongs.

To create a VPC peering connection within your Alibaba Cloud account, enter the ID of your Alibaba Cloud account. To create a VPC peering connection between your Alibaba Cloud account and another Alibaba Cloud account, enter the ID of the peer Alibaba Cloud account. Note If the acceptor VPC belongs to a Resource Access Management (RAM) user, you must set the value of AcceptingAliUid to the ID of the corresponding Alibaba Cloud account. Default current account ID.


accepting_region_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property acceptingRegionId: The region ID of the acceptor VPC of the VPC peering connection that you want to create.

To create an intra-region VPC peering connection, enter a region ID that is the same as that of the requester VPC. To create an inter-region VPC peering connection, enter a region ID that is different from that of the requester VPC. Default current region.


bandwidthOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property bandwidth: The bandwidth of the VPC peering connection.

If you specify this parameter, make sure that you are creating an inter-region VPC peering connection.


deletion_forceOptional

  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionForce: Specifies whether to forcefully delete the VPC peering connection.

Valid values:false (default): notrue: yes If you forcefully delete the VPC peering connection, the system deletes the routes that point to the VPC peering connection from the VPC route table.


descriptionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the VPC peering connection.

The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.


  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property linkType: The link type.

Valid values: Platinum, Gold. If you specify this parameter, make sure that you are creating an inter-region VPC peering connection.


nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the VPC peering connection.

The name must be 2 to 128 characters in length and can contain digits, underscores (_), and hyphens (-). It must start with a letter.


resource_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

For more information about resource groups, see What is Resource Group.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

import ros_cdk_vpc
ros_cdk_vpc.VpcPeerConnection.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_instance_id typing.Union[str, ros_cdk_core.IResolvable] Attribute InstanceId: The ID of the VPC peering connection.
props VpcPeerConnectionProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_instance_idRequired

attr_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceId: The ID of the VPC peering connection.


propsRequired

props: VpcPeerConnectionProps