Handshake

This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::Handshake, which is used to create an invitation.

Initializers

import { Handshake } from '@alicloud/ros-cdk-resourcemanager'
new Handshake(scope: Construct, id: string, props: HandshakeProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	HandshakeProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: HandshakeProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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.
getAtt	No description.
setMetadata	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

session^Required

• Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { Handshake } from '@alicloud/ros-cdk-resourcemanager'
Handshake.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrHandshakeId	@alicloud/ros-cdk-core.IResolvable	Attribute HandshakeId: This ID of Resource Manager handshake.
attrMasterAccountId	@alicloud/ros-cdk-core.IResolvable	Attribute MasterAccountId: Resource account master account ID.
attrMasterAccountName	@alicloud/ros-cdk-core.IResolvable	Attribute MasterAccountName: The name of the main account of the resource directory.
attrNote	@alicloud/ros-cdk-core.IResolvable	Attribute Note: Remarks.
attrResourceDirectoryId	@alicloud/ros-cdk-core.IResolvable	Attribute ResourceDirectoryId: Resource directory ID.
attrTargetEntity	@alicloud/ros-cdk-core.IResolvable	Attribute TargetEntity: Invited account ID or login email.
attrTargetType	@alicloud/ros-cdk-core.IResolvable	Attribute TargetType: Type of account being invited.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrHandshakeId^Required

public readonly attrHandshakeId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HandshakeId: This ID of Resource Manager handshake.

---

attrMasterAccountId^Required

public readonly attrMasterAccountId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute MasterAccountId: Resource account master account ID.

---

attrMasterAccountName^Required

public readonly attrMasterAccountName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute MasterAccountName: The name of the main account of the resource directory.

---

attrNote^Required

public readonly attrNote: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Note: Remarks.

---

attrResourceDirectoryId^Required

public readonly attrResourceDirectoryId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceDirectoryId: Resource directory ID.

---

attrTargetEntity^Required

public readonly attrTargetEntity: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute TargetEntity: Invited account ID or login email.

---

attrTargetType^Required

public readonly attrTargetType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute TargetType: Type of account being invited.

Valid values: Account, Email

---