Skip to content

RoleProps

Properties for defining a Role.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ram-role

Initializer 

import { RoleProps } from '@alicloud/ros-cdk-ram'
const roleProps: RoleProps = { ... }

Properties

Name Type Description
assumeRolePolicyDocument @alicloud/ros-cdk-core.IResolvable | AssumeRolePolicyDocumentProperty Property assumeRolePolicyDocument: The trust policy that specifies one or more trusted entities allowed to assume the RAM role.
roleName string | @alicloud/ros-cdk-core.IResolvable Property roleName: Specifies the role name, containing up to 64 characters.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether force detach the policies attached to the role.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Remark information, up to 1024 characters or Chinese characters.
ignoreExisting boolean | @alicloud/ros-cdk-core.IResolvable Property ignoreExisting: Whether to ignore existing role False: ROS will perform a uniqueness check.If a role with the same name exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If there is a role with the same name, the role creation process will be ignored. If the role is not created by ROS, it will be ignored during update and delete stage.
maxSessionDuration number | @alicloud/ros-cdk-core.IResolvable Property maxSessionDuration: The maximum session duration of the RAM role.
policies @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PoliciesProperty[] Property policies: Describes what actions are allowed on what resources.
policyAttachments @alicloud/ros-cdk-core.IResolvable | PolicyAttachmentsProperty Property policyAttachments: System and custom policy names to attach.
tags TagsProperty[] Property tags: Tags to attach to role.

assumeRolePolicyDocumentRequired 

public readonly assumeRolePolicyDocument: IResolvable | AssumeRolePolicyDocumentProperty;

Property assumeRolePolicyDocument: The trust policy that specifies one or more trusted entities allowed to assume the RAM role.

Trusted entities can be cloud accounts, cloud services, or identity providers (IdPs).

RAM users cannot assume RAM roles whose trusted entity is a cloud service.

roleNameRequired 

public readonly roleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property roleName: Specifies the role name, containing up to 64 characters.

deletionForceOptional 

public readonly deletionForce: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property deletionForce: Whether force detach the policies attached to the role.

Default value is false.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Remark information, up to 1024 characters or Chinese characters.

ignoreExistingOptional 

public readonly ignoreExisting: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property ignoreExisting: Whether to ignore existing role False: ROS will perform a uniqueness check.If a role with the same name exists, an error will be reported when creating it. True: ROS will not check the uniqueness.If there is a role with the same name, the role creation process will be ignored. If the role is not created by ROS, it will be ignored during update and delete stage.

maxSessionDurationOptional 

public readonly maxSessionDuration: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property maxSessionDuration: The maximum session duration of the RAM role.

Valid values: 3600 to 43200. Unit: seconds. Default value: 3600. The default value is used if the parameter is not specified.

policiesOptional 

public readonly policies: IResolvable | IResolvable | PoliciesProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | PoliciesProperty[]

Property policies: Describes what actions are allowed on what resources.

policyAttachmentsOptional 

public readonly policyAttachments: IResolvable | PolicyAttachmentsProperty;

Property policyAttachments: System and custom policy names to attach.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to role.

Max support 20 tags to add during create role. Each tag with two properties Key and Value, and Key is required.