public static interface CreateUserPoolRequest.Builder extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>
Modifier and Type | Method and Description |
---|---|
CreateUserPoolRequest.Builder |
adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
default CreateUserPoolRequest.Builder |
adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
CreateUserPoolRequest.Builder |
aliasAttributes(Collection<String> aliasAttributes)
Attributes supported as an alias for this user pool.
|
CreateUserPoolRequest.Builder |
aliasAttributes(String... aliasAttributes)
Attributes supported as an alias for this user pool.
|
CreateUserPoolRequest.Builder |
autoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes to be auto-verified.
|
CreateUserPoolRequest.Builder |
autoVerifiedAttributes(String... autoVerifiedAttributes)
The attributes to be auto-verified.
|
default CreateUserPoolRequest.Builder |
deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
The device configuration.
|
CreateUserPoolRequest.Builder |
deviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
|
default CreateUserPoolRequest.Builder |
emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)
The email configuration.
|
CreateUserPoolRequest.Builder |
emailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
|
CreateUserPoolRequest.Builder |
emailVerificationMessage(String emailVerificationMessage)
A string representing the email verification message.
|
CreateUserPoolRequest.Builder |
emailVerificationSubject(String emailVerificationSubject)
A string representing the email verification subject.
|
default CreateUserPoolRequest.Builder |
lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
The Lambda trigger configuration information for the new user pool.
|
CreateUserPoolRequest.Builder |
lambdaConfig(LambdaConfigType lambdaConfig)
The Lambda trigger configuration information for the new user pool.
|
CreateUserPoolRequest.Builder |
mfaConfiguration(String mfaConfiguration)
Specifies MFA configuration details.
|
CreateUserPoolRequest.Builder |
mfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
|
default CreateUserPoolRequest.Builder |
policies(Consumer<UserPoolPolicyType.Builder> policies)
The policies associated with the new user pool.
|
CreateUserPoolRequest.Builder |
policies(UserPoolPolicyType policies)
The policies associated with the new user pool.
|
CreateUserPoolRequest.Builder |
poolName(String poolName)
A string used to name the user pool.
|
CreateUserPoolRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
CreateUserPoolRequest.Builder |
schema(Collection<SchemaAttributeType> schema)
An array of schema attributes for the new user pool.
|
CreateUserPoolRequest.Builder |
schema(SchemaAttributeType... schema)
An array of schema attributes for the new user pool.
|
CreateUserPoolRequest.Builder |
smsAuthenticationMessage(String smsAuthenticationMessage)
A string representing the SMS authentication message.
|
default CreateUserPoolRequest.Builder |
smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)
The SMS configuration.
|
CreateUserPoolRequest.Builder |
smsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
|
CreateUserPoolRequest.Builder |
smsVerificationMessage(String smsVerificationMessage)
A string representing the SMS verification message.
|
CreateUserPoolRequest.Builder |
usernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
CreateUserPoolRequest.Builder |
usernameAttributes(String... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
CreateUserPoolRequest.Builder |
userPoolTags(Map<String,String> userPoolTags)
The cost allocation tags for the user pool.
|
default CreateUserPoolRequest.Builder |
verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the
user's information.
|
CreateUserPoolRequest.Builder |
verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the
user's information.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
CreateUserPoolRequest.Builder poolName(String poolName)
A string used to name the user pool.
poolName
- A string used to name the user pool.CreateUserPoolRequest.Builder policies(UserPoolPolicyType policies)
The policies associated with the new user pool.
policies
- The policies associated with the new user pool.default CreateUserPoolRequest.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)
The policies associated with the new 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.Builder
policies(UserPoolPolicyType)
CreateUserPoolRequest.Builder lambdaConfig(LambdaConfigType lambdaConfig)
The Lambda trigger configuration information for the new user pool.
lambdaConfig
- The Lambda trigger configuration information for the new user pool.default CreateUserPoolRequest.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
The Lambda trigger configuration information for the new 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.Builder
lambdaConfig(LambdaConfigType)
CreateUserPoolRequest.Builder autoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.CreateUserPoolRequest.Builder autoVerifiedAttributes(String... autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.CreateUserPoolRequest.Builder aliasAttributes(Collection<String> aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number,
email, or preferred_username.CreateUserPoolRequest.Builder aliasAttributes(String... aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number,
email, or preferred_username.CreateUserPoolRequest.Builder usernameAttributes(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.CreateUserPoolRequest.Builder usernameAttributes(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.CreateUserPoolRequest.Builder smsVerificationMessage(String smsVerificationMessage)
A string representing the SMS verification message.
smsVerificationMessage
- A string representing the SMS verification message.CreateUserPoolRequest.Builder emailVerificationMessage(String emailVerificationMessage)
A string representing the email verification message.
emailVerificationMessage
- A string representing the email verification message.CreateUserPoolRequest.Builder emailVerificationSubject(String emailVerificationSubject)
A string representing the email verification subject.
emailVerificationSubject
- A string representing the email verification subject.CreateUserPoolRequest.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the user's information.
verificationMessageTemplate
- The template for the verification message that the user sees when the app requests permission to
access the user's information.default CreateUserPoolRequest.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the user's information.
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.Builder
verificationMessageTemplate(VerificationMessageTemplateType)
CreateUserPoolRequest.Builder smsAuthenticationMessage(String smsAuthenticationMessage)
A string representing the SMS authentication message.
smsAuthenticationMessage
- A string representing the SMS authentication message.CreateUserPoolRequest.Builder mfaConfiguration(String mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
,
UserPoolMfaType
CreateUserPoolRequest.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
,
UserPoolMfaType
CreateUserPoolRequest.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
deviceConfiguration
- The device configuration.default CreateUserPoolRequest.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.Builder
deviceConfiguration(DeviceConfigurationType)
CreateUserPoolRequest.Builder emailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
emailConfiguration
- The email configuration.default CreateUserPoolRequest.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.Builder
emailConfiguration(EmailConfigurationType)
CreateUserPoolRequest.Builder smsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
smsConfiguration
- The SMS configuration.default CreateUserPoolRequest.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.Builder
smsConfiguration(SmsConfigurationType)
CreateUserPoolRequest.Builder userPoolTags(Map<String,String> userPoolTags)
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
userPoolTags
- The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User PoolCreateUserPoolRequest.Builder adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser
requests.
adminCreateUserConfig
- The configuration for AdminCreateUser
requests.default CreateUserPoolRequest.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.Builder
adminCreateUserConfig(AdminCreateUserConfigType)
CreateUserPoolRequest.Builder schema(Collection<SchemaAttributeType> schema)
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
schema
- An array of schema attributes for the new user pool. These attributes can be standard or custom
attributes.CreateUserPoolRequest.Builder schema(SchemaAttributeType... schema)
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
schema
- An array of schema attributes for the new user pool. These attributes can be standard or custom
attributes.CreateUserPoolRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.