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 com.aliyun.ros.cdk.cloudsso.UserProvision;
UserProvision.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .deletionStrategy(java.lang.String)
    .deletionStrategy(IResolvable)
    .directoryId(java.lang.String)
    .directoryId(IResolvable)
    .duplicationStrategy(java.lang.String)
    .duplicationStrategy(IResolvable)
    .principalId(java.lang.String)
    .principalId(IResolvable)
    .principalType(java.lang.String)
    .principalType(IResolvable)
    .targetId(java.lang.String)
    .targetId(IResolvable)
    .targetType(java.lang.String)
    .targetType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
deletionStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property deletionStrategy: Delete policy.
directoryId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property directoryId: The ID of the directory.
duplicationStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property duplicationStrategy: Conflict policy.
principalId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property principalId: The ID of the principal.
principalType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property principalType: The type of the principal.
targetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetId: Target ID for RAM user synchronization.
targetType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetType: Target type for RAM user synchronization.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the user.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

deletionStrategyRequired

  • Type: java.lang.String OR com.aliyun.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.

directoryIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property directoryId: The ID of the directory.

duplicationStrategyRequired

  • Type: java.lang.String OR com.aliyun.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.

principalIdRequired

  • Type: java.lang.String OR com.aliyun.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-**).

principalTypeRequired

  • Type: java.lang.String OR com.aliyun.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.

targetIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetId: Target ID for RAM user synchronization.

Currently, it is the RD account ID.

targetTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetType: Target type for RAM user synchronization.

Currently, it is RD-Account.

descriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the user.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.cloudsso.UserProvision;
UserProvision.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrUserProvisionId com.aliyun.ros.cdk.core.IResolvable Attribute UserProvisionId: The ID of the user provisioning.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrUserProvisionIdRequired 

public IResolvable getAttrUserProvisionId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UserProvisionId: The ID of the user provisioning.