1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. UserPoolUser

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.cognito.UserPoolUser

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource Type definition for AWS::Cognito::UserPoolUser

    Create UserPoolUser Resource

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

    Constructor syntax

    new UserPoolUser(name: string, args: UserPoolUserArgs, opts?: CustomResourceOptions);
    @overload
    def UserPoolUser(resource_name: str,
                     args: UserPoolUserArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserPoolUser(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     user_pool_id: Optional[str] = None,
                     client_metadata: Optional[Mapping[str, str]] = None,
                     desired_delivery_mediums: Optional[Sequence[str]] = None,
                     force_alias_creation: Optional[bool] = None,
                     message_action: Optional[str] = None,
                     user_attributes: Optional[Sequence[UserPoolUserAttributeTypeArgs]] = None,
                     username: Optional[str] = None,
                     validation_data: Optional[Sequence[UserPoolUserAttributeTypeArgs]] = None)
    func NewUserPoolUser(ctx *Context, name string, args UserPoolUserArgs, opts ...ResourceOption) (*UserPoolUser, error)
    public UserPoolUser(string name, UserPoolUserArgs args, CustomResourceOptions? opts = null)
    public UserPoolUser(String name, UserPoolUserArgs args)
    public UserPoolUser(String name, UserPoolUserArgs args, CustomResourceOptions options)
    
    type: aws-native:cognito:UserPoolUser
    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 UserPoolUserArgs
    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 UserPoolUserArgs
    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 UserPoolUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPoolUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPoolUserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const userPoolUserResource = new aws_native.cognito.UserPoolUser("userPoolUserResource", {
        userPoolId: "string",
        clientMetadata: {
            string: "string",
        },
        desiredDeliveryMediums: ["string"],
        forceAliasCreation: false,
        messageAction: "string",
        userAttributes: [{
            name: "string",
            value: "string",
        }],
        username: "string",
        validationData: [{
            name: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserPoolUser 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.

    Supporting Types

    UserPoolUserAttributeType, UserPoolUserAttributeTypeArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi