Vpc

• Implements: ros_cdk_vpc.datasource.IVpc

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::Vpc, which is used to query the information about a virtual private cloud (VPC).

Initializers

from ros_cdk_vpc import datasource
datasource.Vpc(
  scope: Construct,
  id: str,
  vpc_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

vpc_id^Required

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

Property vpcId: The ID of the VPC.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

from ros_cdk_vpc import datasource
datasource.Vpc.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_cidr_block^Required

attr_cidr_block: typing.Union[str, IResolvable]

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

Attribute CidrBlock: The IPv4 CIDR block of the VPC.

attr_classic_link_enabled^Required

attr_classic_link_enabled: typing.Union[str, IResolvable]

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

Attribute ClassicLinkEnabled: status of vpc ClassicLink..

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The time at which the VPC was created.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the VPC.

attr_dhcp_options_set_id^Required

attr_dhcp_options_set_id: typing.Union[str, IResolvable]

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

Attribute DhcpOptionsSetId: The ID of the DHCP option set.

attr_ipv6_cidr_block^Required

attr_ipv6_cidr_block: typing.Union[str, IResolvable]

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

Attribute Ipv6CidrBlock: The ipv6 cidr block of vpc.

attr_ipv6_cidr_blocks^Required

attr_ipv6_cidr_blocks: typing.Union[str, IResolvable]

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

Attribute Ipv6CidrBlocks: The IPv6 network segment of the VPC.

attr_is_default^Required

attr_is_default: typing.Union[str, IResolvable]

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

Attribute IsDefault: Indicates whether to query the default VPC in the specified region.

Valid values:

• true (default): All VPCs in the specified region are queried.
• false: The default VPC is not queried.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group to which the VPC belongs.

attr_router_id^Required

attr_router_id: typing.Union[str, IResolvable]

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

Attribute RouterId: The ID of the VRouter.

attr_secondary_cidr_blocks^Required

attr_secondary_cidr_blocks: typing.Union[str, IResolvable]

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

Attribute SecondaryCidrBlocks: Additional network segment information.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: The tags of Vpc.

attr_user_cidrs^Required

attr_user_cidrs: typing.Union[str, IResolvable]

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

Attribute UserCidrs: A list of user CIDRs.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The ID of the VPC.

attr_vpc_name^Required

attr_vpc_name: typing.Union[str, IResolvable]

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

Attribute VpcName: The name of the VPC.

attr_v_switch_ids^Required

attr_v_switch_ids: typing.Union[str, IResolvable]

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

Attribute VSwitchIds: A list of VSwitches in the VPC.

props^Required

props: VpcProps

• Type: VpcProps