UserProvision

• Implements: IUserProvision

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

Initializers

import ros_cdk_cloudsso
ros_cdk_cloudsso.UserProvision(
  scope: Construct,
  id: str,
  deletion_strategy: typing.Union[str, IResolvable],
  directory_id: typing.Union[str, IResolvable],
  duplication_strategy: typing.Union[str, IResolvable],
  principal_id: typing.Union[str, IResolvable],
  principal_type: typing.Union[str, IResolvable],
  target_id: typing.Union[str, IResolvable],
  target_type: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

deletion_strategy^Required

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

Property deletionStrategy: Delete policy.

The treatment strategy for the synchronized RAM users when the RAM user synchronization is removed. Valid values:

• Delete: Delete When the RAM user synchronization is removed, the RAM users that have been synchronized to the RAM from the cloud SSO are deleted.
• Keep: When the RAM user synchronization is removed, the RAM users that have been synchronized to the RAM from the cloud SSO are retained.

directory_id^Required

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

Property directoryId: The ID of the directory.

duplication_strategy^Required

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

Property duplicationStrategy: Conflict policy.

When the cloud SSO user is synchronized to the RAM, the processing strategy if there is a user with the same name in the RAM. Valid values:

• KeepBoth: Keep both of them. When the cloud SSO user is synchronized to RAM, if the RAM already has a user with the same name, it will try to create a RAM user with the user name after adding the suffix _sso to the user name of the cloud SSO user.
• TakeOver: Take over. When the cloud SSO user is synchronized to the RAM, if the RAM already has a user with the same name, the existing RAM user is directly replaced by the cloud SSO synchronization user.

principal_id^Required

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

Property principalId: The ID of the principal.

Valid values:

• When the PrincipalType value is Group, the value is the cloud SSO user group ID (g-**).
• When PrincipalType takes the value User, this value is the cloud SSO user ID (u-**).

principal_type^Required

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

Property principalType: The type of the principal.

Valid values:

• User: The principal is a cloud SSO user.
• Group: The principal is a cloud SSO group.

target_id^Required

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

Property targetId: Target ID for RAM user synchronization.

Currently, it is the RD account ID.

target_type^Required

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

Property targetType: Target type for RAM user synchronization.

Currently, it is RD-Account.

description^Optional

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

Property description: The description of the user.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

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

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

is_construct

import ros_cdk_cloudsso
ros_cdk_cloudsso.UserProvision.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

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_user_provision_id^Required

attr_user_provision_id: typing.Union[str, IResolvable]

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

Attribute UserProvisionId: The ID of the user provisioning.

props^Required

props: UserProvisionProps

• Type: UserProvisionProps