Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplifybackend ]

update-backend-auth

Description

Updates an existing backend authentication resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-backend-auth
--app-id <value>
--backend-environment-name <value>
--resource-config <value>
--resource-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The app ID.

--backend-environment-name (string)

The name of the backend environment.

--resource-config (structure)

The resource configuration for this request object.

AuthResources -> (string)

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

IdentityPoolConfigs -> (structure)

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

UnauthenticatedLogin -> (boolean)

A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.

Service -> (string)

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

UserPoolConfigs -> (structure)

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

ForgotPassword -> (structure)

Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

DeliveryMethod -> (string)

Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

EmailSettings -> (structure)

The configuration for the email sent when an app user forgets their password.

EmailMessage -> (string)

The body of the email.

EmailSubject -> (string)

The subject of the email.

SmsSettings -> (structure)

The configuration for the SMS message sent when an Amplify app user forgets their password.

SmsMessage -> (string)

The body of the SMS message.

Mfa -> (structure)

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

MFAMode -> (string)

The MFA mode for the backend of your Amplify project.

Settings -> (structure)

The settings of your MFA configuration for the backend of your Amplify project.

MfaTypes -> (list)

The supported MFA types.

(string)

SmsMessage -> (string)

The body of the SMS message.

OAuth -> (structure)

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

DomainPrefix -> (string)

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

OAuthGrantType -> (string)

The OAuth grant type to allow app users to authenticate from your Amplify app.

OAuthScopes -> (list)

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

(string)

RedirectSignInURIs -> (list)

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

(string)

RedirectSignOutURIs -> (list)

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

(string)

SocialProviderSettings -> (structure)

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

Facebook -> (structure)

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

ClientId -> (string)

Describes the client_id, which can be obtained from the third-party social federation provider.

ClientSecret -> (string)

Describes the client_secret, which can be obtained from third-party social federation providers.

Google -> (structure)

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

ClientId -> (string)

Describes the client_id, which can be obtained from the third-party social federation provider.

ClientSecret -> (string)

Describes the client_secret, which can be obtained from third-party social federation providers.

LoginWithAmazon -> (structure)

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

ClientId -> (string)

Describes the client_id, which can be obtained from the third-party social federation provider.

ClientSecret -> (string)

Describes the client_secret, which can be obtained from third-party social federation providers.

SignInWithApple -> (structure)

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

ClientId -> (string)

Describes the client_id (also called Services ID) that comes from Apple.

KeyId -> (string)

Describes the key_id that comes from Apple.

PrivateKey -> (string)

Describes the private_key that comes from Apple.

TeamId -> (string)

Describes the team_id that comes from Apple.

PasswordPolicy -> (structure)

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

AdditionalConstraints -> (list)

Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.

(string)

MinimumLength -> (double)

Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.

JSON Syntax:

{
  "AuthResources": "USER_POOL_ONLY"|"IDENTITY_POOL_AND_USER_POOL",
  "IdentityPoolConfigs": {
    "UnauthenticatedLogin": true|false
  },
  "Service": "COGNITO",
  "UserPoolConfigs": {
    "ForgotPassword": {
      "DeliveryMethod": "EMAIL"|"SMS",
      "EmailSettings": {
        "EmailMessage": "string",
        "EmailSubject": "string"
      },
      "SmsSettings": {
        "SmsMessage": "string"
      }
    },
    "Mfa": {
      "MFAMode": "ON"|"OFF"|"OPTIONAL",
      "Settings": {
        "MfaTypes": ["SMS"|"TOTP", ...],
        "SmsMessage": "string"
      }
    },
    "OAuth": {
      "DomainPrefix": "string",
      "OAuthGrantType": "CODE"|"IMPLICIT",
      "OAuthScopes": ["PHONE"|"EMAIL"|"OPENID"|"PROFILE"|"AWS_COGNITO_SIGNIN_USER_ADMIN", ...],
      "RedirectSignInURIs": ["string", ...],
      "RedirectSignOutURIs": ["string", ...],
      "SocialProviderSettings": {
        "Facebook": {
          "ClientId": "string",
          "ClientSecret": "string"
        },
        "Google": {
          "ClientId": "string",
          "ClientSecret": "string"
        },
        "LoginWithAmazon": {
          "ClientId": "string",
          "ClientSecret": "string"
        },
        "SignInWithApple": {
          "ClientId": "string",
          "KeyId": "string",
          "PrivateKey": "string",
          "TeamId": "string"
        }
      }
    },
    "PasswordPolicy": {
      "AdditionalConstraints": ["REQUIRE_DIGIT"|"REQUIRE_LOWERCASE"|"REQUIRE_SYMBOL"|"REQUIRE_UPPERCASE", ...],
      "MinimumLength": double
    }
  }
}

--resource-name (string)

The name of this resource.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AppId -> (string)

The app ID.

BackendEnvironmentName -> (string)

The name of the backend environment.

Error -> (string)

If the request fails, this error is returned.

JobId -> (string)

The ID for the job.

Operation -> (string)

The name of the operation.

Status -> (string)

The current status of the request.