You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::UpdateUserPoolRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass UpdateUserPoolRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  policies: {
    password_policy: {
      minimum_length: 1,
      require_uppercase: false,
      require_lowercase: false,
      require_numbers: false,
      require_symbols: false,
    },
  },
  lambda_config: {
    pre_sign_up: "ArnType",
    custom_message: "ArnType",
    post_confirmation: "ArnType",
    pre_authentication: "ArnType",
    post_authentication: "ArnType",
    define_auth_challenge: "ArnType",
    create_auth_challenge: "ArnType",
    verify_auth_challenge_response: "ArnType",
    pre_token_generation: "ArnType",
    user_migration: "ArnType",
  },
  auto_verified_attributes: ["phone_number"], # accepts phone_number, email
  sms_verification_message: "SmsVerificationMessageType",
  email_verification_message: "EmailVerificationMessageType",
  email_verification_subject: "EmailVerificationSubjectType",
  verification_message_template: {
    sms_message: "SmsVerificationMessageType",
    email_message: "EmailVerificationMessageType",
    email_subject: "EmailVerificationSubjectType",
    email_message_by_link: "EmailVerificationMessageByLinkType",
    email_subject_by_link: "EmailVerificationSubjectByLinkType",
    default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
  },
  sms_authentication_message: "SmsVerificationMessageType",
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
  device_configuration: {
    challenge_required_on_new_device: false,
    device_only_remembered_on_user_prompt: false,
  },
  email_configuration: {
    source_arn: "ArnType",
    reply_to_email_address: "EmailAddressType",
  },
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
  },
  user_pool_tags: {
    "StringType" => "StringType",
  },
  admin_create_user_config: {
    allow_admin_create_user_only: false,
    unused_account_validity_days: 1,
    invite_message_template: {
      sms_message: "SmsVerificationMessageType",
      email_message: "EmailVerificationMessageType",
      email_subject: "EmailVerificationSubjectType",
    },
  },
  user_pool_add_ons: {
    advanced_security_mode: "OFF", # required, accepts OFF, AUDIT, ENFORCED
  },
}

Represents the request to update the user pool.

Instance Attribute Summary collapse

Instance Attribute Details

#admin_create_user_configTypes::AdminCreateUserConfigType

The configuration for AdminCreateUser requests.



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#auto_verified_attributesArray<String>

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Returns:

  • (Array<String>)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#device_configurationTypes::DeviceConfigurationType

Device configuration.



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#email_configurationTypes::EmailConfigurationType

Email configuration.



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#email_verification_messageString

The contents of the email verification message.

Returns:

  • (String)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#email_verification_subjectString

The subject of the email verification message.

Returns:

  • (String)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#lambda_configTypes::LambdaConfigType

The AWS Lambda configuration information from the request to update the user pool.



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#mfa_configurationString

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.

Returns:

  • (String)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#policiesTypes::UserPoolPolicyType

A container with the policies you wish to update in a user pool.



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#sms_authentication_messageString

The contents of the SMS authentication message.

Returns:

  • (String)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#sms_configurationTypes::SmsConfigurationType

SMS configuration.



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#sms_verification_messageString

A container with information about the SMS verification message.

Returns:

  • (String)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#user_pool_add_onsTypes::UserPoolAddOnsType

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#user_pool_idString

The user pool ID for the user pool you want to update.

Returns:

  • (String)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#user_pool_tagsHash<String,String>

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Returns:

  • (Hash<String,String>)


6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end

#verification_message_templateTypes::VerificationMessageTemplateType

The template for verification messages.



6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6990

class UpdateUserPoolRequest < Struct.new(
  :user_pool_id,
  :policies,
  :lambda_config,
  :auto_verified_attributes,
  :sms_verification_message,
  :email_verification_message,
  :email_verification_subject,
  :verification_message_template,
  :sms_authentication_message,
  :mfa_configuration,
  :device_configuration,
  :email_configuration,
  :sms_configuration,
  :user_pool_tags,
  :admin_create_user_config,
  :user_pool_add_ons)
  include Aws::Structure
end