Skip to content

TransitRouterCidr

This class encapsulates and extends the ROS resource type ALIYUN::CEN::TransitRouterCidr.

Initializers

import ros_cdk_cen
ros_cdk_cen.TransitRouterCidr(
  scope: Construct,
  id: str,
  cidr: typing.Union[str, IResolvable],
  transit_router_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  publish_cidr_route: typing.Union[bool, IResolvable] = None,
  transit_router_cidr_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 typing.Union[str, ros_cdk_core.IResolvable] Property cidr: The CIDR block of the transit router.
transit_router_id typing.Union[str, ros_cdk_core.IResolvable] Property transitRouterId: The ID of the transit router.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The new description of the transit router CIDR block.
publish_cidr_route typing.Union[bool, ros_cdk_core.IResolvable] Property publishCidrRoute: Specifies whether to allow the system to automatically add a route that points to the CIDR block to the route table of the transit router.
transit_router_cidr_name typing.Union[str, ros_cdk_core.IResolvable] Property transitRouterCidrName: The new name of the transit router CIDR block.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cidrRequired

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

Property cidr: The CIDR block of the transit router.


transit_router_idRequired

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

Property transitRouterId: The ID of the transit router.


descriptionOptional

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

Property description: The new description of the transit router CIDR block.

The description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.


publish_cidr_routeOptional

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

Property publishCidrRoute: Specifies whether to allow the system to automatically add a route that points to the CIDR block to the route table of the transit router.

  • true (default) If you set the value to true, after you create a VPN attachment on a private VPN gateway and enable route learning for the VPN attachment, the system automatically adds the following route to the route table of the transit router that is in route learning relationship with the VPN attachment: A blackhole route whose destination CIDR block is the transit router CIDR block, which refers to the CIDR block from which gateway IP addresses are allocated to the IPsec-VPN connection. The blackhole route is advertised only to the route tables of virtual border routers (VBRs) connected to the transit router.
  • false.

transit_router_cidr_nameOptional

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

Property transitRouterCidrName: The new name of the transit router CIDR block.

The name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.


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_cen
ros_cdk_cen.TransitRouterCidr.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_cidr typing.Union[str, ros_cdk_core.IResolvable] Attribute Cidr: The CIDR block of the transit router.
attr_description typing.Union[str, ros_cdk_core.IResolvable] Attribute Description: The new description of the transit router CIDR block.
attr_family typing.Union[str, ros_cdk_core.IResolvable] Attribute Family: The type of the CIDR block.
attr_publish_cidr_route typing.Union[str, ros_cdk_core.IResolvable] Attribute PublishCidrRoute: Specifies whether to allow the system to automatically add a route that points to the CIDR block to the route table of the transit router.
attr_transit_router_cidr_id typing.Union[str, ros_cdk_core.IResolvable] Attribute TransitRouterCidrId: The ID of the CIDR block.
attr_transit_router_cidr_name typing.Union[str, ros_cdk_core.IResolvable] Attribute TransitRouterCidrName: The new name of the transit router CIDR block.
attr_transit_router_id typing.Union[str, ros_cdk_core.IResolvable] Attribute TransitRouterId: The ID of the transit router.
props TransitRouterCidrProps 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_cidrRequired

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

Attribute Cidr: The CIDR block of the transit router.


attr_descriptionRequired

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

Attribute Description: The new description of the transit router CIDR block.


attr_familyRequired

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

Attribute Family: The type of the CIDR block.


attr_publish_cidr_routeRequired

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

Attribute PublishCidrRoute: Specifies whether to allow the system to automatically add a route that points to the CIDR block to the route table of the transit router.


attr_transit_router_cidr_idRequired

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

Attribute TransitRouterCidrId: The ID of the CIDR block.


attr_transit_router_cidr_nameRequired

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

Attribute TransitRouterCidrName: The new name of the transit router CIDR block.


attr_transit_router_idRequired

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

Attribute TransitRouterId: The ID of the transit router.


propsRequired

props: TransitRouterCidrProps