Skip to content

Handshake

This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::Handshake.

Initializers

import com.aliyun.ros.cdk.resourcemanager.Handshake;
Handshake.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .targetEntity(java.lang.String)
    .targetEntity(IResolvable)
    .targetType(java.lang.String)
    .targetType(IResolvable)
//  .note(java.lang.String)
//  .note(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.
targetEntity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetEntity: Invited account ID or login email.
targetType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetType: Type of account being invited.
note java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property note: Remarks.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

targetEntityRequired

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

Property targetEntity: Invited account ID or login email.


targetTypeRequired

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

Property targetType: Type of account being invited.

Valid values: Account, Email


noteOptional

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

Property note: Remarks.


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.resourcemanager.Handshake;
Handshake.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.
attrHandshakeId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HandshakeId: This ID of Resource Manager handshake.
attrMasterAccountId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MasterAccountId: Resource account master account ID.
attrMasterAccountName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MasterAccountName: The name of the main account of the resource directory.
attrNote java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Note: Remarks.
attrResourceDirectoryId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceDirectoryId: Resource directory ID.
attrTargetEntity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TargetEntity: Invited account ID or login email.
attrTargetType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TargetType: Type of account being invited.
props HandshakeProps 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

attrHandshakeIdRequired

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

Attribute HandshakeId: This ID of Resource Manager handshake.


attrMasterAccountIdRequired

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

Attribute MasterAccountId: Resource account master account ID.


attrMasterAccountNameRequired

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

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


attrNoteRequired

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

Attribute Note: Remarks.


attrResourceDirectoryIdRequired

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

Attribute ResourceDirectoryId: Resource directory ID.


attrTargetEntityRequired

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

Attribute TargetEntity: Invited account ID or login email.


attrTargetTypeRequired

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

Attribute TargetType: Type of account being invited.

Valid values: Account, Email


propsRequired

public HandshakeProps getProps();