software.amazon.awscdk.services.cognito

Interface CfnUserPoolUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.632Z")
 @Stability(value=Stable)
public interface CfnUserPoolUserProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::Cognito::UserPoolUser`.

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.*;
 Object clientMetadata;
 CfnUserPoolUserProps cfnUserPoolUserProps = CfnUserPoolUserProps.builder()
         .userPoolId("userPoolId")
         // the properties below are optional
         .clientMetadata(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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUserPoolUserProps.Builder A builder for CfnUserPoolUserProps
static class	CfnUserPoolUserProps.Jsii$Proxy An implementation for CfnUserPoolUserProps

Method Summary

Modifier and Type	Method and Description
static CfnUserPoolUserProps.Builder	builder()
default Object	getClientMetadata() `AWS::Cognito::UserPoolUser.ClientMetadata`.
default List<String>	getDesiredDeliveryMediums() `AWS::Cognito::UserPoolUser.DesiredDeliveryMediums`.
default Object	getForceAliasCreation() `AWS::Cognito::UserPoolUser.ForceAliasCreation`.
default String	getMessageAction() `AWS::Cognito::UserPoolUser.MessageAction`.
default Object	getUserAttributes() `AWS::Cognito::UserPoolUser.UserAttributes`.
default String	getUsername() `AWS::Cognito::UserPoolUser.Username`.
String	getUserPoolId() `AWS::Cognito::UserPoolUser.UserPoolId`.
default Object	getValidationData() `AWS::Cognito::UserPoolUser.ValidationData`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientMetadata

@Stability(value=Stable)
 @Nullable
default Object getClientMetadata()

`AWS::Cognito::UserPoolUser.ClientMetadata`.

getDesiredDeliveryMediums

@Stability(value=Stable)
 @Nullable
default List<String> getDesiredDeliveryMediums()

`AWS::Cognito::UserPoolUser.DesiredDeliveryMediums`.

getForceAliasCreation

@Stability(value=Stable)
 @Nullable
default Object getForceAliasCreation()

`AWS::Cognito::UserPoolUser.ForceAliasCreation`.

getMessageAction

@Stability(value=Stable)
 @Nullable
default String getMessageAction()

`AWS::Cognito::UserPoolUser.MessageAction`.

getUserAttributes

@Stability(value=Stable)
 @Nullable
default Object getUserAttributes()

`AWS::Cognito::UserPoolUser.UserAttributes`.

getUsername

@Stability(value=Stable)
 @Nullable
default String getUsername()

`AWS::Cognito::UserPoolUser.Username`.

getUserPoolId

@Stability(value=Stable)
 @NotNull
String getUserPoolId()

`AWS::Cognito::UserPoolUser.UserPoolId`.

getValidationData

@Stability(value=Stable)
 @Nullable
default Object getValidationData()

`AWS::Cognito::UserPoolUser.ValidationData`.

builder

@Stability(value=Stable)
static CfnUserPoolUserProps.Builder builder()

Returns:

a CfnUserPoolUserProps.Builder of CfnUserPoolUserProps