Docs Packages
  1. Packages
  2. Volcengine
  3. API Docs
  4. cloud_identity
  5. UserProvisioning
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.cloud_identity.UserProvisioning

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage cloud identity user provisioning

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloud_identity.User;
import com.pulumi.volcengine.cloud_identity.UserArgs;
import com.pulumi.volcengine.cloud_identity.UserProvisioning;
import com.pulumi.volcengine.cloud_identity.UserProvisioningArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fooUser = new User("fooUser", UserArgs.builder()        
            .userName("acc-test-user")
            .displayName("tf-test-user")
            .description("tf")
            .email("88@qq.com")
            .phone("181")
            .build());

        var fooUserProvisioning = new UserProvisioning("fooUserProvisioning", UserProvisioningArgs.builder()        
            .principalType("User")
            .principalId(fooUser.id())
            .targetId("210026****")
            .description("tf")
            .identitySourceStrategy("Ignore")
            .duplicationStrategy("KeepBoth")
            .duplicationSuffix("-tf")
            .deletionStrategy("Delete")
            .policyName("AdministratorAccess")
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  fooUser:
    type: volcengine:cloud_identity:User
    properties:
      userName: acc-test-user
      displayName: tf-test-user
      description: tf
      email: 88@qq.com
      phone: '181'
  fooUserProvisioning:
    type: volcengine:cloud_identity:UserProvisioning
    properties:
      principalType: User
      principalId: ${fooUser.id}
      targetId: 210026****
      description: tf
      identitySourceStrategy: Ignore
      duplicationStrategy: KeepBoth
      duplicationSuffix: -tf
      deletionStrategy: Delete
      policyName:
        - AdministratorAccess

    Create UserProvisioning Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserProvisioning(name: string, args: UserProvisioningArgs, opts?: CustomResourceOptions);
    @overload
def UserProvisioning(resource_name: str,
                     args: UserProvisioningArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def UserProvisioning(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     deletion_strategy: Optional[str] = None,
                     duplication_strategy: Optional[str] = None,
                     identity_source_strategy: Optional[str] = None,
                     principal_id: Optional[str] = None,
                     principal_type: Optional[str] = None,
                     target_id: Optional[str] = None,
                     description: Optional[str] = None,
                     duplication_suffix: Optional[str] = None,
                     policy_name: Optional[str] = None)
    func NewUserProvisioning(ctx *Context, name string, args UserProvisioningArgs, opts ...ResourceOption) (*UserProvisioning, error)
    public UserProvisioning(string name, UserProvisioningArgs args, CustomResourceOptions? opts = null)
    public UserProvisioning(String name, UserProvisioningArgs args)
public UserProvisioning(String name, UserProvisioningArgs args, CustomResourceOptions options)

    type: volcengine:cloud_identity:UserProvisioning
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserProvisioningArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserProvisioningArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserProvisioningArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserProvisioningArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserProvisioningArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userProvisioningResource = new Volcengine.Cloud_identity.UserProvisioning("userProvisioningResource", new()
{
    DeletionStrategy = "string",
    DuplicationStrategy = "string",
    IdentitySourceStrategy = "string",
    PrincipalId = "string",
    PrincipalType = "string",
    TargetId = "string",
    Description = "string",
    DuplicationSuffix = "string",
    PolicyName = "string",
});

    example, err := cloud_identity.NewUserProvisioning(ctx, "userProvisioningResource", &cloud_identity.UserProvisioningArgs{
	DeletionStrategy:       pulumi.String("string"),
	DuplicationStrategy:    pulumi.String("string"),
	IdentitySourceStrategy: pulumi.String("string"),
	PrincipalId:            pulumi.String("string"),
	PrincipalType:          pulumi.String("string"),
	TargetId:               pulumi.String("string"),
	Description:            pulumi.String("string"),
	DuplicationSuffix:      pulumi.String("string"),
	PolicyName:             pulumi.String("string"),
})

    var userProvisioningResource = new UserProvisioning("userProvisioningResource", UserProvisioningArgs.builder()
    .deletionStrategy("string")
    .duplicationStrategy("string")
    .identitySourceStrategy("string")
    .principalId("string")
    .principalType("string")
    .targetId("string")
    .description("string")
    .duplicationSuffix("string")
    .policyName("string")
    .build());

    user_provisioning_resource = volcengine.cloud_identity.UserProvisioning("userProvisioningResource",
    deletion_strategy="string",
    duplication_strategy="string",
    identity_source_strategy="string",
    principal_id="string",
    principal_type="string",
    target_id="string",
    description="string",
    duplication_suffix="string",
    policy_name="string")

    const userProvisioningResource = new volcengine.cloud_identity.UserProvisioning("userProvisioningResource", {
    deletionStrategy: "string",
    duplicationStrategy: "string",
    identitySourceStrategy: "string",
    principalId: "string",
    principalType: "string",
    targetId: "string",
    description: "string",
    duplicationSuffix: "string",
    policyName: "string",
});

    type: volcengine:cloud_identity:UserProvisioning
properties:
    deletionStrategy: string
    description: string
    duplicationStrategy: string
    duplicationSuffix: string
    identitySourceStrategy: string
    policyName: string
    principalId: string
    principalType: string
    targetId: string

    UserProvisioning Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The UserProvisioning resource accepts the following input properties:

    DeletionStrategy string
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    DuplicationStrategy string
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    IdentitySourceStrategy string
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    PrincipalId string
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    PrincipalType string
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    TargetId string
    The target account id of the cloud identity user provisioning.
    Description string
    The description of the cloud identity user provisioning.
    DuplicationSuffix string
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    PolicyName string
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    DeletionStrategy string
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    DuplicationStrategy string
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    IdentitySourceStrategy string
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    PrincipalId string
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    PrincipalType string
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    TargetId string
    The target account id of the cloud identity user provisioning.
    Description string
    The description of the cloud identity user provisioning.
    DuplicationSuffix string
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    PolicyName string
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    deletionStrategy String
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    duplicationStrategy String
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    identitySourceStrategy String
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    principalId String
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principalType String
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    targetId String
    The target account id of the cloud identity user provisioning.
    description String
    The description of the cloud identity user provisioning.
    duplicationSuffix String
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    policyName String
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    deletionStrategy string
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    duplicationStrategy string
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    identitySourceStrategy string
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    principalId string
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principalType string
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    targetId string
    The target account id of the cloud identity user provisioning.
    description string
    The description of the cloud identity user provisioning.
    duplicationSuffix string
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    policyName string
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    deletion_strategy str
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    duplication_strategy str
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    identity_source_strategy str
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    principal_id str
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principal_type str
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    target_id str
    The target account id of the cloud identity user provisioning.
    description str
    The description of the cloud identity user provisioning.
    duplication_suffix str
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    policy_name str
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    deletionStrategy String
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    duplicationStrategy String
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    identitySourceStrategy String
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    principalId String
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principalType String
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    targetId String
    The target account id of the cloud identity user provisioning.
    description String
    The description of the cloud identity user provisioning.
    duplicationSuffix String
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    policyName String
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserProvisioning resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalName string
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    ProvisionStatus string
    The status of the cloud identity user provisioning.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalName string
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    ProvisionStatus string
    The status of the cloud identity user provisioning.
    id String
    The provider-assigned unique ID for this managed resource.
    principalName String
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    provisionStatus String
    The status of the cloud identity user provisioning.
    id string
    The provider-assigned unique ID for this managed resource.
    principalName string
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    provisionStatus string
    The status of the cloud identity user provisioning.
    id str
    The provider-assigned unique ID for this managed resource.
    principal_name str
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    provision_status str
    The status of the cloud identity user provisioning.
    id String
    The provider-assigned unique ID for this managed resource.
    principalName String
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    provisionStatus String
    The status of the cloud identity user provisioning.

    Look up Existing UserProvisioning Resource

    Get an existing UserProvisioning resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserProvisioningState, opts?: CustomResourceOptions): UserProvisioning
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deletion_strategy: Optional[str] = None,
        description: Optional[str] = None,
        duplication_strategy: Optional[str] = None,
        duplication_suffix: Optional[str] = None,
        identity_source_strategy: Optional[str] = None,
        policy_name: Optional[str] = None,
        principal_id: Optional[str] = None,
        principal_name: Optional[str] = None,
        principal_type: Optional[str] = None,
        provision_status: Optional[str] = None,
        target_id: Optional[str] = None) -> UserProvisioning
    func GetUserProvisioning(ctx *Context, name string, id IDInput, state *UserProvisioningState, opts ...ResourceOption) (*UserProvisioning, error)
    public static UserProvisioning Get(string name, Input<string> id, UserProvisioningState? state, CustomResourceOptions? opts = null)
    public static UserProvisioning get(String name, Output<String> id, UserProvisioningState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DeletionStrategy string
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    Description string
    The description of the cloud identity user provisioning.
    DuplicationStrategy string
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    DuplicationSuffix string
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    IdentitySourceStrategy string
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    PolicyName string
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    PrincipalId string
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    PrincipalName string
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    PrincipalType string
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    ProvisionStatus string
    The status of the cloud identity user provisioning.
    TargetId string
    The target account id of the cloud identity user provisioning.
    DeletionStrategy string
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    Description string
    The description of the cloud identity user provisioning.
    DuplicationStrategy string
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    DuplicationSuffix string
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    IdentitySourceStrategy string
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    PolicyName string
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    PrincipalId string
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    PrincipalName string
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    PrincipalType string
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    ProvisionStatus string
    The status of the cloud identity user provisioning.
    TargetId string
    The target account id of the cloud identity user provisioning.
    deletionStrategy String
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    description String
    The description of the cloud identity user provisioning.
    duplicationStrategy String
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    duplicationSuffix String
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    identitySourceStrategy String
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    policyName String
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    principalId String
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principalName String
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    principalType String
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    provisionStatus String
    The status of the cloud identity user provisioning.
    targetId String
    The target account id of the cloud identity user provisioning.
    deletionStrategy string
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    description string
    The description of the cloud identity user provisioning.
    duplicationStrategy string
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    duplicationSuffix string
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    identitySourceStrategy string
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    policyName string
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    principalId string
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principalName string
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    principalType string
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    provisionStatus string
    The status of the cloud identity user provisioning.
    targetId string
    The target account id of the cloud identity user provisioning.
    deletion_strategy str
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    description str
    The description of the cloud identity user provisioning.
    duplication_strategy str
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    duplication_suffix str
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    identity_source_strategy str
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    policy_name str
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    principal_id str
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principal_name str
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    principal_type str
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    provision_status str
    The status of the cloud identity user provisioning.
    target_id str
    The target account id of the cloud identity user provisioning.
    deletionStrategy String
    The deletion strategy of the cloud identity user provisioning. Valid values: Keep, Delete.
    description String
    The description of the cloud identity user provisioning.
    duplicationStrategy String
    The duplication strategy of the cloud identity user provisioning. Valid values: KeepBoth, Takeover.
    duplicationSuffix String
    The duplication suffix of the cloud identity user provisioning. When the duplication_strategy is KeepBoth, this field must be specified.
    identitySourceStrategy String
    The identity source strategy of the cloud identity user provisioning. Valid values: Create, Ignore.
    policyName String
    A list of policy name. Valid values: AdministratorAccess. This field is valid when the principal_type is User.
    principalId String
    The principal id of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserId. When the principal_type is Group, this field is specified to GroupId.
    principalName String
    The principal name of the cloud identity user provisioning. When the principal_type is User, this field is specified to UserName. When the principal_type is Group, this field is specified to GroupName.
    principalType String
    The principal type of the cloud identity user provisioning. Valid values: User, Group.
    provisionStatus String
    The status of the cloud identity user provisioning.
    targetId String
    The target account id of the cloud identity user provisioning.

    Import

    CloudIdentityUserProvisioning can be imported using the id, e.g.

     $ pulumi import volcengine:cloud_identity/userProvisioning:UserProvisioning default resource_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
    volcengine/pulumi-volcengine