Skip to content

RoleProps

Properties for defining a Role.

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

Initializer 

import ros_cdk_ram
ros_cdk_ram.RoleProps(
  assume_role_policy_document: typing.Union[IResolvable, AssumeRolePolicyDocumentProperty],
  role_name: typing.Union[str, IResolvable],
  deletion_force: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  ignore_existing: typing.Union[bool, IResolvable] = None,
  max_session_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  policies: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PoliciesProperty]]] = None,
  policy_attachments: typing.Union[IResolvable, PolicyAttachmentsProperty] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
assume_role_policy_document typing.Union[ros_cdk_core.IResolvable, AssumeRolePolicyDocumentProperty] Property assumeRolePolicyDocument: The RAM assume role policy that is associated with this role.
role_name typing.Union[str, ros_cdk_core.IResolvable] Property roleName: Specifies the role name, containing up to 64 characters.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Whether force detach the policies attached to the role.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Remark information, up to 1024 characters or Chinese characters.
ignore_existing typing.Union[bool, 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.
max_session_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxSessionDuration: The maximum session duration of the RAM role.
policies typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PoliciesProperty]]] Property policies: Describes what actions are allowed on what resources.
policy_attachments typing.Union[ros_cdk_core.IResolvable, PolicyAttachmentsProperty] Property policyAttachments: System and custom policy names to attach.
tags typing.List[TagsProperty] Property tags: Tags to attach to role.

assume_role_policy_documentRequired 

assume_role_policy_document: typing.Union[IResolvable, AssumeRolePolicyDocumentProperty]

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

role_nameRequired 

role_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

deletion_forceOptional 

deletion_force: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default value is false.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

ignore_existingOptional 

ignore_existing: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.

max_session_durationOptional 

max_session_duration: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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 

policies: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, PoliciesProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, PoliciesProperty]]]

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

policy_attachmentsOptional 

policy_attachments: typing.Union[IResolvable, PolicyAttachmentsProperty]

Property policyAttachments: System and custom policy names to attach.

tagsOptional 

tags: typing.List[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.