Skip to content

UserProvision

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
deletion_strategy typing.Union[str, ros_cdk_core.IResolvable] Property deletionStrategy: Delete policy.
directory_id typing.Union[str, ros_cdk_core.IResolvable] Property directoryId: The ID of the directory.
duplication_strategy typing.Union[str, ros_cdk_core.IResolvable] Property duplicationStrategy: Conflict policy.
principal_id typing.Union[str, ros_cdk_core.IResolvable] Property principalId: The ID of the principal.
principal_type typing.Union[str, ros_cdk_core.IResolvable] Property principalType: The type of the principal.
target_id typing.Union[str, ros_cdk_core.IResolvable] Property targetId: Target ID for RAM user synchronization.
target_type typing.Union[str, ros_cdk_core.IResolvable] Property targetType: Target type for RAM user synchronization.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the user.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

deletion_strategyRequired

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

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

Property directoryId: The ID of the directory.

duplication_strategyRequired

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

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

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

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

Property targetId: Target ID for RAM user synchronization.

Currently, it is the RD account ID.

target_typeRequired

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

Property targetType: Target type for RAM user synchronization.

Currently, it is RD-Account.

descriptionOptional

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

Property description: The description of the user.

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • 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_user_provision_id ros_cdk_core.IResolvable Attribute UserProvisionId: The ID of the user provisioning.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_user_provision_idRequired 

attr_user_provision_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserProvisionId: The ID of the user provisioning.