Class CfnUserPoolUser

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:59.486Z") @Stability(Stable) public class CfnUserPoolUser extends CfnResource implements IInspectable
The AWS::Cognito::UserPoolUser resource creates an Amazon Cognito user pool user.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolUser cfnUserPoolUser = CfnUserPoolUser.Builder.create(this, "MyCfnUserPoolUser")
         .userPoolId("userPoolId")
         // the properties below are optional
         .clientMetadata(Map.of(
                 "clientMetadataKey", "clientMetadata"))
         .desiredDeliveryMediums(List.of("desiredDeliveryMediums"))
         .forceAliasCreation(false)
         .messageAction("messageAction")
         .userAttributes(List.of(AttributeTypeProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .username("username")
         .validationData(List.of(AttributeTypeProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .build();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnUserPoolUser

      protected CfnUserPoolUser(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnUserPoolUser

      protected CfnUserPoolUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnUserPoolUser

      @Stability(Stable) public CfnUserPoolUser(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolUserProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID for the user pool where the user will be created.
    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID for the user pool where the user will be created.
    • getClientMetadata

      @Stability(Stable) @Nullable public Object getClientMetadata()
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    • setClientMetadata

      @Stability(Stable) public void setClientMetadata(@Nullable IResolvable value)
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    • setClientMetadata

      @Stability(Stable) public void setClientMetadata(@Nullable Map<String,String> value)
      A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
    • getDesiredDeliveryMediums

      @Stability(Stable) @Nullable public List<String> getDesiredDeliveryMediums()
      Specify "EMAIL" if email will be used to send the welcome message.
    • setDesiredDeliveryMediums

      @Stability(Stable) public void setDesiredDeliveryMediums(@Nullable List<String> value)
      Specify "EMAIL" if email will be used to send the welcome message.
    • getForceAliasCreation

      @Stability(Stable) @Nullable public Object getForceAliasCreation()
      This parameter is used only if the phone_number_verified or email_verified attribute is set to True .
    • setForceAliasCreation

      @Stability(Stable) public void setForceAliasCreation(@Nullable Boolean value)
      This parameter is used only if the phone_number_verified or email_verified attribute is set to True .
    • setForceAliasCreation

      @Stability(Stable) public void setForceAliasCreation(@Nullable IResolvable value)
      This parameter is used only if the phone_number_verified or email_verified attribute is set to True .
    • getMessageAction

      @Stability(Stable) @Nullable public String getMessageAction()
      Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
    • setMessageAction

      @Stability(Stable) public void setMessageAction(@Nullable String value)
      Set to RESEND to resend the invitation message to a user that already exists and reset the expiration limit on the user's account.
    • getUserAttributes

      @Stability(Stable) @Nullable public Object getUserAttributes()
      An array of name-value pairs that contain user attributes and attribute values.
    • setUserAttributes

      @Stability(Stable) public void setUserAttributes(@Nullable IResolvable value)
      An array of name-value pairs that contain user attributes and attribute values.
    • setUserAttributes

      @Stability(Stable) public void setUserAttributes(@Nullable List<Object> value)
      An array of name-value pairs that contain user attributes and attribute values.
    • getUsername

      @Stability(Stable) @Nullable public String getUsername()
      The value that you want to set as the username sign-in attribute.
    • setUsername

      @Stability(Stable) public void setUsername(@Nullable String value)
      The value that you want to set as the username sign-in attribute.
    • getValidationData

      @Stability(Stable) @Nullable public Object getValidationData()
      Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
    • setValidationData

      @Stability(Stable) public void setValidationData(@Nullable IResolvable value)
      Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.
    • setValidationData

      @Stability(Stable) public void setValidationData(@Nullable List<Object> value)
      Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger.