Role
- Implements: @alicloud/ros-cdk-ram.datasource.IRole
This class encapsulates and extends the ROS resource type DATASOURCE::RAM::Role.
Initializers
import { datasource } from '@alicloud/ros-cdk-ram'
new datasource.Role(scope: Construct, id: string, props?: RoleProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | RoleProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsOptional
- Type: RoleProps
enableResourcePropertyConstraintOptional
- 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-ram'
datasource.Role.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrArn | string | @alicloud/ros-cdk-core.IResolvable | Attribute Arn: The ARN of the RAM role. |
attrCreateDate | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateDate: The time when the RAM role was created. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: The description of the RAM role. |
attrMaxSessionDuration | string | @alicloud/ros-cdk-core.IResolvable | Attribute MaxSessionDuration: The maximum session duration of the RAM role. |
attrRoleId | string | @alicloud/ros-cdk-core.IResolvable | Attribute RoleId: The ID of the RAM role. |
attrRoleName | string | @alicloud/ros-cdk-core.IResolvable | Attribute RoleName: The name of the RAM role. |
attrUpdateDate | string | @alicloud/ros-cdk-core.IResolvable | Attribute UpdateDate: The time when the RAM role was last updated. |
props | RoleProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrArnRequired
public readonly attrArn: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Arn: The ARN of the RAM role.
attrCreateDateRequired
public readonly attrCreateDate: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateDate: The time when the RAM role was created.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: The description of the RAM role.
attrMaxSessionDurationRequired
public readonly attrMaxSessionDuration: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MaxSessionDuration: The maximum session duration of the RAM role.
attrRoleIdRequired
public readonly attrRoleId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RoleId: The ID of the RAM role.
attrRoleNameRequired
public readonly attrRoleName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute RoleName: The name of the RAM role.
attrUpdateDateRequired
public readonly attrUpdateDate: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute UpdateDate: The time when the RAM role was last updated.
propsRequired
public readonly props: RoleProps;
- Type: RoleProps