Skip to content

TransitRouterVpnAttachment

This class encapsulates and extends the ROS resource type ALIYUN::CEN::TransitRouterVpnAttachment, which is used to create a VPN connection.

Initializers

import ros_cdk_cen
ros_cdk_cen.TransitRouterVpnAttachment(
  scope: Construct,
  id: str,
  vpn_id: typing.Union[str, IResolvable],
  auto_publish_route_enabled: typing.Union[bool, IResolvable] = None,
  cen_id: typing.Union[str, IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  route_table_association_enabled: typing.Union[bool, IResolvable] = None,
  route_table_propagation_enabled: typing.Union[bool, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  transit_router_attachment_description: typing.Union[str, IResolvable] = None,
  transit_router_attachment_name: typing.Union[str, IResolvable] = None,
  transit_router_id: typing.Union[str, IResolvable] = None,
  vpn_owner_id: typing.Union[str, IResolvable] = None,
  zone_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.
vpn_id typing.Union[str, ros_cdk_core.IResolvable] Property vpnId: IPsec connection ID.
auto_publish_route_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property autoPublishRouteEnabled: Whether to allow forwarding router instances to automatically publish route entries to IPsec connections.
cen_id typing.Union[str, ros_cdk_core.IResolvable] Property cenId: The ID of the CEN instance.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Whether to forcefully delete the VPN connection.
route_table_association_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property routeTableAssociationEnabled: Whether to enable route association and forwarding relationship.
route_table_propagation_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property routeTablePropagationEnabled: Whether to enable route learning relationships.
tags typing.List[TagsProperty] Property tags: Tags to attach to TransitRouterVpnAttachment.
transit_router_attachment_description typing.Union[str, ros_cdk_core.IResolvable] Property transitRouterAttachmentDescription: Description of the VPN connection.
transit_router_attachment_name typing.Union[str, ros_cdk_core.IResolvable] Property transitRouterAttachmentName: The name of the VPN connection.
transit_router_id typing.Union[str, ros_cdk_core.IResolvable] Property transitRouterId: Forwarding router instance ID.
vpn_owner_id typing.Union[str, ros_cdk_core.IResolvable] Property vpnOwnerId: Alibaba Cloud account (main account) ID to which the IPsec connection belongs.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: Availability zone ID in the current region.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

vpn_idRequired

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

Property vpnId: IPsec connection ID.


auto_publish_route_enabledOptional

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

Property autoPublishRouteEnabled: Whether to allow forwarding router instances to automatically publish route entries to IPsec connections.

Default is true.


cen_idOptional

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

Property cenId: The ID of the CEN instance.


deletion_forceOptional

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

Property deletionForce: Whether to forcefully delete the VPN connection.


route_table_association_enabledOptional

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

Property routeTableAssociationEnabled: Whether to enable route association and forwarding relationship.


route_table_propagation_enabledOptional

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

Property routeTablePropagationEnabled: Whether to enable route learning relationships.


tagsOptional

Property tags: Tags to attach to TransitRouterVpnAttachment.

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


transit_router_attachment_descriptionOptional

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

Property transitRouterAttachmentDescription: Description of the VPN connection.


transit_router_attachment_nameOptional

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

Property transitRouterAttachmentName: The name of the VPN connection.


transit_router_idOptional

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

Property transitRouterId: Forwarding router instance ID.


vpn_owner_idOptional

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

Property vpnOwnerId: Alibaba Cloud account (main account) ID to which the IPsec connection belongs.


zone_idOptional

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

Property zoneId: Availability zone ID in the current region.


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.TransitRouterVpnAttachment.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_transit_router_attachment_id typing.Union[str, ros_cdk_core.IResolvable] Attribute TransitRouterAttachmentId: The ID of the VPN connection.
props TransitRouterVpnAttachmentProps 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_transit_router_attachment_idRequired

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

Attribute TransitRouterAttachmentId: The ID of the VPN connection.


propsRequired

props: TransitRouterVpnAttachmentProps

Structs