Skip to content

RoleProps

Properties for defining a Role.

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

Initializer 

import com.aliyun.ros.cdk.ram.RoleProps;
RoleProps.builder()
    .assumeRolePolicyDocument(IResolvable)
    .assumeRolePolicyDocument(AssumeRolePolicyDocumentProperty)
    .roleName(java.lang.String)
    .roleName(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .ignoreExisting(java.lang.Boolean)
//  .ignoreExisting(IResolvable)
//  .maxSessionDuration(java.lang.Number)
//  .maxSessionDuration(IResolvable)
//  .policies(IResolvable)
//  .policies(java.util.List<IResolvable)
//  .policies(PoliciesProperty>)
//  .policyAttachments(IResolvable)
//  .policyAttachments(PolicyAttachmentsProperty)
    .build();

Properties

Name Type Description
assumeRolePolicyDocument com.aliyun.ros.cdk.core.IResolvable OR AssumeRolePolicyDocumentProperty Property assumeRolePolicyDocument: The RAM assume role policy that is associated with this role.
roleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property roleName: Specifies the role name, containing up to 64 characters.
deletionForce java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionForce: Whether force detach the policies attached to the role.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Remark information, up to 1024 characters or Chinese characters.
ignoreExisting java.lang.Boolean OR com.aliyun.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 java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxSessionDuration: The maximum session duration of the RAM role.
policies com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPoliciesProperty> Property policies: Describes what actions are allowed on what resources.
policyAttachments com.aliyun.ros.cdk.core.IResolvable OR PolicyAttachmentsProperty Property policyAttachments: System and custom policy names to attach.

assumeRolePolicyDocumentRequired 

public java.lang.Object getAssumeRolePolicyDocument();

Property assumeRolePolicyDocument: The RAM assume role policy that is associated with this role.

roleNameRequired 

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

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

deletionForceOptional 

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

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

Default value is false.

descriptionOptional 

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

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

ignoreExistingOptional 

public java.lang.Object getIgnoreExisting();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getMaxSessionDuration();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPolicies();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListPoliciesProperty>

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

policyAttachmentsOptional 

public java.lang.Object getPolicyAttachments();

Property policyAttachments: System and custom policy names to attach.