Skip to content

RosTransitRouterPeerAttachment

This class is a base encapsulation around the ROS resource type ALIYUN::CEN::TransitRouterPeerAttachment, which is used to create a cross-region connection for an Enterprise Edition transit router.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Cen;
new RosTransitRouterPeerAttachment(Construct Scope, string Id, RosTransitRouterPeerAttachmentProps Props, bool EnableResourcePropertyConstraint);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct - scope in which this resource is defined.
Id string - scoped id of the resource.
Props RosTransitRouterPeerAttachmentProps - resource properties.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

scope in which this resource is defined.


IdRequired

  • Type: string

scoped id of the resource.


PropsRequired

resource properties.


EnableResourcePropertyConstraintRequired

  • Type: bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
AddCondition No description.
AddCount No description.
AddDeletionOverride Syntactic sugar for addOverride(path, undefined).
AddDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc No description.
AddMetaData No description.
AddOverride Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride Adds an override to a resource property.
AddRosDependency No description.
ApplyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
GetAtt Returns a token for an runtime attribute of this resource.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.


AddCondition

private void AddCondition(RosCondition Con)

ConRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

PathRequired

  • Type: string

The path of the value to delete.


AddDependsOn

private void AddDependsOn(RosResource Target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

TargetRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AddDesc

private void AddDesc(string Desc)

DescRequired

  • Type: string

AddMetaData

private void AddMetaData(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

AddOverride

private void AddOverride(string Path, object Value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

PathRequired

  • Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


ValueRequired

  • Type: object

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

Adds an override that deletes the value of a property from the resource definition.

PropertyPathRequired

  • Type: string

The path to the property.


AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

PropertyPathRequired

  • Type: string

The path of the property.


ValueRequired

  • Type: object

The value.


AddRosDependency

private void AddRosDependency(string Target)

TargetRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

Sets the deletion policy of the resource based on the removal policy specified.

PolicyOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

OptionsOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

GetAtt

private Reference GetAtt(string AttributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

AttributeNameRequired

  • Type: string

The name of the attribute.


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
IsRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource Check whether the given construct is a RosResource.

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Cen;
RosTransitRouterPeerAttachment.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Cen;
RosTransitRouterPeerAttachment.IsRosElement(object X);

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

XRequired

  • Type: object

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Cen;
RosTransitRouterPeerAttachment.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

ConstructRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
CreationStack string[] No description.
LogicalId string The logical ID for this stack element.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this element is defined.
Ref string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType string ROS resource type.
AttrAutoPublishRouteEnabled AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrBandwidth AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrCenBandwidthPackageId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrCenId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrClientToken AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrGeographicSpanId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPeerTransitRouterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPeerTransitRouterOwnerId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrPeerTransitRouterRegionId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrResourceType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrTransitRouterAttachmentDescription AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrTransitRouterAttachmentId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrTransitRouterAttachmentName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrTransitRouterId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
EnableResourcePropertyConstraint bool No description.
PeerTransitRouterId object No description.
AutoPublishRouteEnabled object No description.
Bandwidth object No description.
CenBandwidthPackageId object No description.
CenId object No description.
PeerTransitRouterRegionId object No description.
TransitRouterAttachmentDescription object No description.
TransitRouterAttachmentName object No description.
TransitRouterId object No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

public string[] CreationStack { get; }
  • Type: string[]

LogicalIdRequired

public string LogicalId { get; }
  • Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


RefRequired

public string Ref { get; }
  • Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


RosOptionsRequired

public IRosResourceOptions RosOptions { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


RosResourceTypeRequired

public string RosResourceType { get; }
  • Type: string

ROS resource type.


AttrAutoPublishRouteEnabledRequired

public IResolvable AttrAutoPublishRouteEnabled { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrBandwidthRequired

public IResolvable AttrBandwidth { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrCenBandwidthPackageIdRequired

public IResolvable AttrCenBandwidthPackageId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrCenIdRequired

public IResolvable AttrCenId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrClientTokenRequired

public IResolvable AttrClientToken { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrGeographicSpanIdRequired

public IResolvable AttrGeographicSpanId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrPeerTransitRouterIdRequired

public IResolvable AttrPeerTransitRouterId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrPeerTransitRouterOwnerIdRequired

public IResolvable AttrPeerTransitRouterOwnerId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrPeerTransitRouterRegionIdRequired

public IResolvable AttrPeerTransitRouterRegionId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrResourceTypeRequired

public IResolvable AttrResourceType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrTransitRouterAttachmentDescriptionRequired

public IResolvable AttrTransitRouterAttachmentDescription { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrTransitRouterAttachmentIdRequired

public IResolvable AttrTransitRouterAttachmentId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrTransitRouterAttachmentNameRequired

public IResolvable AttrTransitRouterAttachmentName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrTransitRouterIdRequired

public IResolvable AttrTransitRouterId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

PeerTransitRouterIdRequired

public object PeerTransitRouterId { get; }
  • Type: object

AutoPublishRouteEnabledOptional

public object AutoPublishRouteEnabled { get; }
  • Type: object

BandwidthOptional

public object Bandwidth { get; }
  • Type: object

CenBandwidthPackageIdOptional

public object CenBandwidthPackageId { get; }
  • Type: object

CenIdOptional

public object CenId { get; }
  • Type: object

PeerTransitRouterRegionIdOptional

public object PeerTransitRouterRegionId { get; }
  • Type: object

TransitRouterAttachmentDescriptionOptional

public object TransitRouterAttachmentDescription { get; }
  • Type: object

TransitRouterAttachmentNameOptional

public object TransitRouterAttachmentName { get; }
  • Type: object

TransitRouterIdOptional

public object TransitRouterId { get; }
  • Type: object

Constants

Name Type Description
RosResourceTypeName string The resource type name for this resource class.

RosResourceTypeNameRequired

public string RosResourceTypeName { get; }
  • Type: string

The resource type name for this resource class.