Skip to content

TransitRouterPeerAttachment

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

Initializers

import com.aliyun.ros.cdk.cen.TransitRouterPeerAttachment;
TransitRouterPeerAttachment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .peerTransitRouterId(java.lang.String)
    .peerTransitRouterId(IResolvable)
//  .autoPublishRouteEnabled(java.lang.Boolean)
//  .autoPublishRouteEnabled(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .bandwidthType(java.lang.String)
//  .bandwidthType(IResolvable)
//  .cenBandwidthPackageId(java.lang.String)
//  .cenBandwidthPackageId(IResolvable)
//  .cenId(java.lang.String)
//  .cenId(IResolvable)
//  .defaultLinkType(java.lang.String)
//  .defaultLinkType(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .peerTransitRouterRegionId(java.lang.String)
//  .peerTransitRouterRegionId(IResolvable)
//  .routeTableAssociationEnabled(java.lang.Boolean)
//  .routeTableAssociationEnabled(IResolvable)
//  .routeTablePropagationEnabled(java.lang.Boolean)
//  .routeTablePropagationEnabled(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .transitRouterAttachmentDescription(java.lang.String)
//  .transitRouterAttachmentDescription(IResolvable)
//  .transitRouterAttachmentName(java.lang.String)
//  .transitRouterAttachmentName(IResolvable)
//  .transitRouterId(java.lang.String)
//  .transitRouterId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
peerTransitRouterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property peerTransitRouterId: Peer forwarding router instance ID.
autoPublishRouteEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPublishRouteEnabled: Whether to make the enterprise version forwarding router automatically publish routes across regions to the peer region.
bandwidth java.lang.Number OR com.aliyun.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.
bandwidthType java.lang.String OR com.aliyun.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.
cenBandwidthPackageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cenBandwidthPackageId: The bandwidth packet ID to bind to across regions.
cenId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cenId: Cloud Enterprise Network Instance ID.
defaultLinkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property defaultLinkType: Default link type.
deletionForce java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionForce: Whether to force delete the peer attachment.
peerTransitRouterRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property peerTransitRouterRegionId: The region ID to which the peer forwarding router instance belongs.
routeTableAssociationEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property routeTableAssociationEnabled: Whether to enable the association of route tables.
routeTablePropagationEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property routeTablePropagationEnabled: Whether to enable the propagation of route tables.
tags java.util.List<TagsProperty> Property tags: The list of tags in the form of key\/value pairs.
transitRouterAttachmentDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property transitRouterAttachmentDescription: Description information for cross-region connections.
transitRouterAttachmentName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property transitRouterAttachmentName: The name of the cross-region connection.
transitRouterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property transitRouterId: Local Enterprise Edition forwarding router instance ID.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

peerTransitRouterIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property peerTransitRouterId: Peer forwarding router instance ID.


autoPublishRouteEnabledOptional

  • Type: java.lang.Boolean OR com.aliyun.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: java.lang.Number OR com.aliyun.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.


bandwidthTypeOptional

  • Type: java.lang.String OR com.aliyun.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.


cenBandwidthPackageIdOptional

  • Type: java.lang.String OR com.aliyun.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.


cenIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property cenId: Cloud Enterprise Network Instance ID.


defaultLinkTypeOptional

  • Type: java.lang.String OR com.aliyun.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.


deletionForceOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property deletionForce: Whether to force delete the peer attachment.


peerTransitRouterRegionIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property peerTransitRouterRegionId: The region ID to which the peer forwarding router instance belongs.


routeTableAssociationEnabledOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property routeTableAssociationEnabled: Whether to enable the association of route tables.


routeTablePropagationEnabledOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property routeTablePropagationEnabled: Whether to enable the propagation of route tables.


tagsOptional

Property tags: The list of tags in the form of key\/value pairs.

You can define a maximum of 20 tags.


transitRouterAttachmentDescriptionOptional

  • Type: java.lang.String OR com.aliyun.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://.


transitRouterAttachmentNameOptional

  • Type: java.lang.String OR com.aliyun.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://.


transitRouterIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property transitRouterId: Local Enterprise Edition forwarding router instance ID.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.cen.TransitRouterPeerAttachment;
TransitRouterPeerAttachment.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrTransitRouterAttachmentId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TransitRouterAttachmentId: Cross-region connection ID.
props TransitRouterPeerAttachmentProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrTransitRouterAttachmentIdRequired

public java.lang.Object getAttrTransitRouterAttachmentId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TransitRouterAttachmentId: Cross-region connection ID.


propsRequired

public TransitRouterPeerAttachmentProps getProps();