Skip to content

Role

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

Initializers

import com.aliyun.ros.cdk.resourcemanager.Role;
Role.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .assumeRolePolicyDocument(IResolvable)
    .assumeRolePolicyDocument(java.util.Map<java.lang.String, java.lang.Object>)
    .roleName(java.lang.String)
    .roleName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .maxSessionDuration(java.lang.Number)
//  .maxSessionDuration(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.
assumeRolePolicyDocument com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property assumeRolePolicyDocument: The content of the permissions strategy that plays a role.
roleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property roleName: Role Name.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the Resource Manager role.
maxSessionDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxSessionDuration: Role maximum session time.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

assumeRolePolicyDocumentRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property assumeRolePolicyDocument: The content of the permissions strategy that plays a role.


roleNameRequired

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

Property roleName: Role Name.


descriptionOptional

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

Property description: The description of the Resource Manager role.


maxSessionDurationOptional

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

Property maxSessionDuration: Role maximum session time.

Valid values: [3600-43200]. Default to 3600.


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.Role;
Role.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.
attrArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Arn: The resource descriptor of the role.
attrAssumeRolePolicyDocument java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AssumeRolePolicyDocument: The content of the permissions strategy that plays a role.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Role creation time.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the Resource Manager role.
attrMaxSessionDuration java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute MaxSessionDuration: Role maximum session time.
attrRoleId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RoleId: This ID of Resource Manager role.
attrRoleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RoleName: Role Name.
attrUpdateDate java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UpdateDate: Role update time.
props RoleProps 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

attrArnRequired

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

Attribute Arn: The resource descriptor of the role.


attrAssumeRolePolicyDocumentRequired

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

Attribute AssumeRolePolicyDocument: The content of the permissions strategy that plays a role.


attrCreateTimeRequired

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

Attribute CreateTime: Role creation time.


attrDescriptionRequired

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

Attribute Description: The description of the Resource Manager role.


attrMaxSessionDurationRequired

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

Attribute MaxSessionDuration: Role maximum session time.

Valid values: [3600-43200].


attrRoleIdRequired

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

Attribute RoleId: This ID of Resource Manager role.


attrRoleNameRequired

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

Attribute RoleName: Role Name.


attrUpdateDateRequired

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

Attribute UpdateDate: Role update time.


propsRequired

public RoleProps getProps();