Role

This class encapsulates and extends the ROS resource type ALIYUN::RAM::Role, which is used to create a Resource Access Management (RAM) role.

Initializers

import ros_cdk_ram
ros_cdk_ram.Role(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

assume_role_policy_document^Required

• Type: typing.Union[ros_cdk_core.IResolvable, AssumeRolePolicyDocumentProperty]

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

---

role_name^Required

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

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

---

deletion_force^Optional

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

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

Default value is false.

---

description^Optional

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

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

---

ignore_existing^Optional

• 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_duration^Optional

• 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.

---

policies^Optional

• 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_attachments^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, PolicyAttachmentsProperty]

Property policyAttachments: System and custom policy names to attach.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_ram
ros_cdk_ram.Role.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_arn	ros_cdk_core.IResolvable	Attribute Arn: Name of alicloud resource.
attr_role_id	ros_cdk_core.IResolvable	Attribute RoleId: Id of ram role.
attr_role_name	ros_cdk_core.IResolvable	Attribute RoleName: Name of ram role.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_arn^Required

attr_arn: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Arn: Name of alicloud resource.

---

attr_role_id^Required

attr_role_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RoleId: Id of ram role.

---

attr_role_name^Required

attr_role_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RoleName: Name of ram role.

---