Skip to content

Vpc

This class encapsulates and extends the ROS resource type ALIYUN::ECS::VPC, which is used to create a virtual private cloud (VPC).

Initializers 

import ros_cdk_ecs
ros_cdk_ecs.Vpc(
  scope: Construct,
  id: str,
  cidr_block: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_ipv6: typing.Union[bool, IResolvable] = None,
  ipv6_cidr_block: typing.Union[str, IResolvable] = None,
  ipv6_isp: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  secondary_cidr_blocks: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  tags: typing.List[TagsProperty] = None,
  user_cidr: typing.Union[str, IResolvable] = None,
  vpc_name: 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.
cidr_block typing.Union[str, ros_cdk_core.IResolvable] Property cidrBlock: The IP address range of the VPC in the CIDR block form.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of the vpc, [2, 256] characters.
enable_ipv6 typing.Union[bool, ros_cdk_core.IResolvable] Property enableIpv6: Whether to enable an IPv6 network cidr, the value is:False (default): not turned on.True: On.
ipv6_cidr_block typing.Union[str, ros_cdk_core.IResolvable] Property ipv6CidrBlock: IPv6 network cidr of the VPC.
ipv6_isp typing.Union[str, ros_cdk_core.IResolvable] Property ipv6Isp: The Internet service provider (ISP) for IPv6 addresses of the VPC.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
secondary_cidr_blocks typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property secondaryCidrBlocks: The secondary IPv4 CIDR blocks.
tags typing.List[TagsProperty] Property tags: Tags to attach to vpc.
user_cidr typing.Union[str, ros_cdk_core.IResolvable] Property userCidr: The user CIDR block.
vpc_name typing.Union[str, ros_cdk_core.IResolvable] Property vpcName: Display name of the vpc instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cidr_blockOptional

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

Property cidrBlock: The IP address range of the VPC in the CIDR block form.

You can use the following IP address ranges and their subnets: 10.0.0.0/8 172.16.0.0/12 (Default) 192.168.0.0/16

descriptionOptional

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

Property description: Description of the vpc, [2, 256] characters.

Do not fill or empty, the default is empty.

enable_ipv6Optional

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

Property enableIpv6: Whether to enable an IPv6 network cidr, the value is:False (default): not turned on.True: On.

ipv6_cidr_blockOptional

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

Property ipv6CidrBlock: IPv6 network cidr of the VPC.

ipv6_ispOptional

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

Property ipv6Isp: The Internet service provider (ISP) for IPv6 addresses of the VPC.

Valid values: BGP(default): Alibaba Cloud BGP IPv6 ChinaMobile: China Mobile (single line) ChinaUnicom: China Unicom (single line) ChinaTelecom: China Telecom (single line) Note If your Alibaba Cloud account is allowed to activate single-ISP bandwidth, you can set the parameter to ChinaTelecom, ChinaUnicom, and ChinaMobile.

resource_group_idOptional

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

Property resourceGroupId: Resource group id.

secondary_cidr_blocksOptional

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

Property secondaryCidrBlocks: The secondary IPv4 CIDR blocks.

tagsOptional

Property tags: Tags to attach to vpc.

Max support 20 tags to add during create vpc. Each tag with two properties Key and Value, and Key is required.

user_cidrOptional

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

Property userCidr: The user CIDR block.

Separate multiple CIDR blocks with commas (,). At most three CIDR blocks are supported.

vpc_nameOptional

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

Property vpcName: Display name of the vpc instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.

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.
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

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_ecs
ros_cdk_ecs.Vpc.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.
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_route_table_id ros_cdk_core.IResolvable Attribute RouteTableId: The router table id of created VPC.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: Id of created VPC.
attr_vpc_name ros_cdk_core.IResolvable Attribute VpcName: The name of VPC.
attr_v_router_id ros_cdk_core.IResolvable Attribute VRouterId: Router id of created VPC.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_route_table_idRequired 

attr_route_table_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RouteTableId: The router table id of created VPC.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: Id of created VPC.

attr_vpc_nameRequired 

attr_vpc_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcName: The name of VPC.

attr_v_router_idRequired 

attr_v_router_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VRouterId: Router id of created VPC.