AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateUserPoolInput

import "github.com/aws/aws-sdk-go/service/cognitoidentityprovider"

type CreateUserPoolInput struct { AdminCreateUserConfig *AdminCreateUserConfigType `type:"structure"` AliasAttributes []*string `type:"list"` AutoVerifiedAttributes []*string `type:"list"` DeviceConfiguration *DeviceConfigurationType `type:"structure"` EmailConfiguration *EmailConfigurationType `type:"structure"` EmailVerificationMessage *string `min:"6" type:"string"` EmailVerificationSubject *string `min:"1" type:"string"` LambdaConfig *LambdaConfigType `type:"structure"` MfaConfiguration *string `type:"string" enum:"UserPoolMfaType"` Policies *UserPoolPolicyType `type:"structure"` PoolName *string `min:"1" type:"string" required:"true"` Schema []*SchemaAttributeType `min:"1" type:"list"` SmsAuthenticationMessage *string `min:"6" type:"string"` SmsConfiguration *SmsConfigurationType `type:"structure"` SmsVerificationMessage *string `min:"6" type:"string"` UserPoolAddOns *UserPoolAddOnsType `type:"structure"` UserPoolTags map[string]*string `type:"map"` UsernameAttributes []*string `type:"list"` VerificationMessageTemplate *VerificationMessageTemplateType `type:"structure"` }

Represents the request to create a user pool.

AdminCreateUserConfig

The configuration for creating a new user profile.

AliasAttributes

Type: []*string

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

AutoVerifiedAttributes

Type: []*string

The attributes to be auto-verified. Possible values: email, phone_number.

DeviceConfiguration

The configuration for the user pool's device tracking.

EmailConfiguration

The email configuration type.

EmailVerificationMessage

Type: *string

A string representing the email verification message.

EmailVerificationSubject

Type: *string

A string representing the email verification subject.

LambdaConfig

Specifies the configuration for AWS Lambda triggers.

MfaConfiguration

Type: *string

Specifies MFA configuration details.

Policies

The policy associated with a user pool.

PoolName

Type: *string

A string used to name the user pool.

PoolName is a required field

Schema

Contains information about the schema attribute.

SmsAuthenticationMessage

Type: *string

A string representing the SMS authentication message.

SmsConfiguration

The SMS configuration type.

SmsVerificationMessage

Type: *string

A string representing the SMS verification message.

UserPoolAddOns

The user pool add-ons type.

UserPoolTags

Type: map[string]*string

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html)

UsernameAttributes

Type: []*string

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

VerificationMessageTemplate

The template for verification messages.

Method

GoString

func (s CreateUserPoolInput) GoString() string

GoString returns the string representation

SetAdminCreateUserConfig

func (s *CreateUserPoolInput) SetAdminCreateUserConfig(v *AdminCreateUserConfigType) *CreateUserPoolInput

SetAdminCreateUserConfig sets the AdminCreateUserConfig field's value.

SetAliasAttributes

func (s *CreateUserPoolInput) SetAliasAttributes(v []*string) *CreateUserPoolInput

SetAliasAttributes sets the AliasAttributes field's value.

SetAutoVerifiedAttributes

func (s *CreateUserPoolInput) SetAutoVerifiedAttributes(v []*string) *CreateUserPoolInput

SetAutoVerifiedAttributes sets the AutoVerifiedAttributes field's value.

SetDeviceConfiguration

func (s *CreateUserPoolInput) SetDeviceConfiguration(v *DeviceConfigurationType) *CreateUserPoolInput

SetDeviceConfiguration sets the DeviceConfiguration field's value.

SetEmailConfiguration

func (s *CreateUserPoolInput) SetEmailConfiguration(v *EmailConfigurationType) *CreateUserPoolInput

SetEmailConfiguration sets the EmailConfiguration field's value.

SetEmailVerificationMessage

func (s *CreateUserPoolInput) SetEmailVerificationMessage(v string) *CreateUserPoolInput

SetEmailVerificationMessage sets the EmailVerificationMessage field's value.

SetEmailVerificationSubject

func (s *CreateUserPoolInput) SetEmailVerificationSubject(v string) *CreateUserPoolInput

SetEmailVerificationSubject sets the EmailVerificationSubject field's value.

SetLambdaConfig

func (s *CreateUserPoolInput) SetLambdaConfig(v *LambdaConfigType) *CreateUserPoolInput

SetLambdaConfig sets the LambdaConfig field's value.

SetMfaConfiguration

func (s *CreateUserPoolInput) SetMfaConfiguration(v string) *CreateUserPoolInput

SetMfaConfiguration sets the MfaConfiguration field's value.

SetPolicies

func (s *CreateUserPoolInput) SetPolicies(v *UserPoolPolicyType) *CreateUserPoolInput

SetPolicies sets the Policies field's value.

SetPoolName

func (s *CreateUserPoolInput) SetPoolName(v string) *CreateUserPoolInput

SetPoolName sets the PoolName field's value.

SetSchema

func (s *CreateUserPoolInput) SetSchema(v []*SchemaAttributeType) *CreateUserPoolInput

SetSchema sets the Schema field's value.

SetSmsAuthenticationMessage

func (s *CreateUserPoolInput) SetSmsAuthenticationMessage(v string) *CreateUserPoolInput

SetSmsAuthenticationMessage sets the SmsAuthenticationMessage field's value.

SetSmsConfiguration

func (s *CreateUserPoolInput) SetSmsConfiguration(v *SmsConfigurationType) *CreateUserPoolInput

SetSmsConfiguration sets the SmsConfiguration field's value.

SetSmsVerificationMessage

func (s *CreateUserPoolInput) SetSmsVerificationMessage(v string) *CreateUserPoolInput

SetSmsVerificationMessage sets the SmsVerificationMessage field's value.

SetUserPoolAddOns

func (s *CreateUserPoolInput) SetUserPoolAddOns(v *UserPoolAddOnsType) *CreateUserPoolInput

SetUserPoolAddOns sets the UserPoolAddOns field's value.

SetUserPoolTags

func (s *CreateUserPoolInput) SetUserPoolTags(v map[string]*string) *CreateUserPoolInput

SetUserPoolTags sets the UserPoolTags field's value.

SetUsernameAttributes

func (s *CreateUserPoolInput) SetUsernameAttributes(v []*string) *CreateUserPoolInput

SetUsernameAttributes sets the UsernameAttributes field's value.

SetVerificationMessageTemplate

func (s *CreateUserPoolInput) SetVerificationMessageTemplate(v *VerificationMessageTemplateType) *CreateUserPoolInput

SetVerificationMessageTemplate sets the VerificationMessageTemplate field's value.

String

func (s CreateUserPoolInput) String() string

String returns the string representation

Validate

func (s *CreateUserPoolInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: