Class: Aws::AmplifyBackend::Types::CreateBackendAuthResourceConfig

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

Overview

Note:

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

{
  auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
  identity_pool_configs: {
    identity_pool_name: "__string", # required
    unauthenticated_login: false, # required
  },
  service: "COGNITO", # required, accepts COGNITO
  user_pool_configs: { # required
    forgot_password: {
      delivery_method: "EMAIL", # required, accepts EMAIL, SMS
      email_settings: {
        email_message: "__string",
        email_subject: "__string",
      },
      sms_settings: {
        sms_message: "__string",
      },
    },
    mfa: {
      mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
      settings: {
        mfa_types: ["SMS"], # accepts SMS, TOTP
        sms_message: "__string",
      },
    },
    o_auth: {
      domain_prefix: "__string",
      o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
      o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
      redirect_sign_in_ur_is: ["__string"], # required
      redirect_sign_out_ur_is: ["__string"], # required
      social_provider_settings: {
        facebook: {
          client_id: "__string",
          client_secret: "__string",
        },
        google: {
          client_id: "__string",
          client_secret: "__string",
        },
        login_with_amazon: {
          client_id: "__string",
          client_secret: "__string",
        },
        sign_in_with_apple: {
          client_id: "__string",
          key_id: "__string",
          private_key: "__string",
          team_id: "__string",
        },
      },
    },
    password_policy: {
      additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
      minimum_length: 1.0, # required
    },
    required_sign_up_attributes: ["ADDRESS"], # required, accepts ADDRESS, BIRTHDATE, EMAIL, FAMILY_NAME, GENDER, GIVEN_NAME, LOCALE, MIDDLE_NAME, NAME, NICKNAME, PHONE_NUMBER, PICTURE, PREFERRED_USERNAME, PROFILE, UPDATED_AT, WEBSITE, ZONE_INFO
    sign_in_method: "EMAIL", # required, accepts EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME
    user_pool_name: "__string", # required
  },
}

Defines the resource configuration when creating an auth resource in your Amplify project.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_resourcesString

Defines whether you want to configure only authentication or both authentication and authorization settings.

Returns:

  • (String)


1218
1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1218

class CreateBackendAuthResourceConfig < Struct.new(
  :auth_resources,
  :identity_pool_configs,
  :service,
  :user_pool_configs)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_configsTypes::CreateBackendAuthIdentityPoolConfig

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.



1218
1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1218

class CreateBackendAuthResourceConfig < Struct.new(
  :auth_resources,
  :identity_pool_configs,
  :service,
  :user_pool_configs)
  SENSITIVE = []
  include Aws::Structure
end

#serviceString

Defines the service name to use when configuring an authentication resource in your Amplify project.

Returns:

  • (String)


1218
1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1218

class CreateBackendAuthResourceConfig < Struct.new(
  :auth_resources,
  :identity_pool_configs,
  :service,
  :user_pool_configs)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_configsTypes::CreateBackendAuthUserPoolConfig

Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.



1218
1219
1220
1221
1222
1223
1224
1225
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/types.rb', line 1218

class CreateBackendAuthResourceConfig < Struct.new(
  :auth_resources,
  :identity_pool_configs,
  :service,
  :user_pool_configs)
  SENSITIVE = []
  include Aws::Structure
end