public static interface UserPoolType.Builder extends SdkPojo, CopyableBuilder<UserPoolType.Builder,UserPoolType>
| Modifier and Type | Method and Description |
|---|---|
UserPoolType.Builder |
adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
default UserPoolType.Builder |
adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
UserPoolType.Builder |
aliasAttributes(AliasAttributeType... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType.Builder |
aliasAttributes(Collection<AliasAttributeType> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType.Builder |
aliasAttributesWithStrings(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType.Builder |
aliasAttributesWithStrings(String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType.Builder |
arn(String arn)
The Amazon Resource Name (ARN) for the user pool.
|
UserPoolType.Builder |
autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType.Builder |
autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType.Builder |
autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType.Builder |
autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType.Builder |
creationDate(Instant creationDate)
The date the user pool was created.
|
UserPoolType.Builder |
customDomain(String customDomain)
A custom domain name that you provide to Amazon Cognito.
|
default UserPoolType.Builder |
deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
The device configuration.
|
UserPoolType.Builder |
deviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
|
UserPoolType.Builder |
domain(String domain)
Holds the domain prefix if the user pool has a domain associated with it.
|
default UserPoolType.Builder |
emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)
The email configuration.
|
UserPoolType.Builder |
emailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
|
UserPoolType.Builder |
emailConfigurationFailure(String emailConfigurationFailure)
The reason why the email configuration cannot send the messages to your users.
|
UserPoolType.Builder |
emailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
|
UserPoolType.Builder |
emailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
|
UserPoolType.Builder |
estimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
UserPoolType.Builder |
id(String id)
The ID of the user pool.
|
default UserPoolType.Builder |
lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
The AWS Lambda triggers associated with the user pool.
|
UserPoolType.Builder |
lambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda triggers associated with the user pool.
|
UserPoolType.Builder |
lastModifiedDate(Instant lastModifiedDate)
The date the user pool was last modified.
|
UserPoolType.Builder |
mfaConfiguration(String mfaConfiguration)
Can be one of the following values:
|
UserPoolType.Builder |
mfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UserPoolType.Builder |
name(String name)
The name of the user pool.
|
default UserPoolType.Builder |
policies(Consumer<UserPoolPolicyType.Builder> policies)
The policies associated with the user pool.
|
UserPoolType.Builder |
policies(UserPoolPolicyType policies)
The policies associated with the user pool.
|
UserPoolType.Builder |
schemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType.Builder |
schemaAttributes(Consumer<SchemaAttributeType.Builder>... schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType.Builder |
schemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType.Builder |
smsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
default UserPoolType.Builder |
smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)
The SMS configuration.
|
UserPoolType.Builder |
smsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
|
UserPoolType.Builder |
smsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration cannot send the messages to your users.
|
UserPoolType.Builder |
smsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
|
UserPoolType.Builder |
status(StatusType status)
The status of a user pool.
|
UserPoolType.Builder |
status(String status)
The status of a user pool.
|
UserPoolType.Builder |
usernameAttributes(Collection<UsernameAttributeType> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UserPoolType.Builder |
usernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UserPoolType.Builder |
usernameAttributesWithStrings(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UserPoolType.Builder |
usernameAttributesWithStrings(String... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
default UserPoolType.Builder |
userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)
The user pool add-ons.
|
UserPoolType.Builder |
userPoolAddOns(UserPoolAddOnsType userPoolAddOns)
The user pool add-ons.
|
UserPoolType.Builder |
userPoolTags(Map<String,String> userPoolTags)
The tags that are assigned to the user pool.
|
default UserPoolType.Builder |
verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
The template for verification messages.
|
UserPoolType.Builder |
verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildUserPoolType.Builder id(String id)
The ID of the user pool.
id - The ID of the user pool.UserPoolType.Builder name(String name)
The name of the user pool.
name - The name of the user pool.UserPoolType.Builder policies(UserPoolPolicyType policies)
The policies associated with the user pool.
policies - The policies associated with the user pool.default UserPoolType.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)
The policies associated with the user pool.
This is a convenience that creates an instance of theUserPoolPolicyType.Builder avoiding the need to
create one manually via UserPoolPolicyType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to policies(UserPoolPolicyType).policies - a consumer that will call methods on UserPoolPolicyType.Builderpolicies(UserPoolPolicyType)UserPoolType.Builder lambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda triggers associated with the user pool.
lambdaConfig - The AWS Lambda triggers associated with the user pool.default UserPoolType.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
The AWS Lambda triggers associated with the user pool.
This is a convenience that creates an instance of theLambdaConfigType.Builder avoiding the need to
create one manually via LambdaConfigType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to lambdaConfig(LambdaConfigType).lambdaConfig - a consumer that will call methods on LambdaConfigType.BuilderlambdaConfig(LambdaConfigType)UserPoolType.Builder status(String status)
The status of a user pool.
status - The status of a user pool.StatusType,
StatusTypeUserPoolType.Builder status(StatusType status)
The status of a user pool.
status - The status of a user pool.StatusType,
StatusTypeUserPoolType.Builder lastModifiedDate(Instant lastModifiedDate)
The date the user pool was last modified.
lastModifiedDate - The date the user pool was last modified.UserPoolType.Builder creationDate(Instant creationDate)
The date the user pool was created.
creationDate - The date the user pool was created.UserPoolType.Builder schemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
schemaAttributes - A container with the schema attributes of a user pool.UserPoolType.Builder schemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.
schemaAttributes - A container with the schema attributes of a user pool.UserPoolType.Builder schemaAttributes(Consumer<SchemaAttributeType.Builder>... schemaAttributes)
A container with the schema attributes of a user pool.
This is a convenience that creates an instance of theList.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #schemaAttributes(List) .schemaAttributes - a consumer that will call methods on List.Builder #schemaAttributes(List) UserPoolType.Builder autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.UserPoolType.Builder autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.UserPoolType.Builder autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.UserPoolType.Builder autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.UserPoolType.Builder aliasAttributesWithStrings(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes - Specifies the attributes that are aliased in a user pool.UserPoolType.Builder aliasAttributesWithStrings(String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes - Specifies the attributes that are aliased in a user pool.UserPoolType.Builder aliasAttributes(Collection<AliasAttributeType> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes - Specifies the attributes that are aliased in a user pool.UserPoolType.Builder aliasAttributes(AliasAttributeType... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes - Specifies the attributes that are aliased in a user pool.UserPoolType.Builder usernameAttributesWithStrings(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UserPoolType.Builder usernameAttributesWithStrings(String... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UserPoolType.Builder usernameAttributes(Collection<UsernameAttributeType> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UserPoolType.Builder usernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UserPoolType.Builder smsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
smsVerificationMessage - The contents of the SMS verification message.UserPoolType.Builder emailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage - The contents of the email verification message.UserPoolType.Builder emailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject - The subject of the email verification message.UserPoolType.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
verificationMessageTemplate - The template for verification messages.default UserPoolType.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
The template for verification messages.
This is a convenience that creates an instance of theVerificationMessageTemplateType.Builder
avoiding the need to create one manually via VerificationMessageTemplateType.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to verificationMessageTemplate(VerificationMessageTemplateType)
.verificationMessageTemplate - a consumer that will call methods on VerificationMessageTemplateType.BuilderverificationMessageTemplate(VerificationMessageTemplateType)UserPoolType.Builder smsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage - The contents of the SMS authentication message.UserPoolType.Builder mfaConfiguration(String mfaConfiguration)
Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you
are initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
mfaConfiguration - Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required
when you are initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
UserPoolMfaType,
UserPoolMfaTypeUserPoolType.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required when you
are initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
mfaConfiguration - Can be one of the following values:
OFF - MFA tokens are not required and cannot be specified during user registration.
ON - MFA tokens are required for all user registrations. You can only specify required
when you are initially creating a user pool.
OPTIONAL - Users have the option when registering to create an MFA token.
UserPoolMfaType,
UserPoolMfaTypeUserPoolType.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
deviceConfiguration - The device configuration.default UserPoolType.Builder deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
The device configuration.
This is a convenience that creates an instance of theDeviceConfigurationType.Builder avoiding the
need to create one manually via DeviceConfigurationType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to deviceConfiguration(DeviceConfigurationType).deviceConfiguration - a consumer that will call methods on DeviceConfigurationType.BuilderdeviceConfiguration(DeviceConfigurationType)UserPoolType.Builder estimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers - A number estimating the size of the user pool.UserPoolType.Builder emailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
emailConfiguration - The email configuration.default UserPoolType.Builder emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)
The email configuration.
This is a convenience that creates an instance of theEmailConfigurationType.Builder avoiding the
need to create one manually via EmailConfigurationType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to emailConfiguration(EmailConfigurationType).emailConfiguration - a consumer that will call methods on EmailConfigurationType.BuilderemailConfiguration(EmailConfigurationType)UserPoolType.Builder smsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
smsConfiguration - The SMS configuration.default UserPoolType.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)
The SMS configuration.
This is a convenience that creates an instance of theSmsConfigurationType.Builder avoiding the need
to create one manually via SmsConfigurationType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to smsConfiguration(SmsConfigurationType).smsConfiguration - a consumer that will call methods on SmsConfigurationType.BuildersmsConfiguration(SmsConfigurationType)UserPoolType.Builder userPoolTags(Map<String,String> userPoolTags)
The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
userPoolTags - The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to
categorize and manage them in different ways, such as by purpose, owner, environment, or other
criteria.UserPoolType.Builder smsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration cannot send the messages to your users.
smsConfigurationFailure - The reason why the SMS configuration cannot send the messages to your users.UserPoolType.Builder emailConfigurationFailure(String emailConfigurationFailure)
The reason why the email configuration cannot send the messages to your users.
emailConfigurationFailure - The reason why the email configuration cannot send the messages to your users.UserPoolType.Builder domain(String domain)
Holds the domain prefix if the user pool has a domain associated with it.
domain - Holds the domain prefix if the user pool has a domain associated with it.UserPoolType.Builder customDomain(String customDomain)
A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom
domain to host the sign-up and sign-in pages for your application. For example: auth.example.com
.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
customDomain - A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a
custom domain to host the sign-up and sign-in pages for your application. For example:
auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
UserPoolType.Builder adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser requests.
adminCreateUserConfig - The configuration for AdminCreateUser requests.default UserPoolType.Builder adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
The configuration for AdminCreateUser requests.
AdminCreateUserConfigType.Builder avoiding the
need to create one manually via AdminCreateUserConfigType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to adminCreateUserConfig(AdminCreateUserConfigType).adminCreateUserConfig - a consumer that will call methods on AdminCreateUserConfigType.BuilderadminCreateUserConfig(AdminCreateUserConfigType)UserPoolType.Builder userPoolAddOns(UserPoolAddOnsType userPoolAddOns)
The user pool add-ons.
userPoolAddOns - The user pool add-ons.default UserPoolType.Builder userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)
The user pool add-ons.
This is a convenience that creates an instance of theUserPoolAddOnsType.Builder avoiding the need to
create one manually via UserPoolAddOnsType.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to userPoolAddOns(UserPoolAddOnsType).userPoolAddOns - a consumer that will call methods on UserPoolAddOnsType.BuilderuserPoolAddOns(UserPoolAddOnsType)UserPoolType.Builder arn(String arn)
The Amazon Resource Name (ARN) for the user pool.
arn - The Amazon Resource Name (ARN) for the user pool.Copyright © 2019. All rights reserved.