Skip to content

VSwitch

  • Implements: ros_cdk_vpc.datasource.IVSwitch

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::VSwitch.

Initializers

from ros_cdk_vpc import datasource
datasource.VSwitch(
  scope: Construct,
  id: str,
  v_switch_id: typing.Union[str, IResolvable],
  refresh_options: 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.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The ID of the VSwitch.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

v_switch_idRequired

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

Property vSwitchId: The ID of the VSwitch.


refresh_optionsOptional

  • 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_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

from ros_cdk_vpc import datasource
datasource.VSwitch.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_available_ip_address_count typing.Union[str, ros_cdk_core.IResolvable] Attribute AvailableIpAddressCount: The number of available IP addresses.
attr_cidr_block typing.Union[str, ros_cdk_core.IResolvable] Attribute CidrBlock: The IPv4 CIDR block of the VSwitch.
attr_create_time typing.Union[str, ros_cdk_core.IResolvable] Attribute CreateTime: The creation time of the VSwitch.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: The description of VSwitch.
attr_ipv6_cidr_block typing.Union[str, ros_cdk_core.IResolvable] Attribute Ipv6CidrBlock: The IPv6 CIDR block of the VSwitch.
attr_is_default typing.Union[str, ros_cdk_core.IResolvable] Attribute IsDefault: Indicates whether the VSwitch is a default VSwitch.
attr_resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceGroupId: The resource group id of VSwitch.
attr_route_table_id typing.Union[str, ros_cdk_core.IResolvable] Attribute RouteTableId: The route table id.
attr_tags typing.Union[str, ros_cdk_core.IResolvable] Attribute Tags: The tags of VSwitch.
attr_vpc_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VpcId: The VPC ID.
attr_v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VSwitchId: The ID of the VSwitch.
attr_v_switch_name typing.Union[str, ros_cdk_core.IResolvable] Attribute VSwitchName: The name of the VSwitch.
attr_zone_id typing.Union[str, ros_cdk_core.IResolvable] Attribute ZoneId: The zone ID of the resource.
props VSwitchProps 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_available_ip_address_countRequired

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

Attribute AvailableIpAddressCount: The number of available IP addresses.


attr_cidr_blockRequired

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

Attribute CidrBlock: The IPv4 CIDR block of the VSwitch.


attr_create_timeRequired

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

Attribute CreateTime: The creation time of the VSwitch.


attr_descriptionRequired

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

Attribute Description: The description of VSwitch.


attr_ipv6_cidr_blockRequired

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

Attribute Ipv6CidrBlock: The IPv6 CIDR block of the VSwitch.


attr_is_defaultRequired

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

Attribute IsDefault: Indicates whether the VSwitch is a default VSwitch.


attr_resource_group_idRequired

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

Attribute ResourceGroupId: The resource group id of VSwitch.


attr_route_table_idRequired

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

Attribute RouteTableId: The route table id.


attr_tagsRequired

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

Attribute Tags: The tags of VSwitch.


attr_vpc_idRequired

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

Attribute VpcId: The VPC ID.


attr_v_switch_idRequired

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

Attribute VSwitchId: The ID of the VSwitch.


attr_v_switch_nameRequired

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

Attribute VSwitchName: The name of the VSwitch.


attr_zone_idRequired

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

Attribute ZoneId: The zone ID of the resource.


propsRequired

props: VSwitchProps