TransitRouterPeerAttachment
- Implements: ITransitRouterPeerAttachment
This class encapsulates and extends the ROS resource type ALIYUN::CEN::TransitRouterPeerAttachmentThe , which type creates an inter-region connection for an Enterprise Edition transit router.
Initializers
import ros_cdk_cen
ros_cdk_cen.TransitRouterPeerAttachment(
scope: Construct,
id: str,
peer_transit_router_id: typing.Union[str, IResolvable],
auto_publish_route_enabled: typing.Union[bool, IResolvable] = None,
bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
bandwidth_type: typing.Union[str, IResolvable] = None,
cen_bandwidth_package_id: typing.Union[str, IResolvable] = None,
cen_id: typing.Union[str, IResolvable] = None,
default_link_type: typing.Union[str, IResolvable] = None,
deletion_force: typing.Union[bool, IResolvable] = None,
peer_transit_router_region_id: typing.Union[str, 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,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
peer_transit_router_id | typing.Union[str, ros_cdk_core.IResolvable] | Property peerTransitRouterId: Peer forwarding router instance ID. |
auto_publish_route_enabled | typing.Union[bool, ros_cdk_core.IResolvable] | Property autoPublishRouteEnabled: Whether to make the enterprise version forwarding router automatically publish routes across regions to the peer region. |
bandwidth | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property bandwidth: The bandwidth value for cross-region connections.Unit: Mbps. When the BandwidthType value is BandwidthPackage, this parameter represents the bandwidth value that can be used by cross-region connections. When the BandwidthType value is DataTransfer, this parameter represents the speed limit bandwidth value for cross-region connections. |
bandwidth_type | typing.Union[str, ros_cdk_core.IResolvable] | Property bandwidthType: The bandwidth allocation method for cross-regional connections.Value: BandwidthPackage: Allocate bandwidth from bandwidth packets. DataTransfer: Do not allocate bandwidth for cross-region connections, and is billed based on usage traffic. |
cen_bandwidth_package_id | typing.Union[str, ros_cdk_core.IResolvable] | Property cenBandwidthPackageId: The bandwidth packet ID to bind to across regions. |
cen_id | typing.Union[str, ros_cdk_core.IResolvable] | Property cenId: Cloud Enterprise Network Instance ID. |
default_link_type | typing.Union[str, ros_cdk_core.IResolvable] | Property defaultLinkType: Default link type. |
deletion_force | typing.Union[bool, ros_cdk_core.IResolvable] | Property deletionForce: Whether to force delete the peer attachment. |
peer_transit_router_region_id | typing.Union[str, ros_cdk_core.IResolvable] | Property peerTransitRouterRegionId: The region ID to which the peer forwarding router instance belongs. |
route_table_association_enabled | typing.Union[bool, ros_cdk_core.IResolvable] | Property routeTableAssociationEnabled: Whether to enable the association of route tables. |
route_table_propagation_enabled | typing.Union[bool, ros_cdk_core.IResolvable] | Property routeTablePropagationEnabled: Whether to enable the propagation of route tables. |
tags | typing.List[TagsProperty] | Property tags: The list of tags in the form of key\/value pairs. |
transit_router_attachment_description | typing.Union[str, ros_cdk_core.IResolvable] | Property transitRouterAttachmentDescription: Description information for cross-region connections. |
transit_router_attachment_name | typing.Union[str, ros_cdk_core.IResolvable] | Property transitRouterAttachmentName: The name of the cross-region connection. |
transit_router_id | typing.Union[str, ros_cdk_core.IResolvable] | Property transitRouterId: Local Enterprise Edition forwarding router instance ID. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
peer_transit_router_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property peerTransitRouterId: Peer forwarding router instance ID.
auto_publish_route_enabledOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property autoPublishRouteEnabled: Whether to make the enterprise version forwarding router automatically publish routes across regions to the peer region.
false (default): No. true: Yes.
bandwidthOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property bandwidth: The bandwidth value for cross-region connections.Unit: Mbps. When the BandwidthType value is BandwidthPackage, this parameter represents the bandwidth value that can be used by cross-region connections. When the BandwidthType value is DataTransfer, this parameter represents the speed limit bandwidth value for cross-region connections.
bandwidth_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property bandwidthType: The bandwidth allocation method for cross-regional connections.Value: BandwidthPackage: Allocate bandwidth from bandwidth packets. DataTransfer: Do not allocate bandwidth for cross-region connections, and is billed based on usage traffic.
cen_bandwidth_package_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property cenBandwidthPackageId: The bandwidth packet ID to bind to across regions.
Note When the value of BandwidthType is DataTransfer, this item is not required.
cen_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property cenId: Cloud Enterprise Network Instance ID.
default_link_typeOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property defaultLinkType: Default link type.
Optional values are Platinum, Gold, and default to Gold. And it can only be configured as Platinum (Platinum) when the bandwidth allocation method is billed by traffic.
deletion_forceOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property deletionForce: Whether to force delete the peer attachment.
peer_transit_router_region_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property peerTransitRouterRegionId: The region ID to which the peer forwarding router instance belongs.
route_table_association_enabledOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property routeTableAssociationEnabled: Whether to enable the association of route tables.
route_table_propagation_enabledOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property routeTablePropagationEnabled: Whether to enable the propagation of route tables.
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: The list of tags in the form of key\/value pairs.
You can define a maximum of 20 tags.
transit_router_attachment_descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property transitRouterAttachmentDescription: Description information for cross-region connections.
The description can be empty or has a length of 1 to 256 characters and cannot start with http:// or https://.
transit_router_attachment_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property transitRouterAttachmentName: The name of the cross-region connection.
The name can be empty or has a length of 1 to 128 characters, and cannot start with http:// or https://.
transit_router_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property transitRouterId: Local Enterprise Edition forwarding router instance ID.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- 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.TransitRouterPeerAttachment.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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: Cross-region connection ID. |
props | TransitRouterPeerAttachmentProps | 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: Cross-region connection ID.
propsRequired
props: TransitRouterPeerAttachmentProps