Role
- Implements: IRole
This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::Role.
Initializers
import ros_cdk_resourcemanager
ros_cdk_resourcemanager.Role(
scope: Construct,
id: str,
assume_role_policy_document: typing.Union[IResolvable, typing.Mapping[typing.Any]],
role_name: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable] = None,
max_session_duration: typing.Union[typing.Union[int, float], IResolvable] = 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, typing.Mapping[typing.Any]] | Property assumeRolePolicyDocument: The content of the permissions strategy that plays a role. |
role_name | typing.Union[str, ros_cdk_core.IResolvable] | Property roleName: Role Name. |
description | typing.Union[str, ros_cdk_core.IResolvable] | Property description: The description of the Resource Manager role. |
max_session_duration | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property maxSessionDuration: Role maximum session time. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
assume_role_policy_documentRequired
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property assumeRolePolicyDocument: The content of the permissions strategy that plays a role.
role_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property roleName: Role Name.
descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the Resource Manager role.
max_session_durationOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property maxSessionDuration: Role maximum session time.
Valid values: [3600-43200]. Default to 3600.
enable_resource_property_constraintOptional
- 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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_resourcemanager
ros_cdk_resourcemanager.Role.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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 | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Arn: The resource descriptor of the role. |
attr_assume_role_policy_document | typing.Union[str, ros_cdk_core.IResolvable] | Attribute AssumeRolePolicyDocument: The content of the permissions strategy that plays a role. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: Role creation time. |
attr_description | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Description: The description of the Resource Manager role. |
attr_max_session_duration | typing.Union[str, ros_cdk_core.IResolvable] | Attribute MaxSessionDuration: Role maximum session time. |
attr_role_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute RoleId: This ID of Resource Manager role. |
attr_role_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute RoleName: Role Name. |
attr_update_date | typing.Union[str, ros_cdk_core.IResolvable] | Attribute UpdateDate: Role update time. |
props | RoleProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: 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
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_arnRequired
attr_arn: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Arn: The resource descriptor of the role.
attr_assume_role_policy_documentRequired
attr_assume_role_policy_document: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute AssumeRolePolicyDocument: The content of the permissions strategy that plays a role.
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: Role creation time.
attr_descriptionRequired
attr_description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Description: The description of the Resource Manager role.
attr_max_session_durationRequired
attr_max_session_duration: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute MaxSessionDuration: Role maximum session time.
Valid values: [3600-43200].
attr_role_idRequired
attr_role_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute RoleId: This ID of Resource Manager role.
attr_role_nameRequired
attr_role_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute RoleName: Role Name.
attr_update_dateRequired
attr_update_date: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute UpdateDate: Role update time.
propsRequired
props: RoleProps
- Type: RoleProps