Role
- Implements: IRole
This class encapsulates and extends the ROS resource type ALIYUN::MaxCompute::Role.
Initializers
import ros_cdk_maxcompute
ros_cdk_maxcompute.Role(
scope: Construct,
id: str,
project_name: typing.Union[str, IResolvable],
role_name: typing.Union[str, IResolvable],
type: typing.Union[str, IResolvable],
acl: typing.Union[IResolvable, AclProperty] = None,
policy: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
project_name | typing.Union[str, ros_cdk_core.IResolvable] | Property projectName: The name of the MaxCompute project. |
role_name | typing.Union[str, ros_cdk_core.IResolvable] | Property roleName: The name of the project role. |
type | typing.Union[str, ros_cdk_core.IResolvable] | Property type: Role types, MaxCompute provides administrator roles and resource roles. |
acl | typing.Union[ros_cdk_core.IResolvable, AclProperty] | Property acl: The access-control list (ACL), This parameter is not required if a policy is used. |
policy | typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] | Property policy: The document of the policy. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
project_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property projectName: The name of the MaxCompute project.
role_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property roleName: The name of the project role.
typeRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property type: Role types, MaxCompute provides administrator roles and resource roles.
Valid values: Admin: You can grant management-related permissions to administrator roles by using policies instead of access control lists (ACLs). You cannot grant resource-related permissions to administrator roles. Resource: You can grant resource-related permissions but not management-related permissions to resource roles.
aclOptional
- Type: typing.Union[ros_cdk_core.IResolvable, AclProperty]
Property acl: The access-control list (ACL), This parameter is not required if a policy is used.
policyOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property policy: The document of the policy.
This parameter is not required if an access-control list (ACL) is used.
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_maxcompute
ros_cdk_maxcompute.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_project_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ProjectName: The name of the MaxCompute project. |
attr_role_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute RoleName: The name of the project role. |
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_project_nameRequired
attr_project_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ProjectName: The name of the MaxCompute project.
attr_role_nameRequired
attr_role_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute RoleName: The name of the project role.
propsRequired
props: RoleProps
- Type: RoleProps