AWS Native is in preview. AWS Classic is fully supported.
aws-native.cognito.UserPoolUser
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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:
- User
Pool stringId - Client
Metadata Dictionary<string, string> - Desired
Delivery List<string>Mediums - Force
Alias boolCreation - Message
Action string - User
Attributes List<Pulumi.Aws Native. Cognito. Inputs. User Pool User Attribute Type> - Username string
- Validation
Data List<Pulumi.Aws Native. Cognito. Inputs. User Pool User Attribute Type>
- User
Pool stringId - Client
Metadata map[string]string - Desired
Delivery []stringMediums - Force
Alias boolCreation - Message
Action string - User
Attributes []UserPool User Attribute Type Args - Username string
- Validation
Data []UserPool User Attribute Type Args
- user
Pool StringId - client
Metadata Map<String,String> - desired
Delivery List<String>Mediums - force
Alias BooleanCreation - message
Action String - user
Attributes List<UserPool User Attribute Type> - username String
- validation
Data List<UserPool User Attribute Type>
- user
Pool stringId - client
Metadata {[key: string]: string} - desired
Delivery string[]Mediums - force
Alias booleanCreation - message
Action string - user
Attributes UserPool User Attribute Type[] - username string
- validation
Data UserPool User Attribute Type[]
- user_
pool_ strid - client_
metadata Mapping[str, str] - desired_
delivery_ Sequence[str]mediums - force_
alias_ boolcreation - message_
action str - user_
attributes Sequence[UserPool User Attribute Type Args] - username str
- validation_
data Sequence[UserPool User Attribute Type Args]
- user
Pool StringId - client
Metadata Map<String> - desired
Delivery List<String>Mediums - force
Alias BooleanCreation - message
Action String - user
Attributes List<Property Map> - username String
- validation
Data List<Property Map>
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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.