1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. cloudsso
  5. UserAttachment
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

alicloud.cloudsso.UserAttachment

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

    Provides a Cloud SSO User Attachment resource.

    For information about Cloud SSO User Attachment and how to use it, see What is User Attachment.

    NOTE: Available since v1.141.0.

    NOTE: Cloud SSO Only Support cn-shanghai And us-west-1 Region

    Create UserAttachment Resource

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

    Constructor syntax

    new UserAttachment(name: string, args: UserAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def UserAttachment(resource_name: str,
                       args: UserAttachmentArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserAttachment(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       directory_id: Optional[str] = None,
                       group_id: Optional[str] = None,
                       user_id: Optional[str] = None)
    func NewUserAttachment(ctx *Context, name string, args UserAttachmentArgs, opts ...ResourceOption) (*UserAttachment, error)
    public UserAttachment(string name, UserAttachmentArgs args, CustomResourceOptions? opts = null)
    public UserAttachment(String name, UserAttachmentArgs args)
    public UserAttachment(String name, UserAttachmentArgs args, CustomResourceOptions options)
    
    type: alicloud:cloudsso:UserAttachment
    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 UserAttachmentArgs
    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 UserAttachmentArgs
    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 UserAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserAttachmentArgs
    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 alicloudUserAttachmentResource = new AliCloud.CloudSso.UserAttachment("alicloudUserAttachmentResource", new()
    {
        DirectoryId = "string",
        GroupId = "string",
        UserId = "string",
    });
    
    example, err := cloudsso.NewUserAttachment(ctx, "alicloudUserAttachmentResource", &cloudsso.UserAttachmentArgs{
    	DirectoryId: pulumi.String("string"),
    	GroupId:     pulumi.String("string"),
    	UserId:      pulumi.String("string"),
    })
    
    var alicloudUserAttachmentResource = new UserAttachment("alicloudUserAttachmentResource", UserAttachmentArgs.builder()
        .directoryId("string")
        .groupId("string")
        .userId("string")
        .build());
    
    alicloud_user_attachment_resource = alicloud.cloudsso.UserAttachment("alicloudUserAttachmentResource",
        directory_id="string",
        group_id="string",
        user_id="string")
    
    const alicloudUserAttachmentResource = new alicloud.cloudsso.UserAttachment("alicloudUserAttachmentResource", {
        directoryId: "string",
        groupId: "string",
        userId: "string",
    });
    
    type: alicloud:cloudsso:UserAttachment
    properties:
        directoryId: string
        groupId: string
        userId: string
    

    UserAttachment 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 UserAttachment resource accepts the following input properties:

    DirectoryId string
    The ID of the Directory.
    GroupId string
    The Group ID.
    UserId string
    The User ID.
    DirectoryId string
    The ID of the Directory.
    GroupId string
    The Group ID.
    UserId string
    The User ID.
    directoryId String
    The ID of the Directory.
    groupId String
    The Group ID.
    userId String
    The User ID.
    directoryId string
    The ID of the Directory.
    groupId string
    The Group ID.
    userId string
    The User ID.
    directory_id str
    The ID of the Directory.
    group_id str
    The Group ID.
    user_id str
    The User ID.
    directoryId String
    The ID of the Directory.
    groupId String
    The Group ID.
    userId String
    The User ID.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UserAttachment Resource

    Get an existing UserAttachment 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?: UserAttachmentState, opts?: CustomResourceOptions): UserAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            directory_id: Optional[str] = None,
            group_id: Optional[str] = None,
            user_id: Optional[str] = None) -> UserAttachment
    func GetUserAttachment(ctx *Context, name string, id IDInput, state *UserAttachmentState, opts ...ResourceOption) (*UserAttachment, error)
    public static UserAttachment Get(string name, Input<string> id, UserAttachmentState? state, CustomResourceOptions? opts = null)
    public static UserAttachment get(String name, Output<String> id, UserAttachmentState 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:
    DirectoryId string
    The ID of the Directory.
    GroupId string
    The Group ID.
    UserId string
    The User ID.
    DirectoryId string
    The ID of the Directory.
    GroupId string
    The Group ID.
    UserId string
    The User ID.
    directoryId String
    The ID of the Directory.
    groupId String
    The Group ID.
    userId String
    The User ID.
    directoryId string
    The ID of the Directory.
    groupId string
    The Group ID.
    userId string
    The User ID.
    directory_id str
    The ID of the Directory.
    group_id str
    The Group ID.
    user_id str
    The User ID.
    directoryId String
    The ID of the Directory.
    groupId String
    The Group ID.
    userId String
    The User ID.

    Import

    Cloud SSO User Attachment can be imported using the id, e.g.

    $ pulumi import alicloud:cloudsso/userAttachment:UserAttachment example <directory_id>:<group_id>:<user_id>
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi