}, "resourceName": "string",
"backendEnvironmentName": "string"
}
Response bodies
BackendAuthRespObj schema
{ "jobId": "string", "appId": "string", "error": "string", "operation": "string",
"backendEnvironmentName": "string", "status": "string"
}
Properties
BadRequestException schema
{ "message": "string"
}
NotFoundException schema
{ "message": "string", "resourceType": "string"
}
LimitExceededException schema
{
"message": "string", "limitType": "string"
}
InternalServiceException schema
{
"message": "string"
}
Properties
BackendAuthRespObj
The response object for this operation.
jobId
The ID for the job.
Type: string Required: False
appId
The app ID.Type: string Required: True
error
If the request fails, this error is returned.
Type: string
Properties
Required: False
operation
The name of the operation.
Type: string Required: False
backendEnvironmentName
The name of the backend environment.
Type: string Required: True
status
The current status of the request.
Type: string Required: False
BadRequestException
An error returned if a request is not formed properly.
message
An error message to inform that the request failed.
Type: string Required: False
CreateBackendAuthForgotPasswordConfig
Describes the forgot password policy for authenticating into the Amplify app.
smsSettings
The configuration for the SMS message sent when an app user forgets their password.
Type: object Required: False
deliveryMethod
Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
Type: string Required: True Values: EMAIL | SMS
Properties
emailSettings
The configuration for the email sent when an app user forgets their password.
Type: object Required: False
CreateBackendAuthIdentityPoolConfig
Describes authorization configurations for the auth resources, configured as a part of your Amplify project.
identityPoolName
Name of the Amazon Cognito identity pool used for authorization.
Type: string Required: True
unauthenticatedLogin
Set to true or false based on whether you want to enable guest authorization to your Amplify app.
Type: boolean Required: True
CreateBackendAuthMFAConfig
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
MFAMode
Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
Type: string Required: True
Values: ON | OFF | OPTIONAL
settings
Describes the configuration settings and methods for your Amplify app users to use MFA.
Type: object Required: False
CreateBackendAuthOAuthConfig
Creates the OAuth configuration for your Amplify project.
redirectSignOutURIs
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
Type: Array of type string
Properties
Required: True
domainPrefix
The domain prefix for your Amplify app.
Type: string Required: False
redirectSignInURIs
The redirected URI for signing in to your Amplify app.
Type: Array of type string Required: True
oAuthScopes
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
Type: Array of type string Required: True
Values: PHONE | EMAIL | OPENID | PROFILE | AWS_COGNITO_SIGNIN_USER_ADMIN
socialProviderSettings
The settings for using social providers to access your Amplify app.
Type: object Required: False
oAuthGrantType
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
Type: string Required: True
Values: CODE | IMPLICIT
CreateBackendAuthPasswordPolicyConfig
The password policy configuration for the backend to your Amplify project.
minimumLength
The minimum length of the password used to access the backend of your Amplify project.
Type: number Required: True
additionalConstraints
Additional constraints for the password used to access the backend of your Amplify project.
Type: Array of type string
Properties
Required: False
Values: REQUIRE_DIGIT | REQUIRE_LOWERCASE | REQUIRE_SYMBOL | REQUIRE_UPPERCASE
CreateBackendAuthReqObj
The request object for this operation.
resourceConfig
The resource configuration for this request object.
Type: CreateBackendAuthResourceConfig (p. 56) Required: True
resourceName
The name of this resource.
Type: string Required: True
backendEnvironmentName
The name of the backend environment.
Type: string Required: True
CreateBackendAuthResourceConfig
Defines the resource configuration when creating an auth resource in your Amplify project.
userPoolConfigs
Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
Type: CreateBackendAuthUserPoolConfig (p. 57) Required: True
authResources
Defines whether you want to configure only authentication or both authentication and authorization settings.
Type: string Required: True
Values: USER_POOL_ONLY | IDENTITY_POOL_AND_USER_POOL
service
Defines the service name to use when configuring an authentication resource in your Amplify project.
Type: string Required: True
Properties
Values: COGNITO
identityPoolConfigs
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
Type: CreateBackendAuthIdentityPoolConfig (p. 54) Required: False
CreateBackendAuthUserPoolConfig
Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.
userPoolName
The Amazon Cognito user pool name.
Type: string Required: True
forgotPassword
Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
Type: CreateBackendAuthForgotPasswordConfig (p. 53) Required: False
passwordPolicy
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
Type: CreateBackendAuthPasswordPolicyConfig (p. 55) Required: False
requiredSignUpAttributes
The required attributes to sign up new users in the user pool.
Type: Array of type string Required: True
Values: ADDRESS | BIRTHDATE | EMAIL | FAMILY_NAME | GENDER | GIVEN_NAME
| LOCALE | MIDDLE_NAME | NAME | NICKNAME | PHONE_NUMBER | PICTURE | PREFERRED_USERNAME | PROFILE | UPDATED_AT | WEBSITE | ZONE_INFO
mfa
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
Type: CreateBackendAuthMFAConfig (p. 54) Required: False
Properties
oAuth
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
Type: CreateBackendAuthOAuthConfig (p. 54) Required: False
signInMethod
Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
Type: string Required: True
Values: EMAIL | EMAIL_AND_PHONE_NUMBER | PHONE_NUMBER | USERNAME
InternalServiceException
An error returned if there's a temporary issue with the service.
message
An error message to inform that the request failed.
Type: string Required: False
LimitExceededException
An error that is returned when a limit of a specific type has been exceeded.
message
An error message to inform that the request has failed.
Type: string Required: False
limitType
The type of limit that was exceeded.
Type: string Required: False
NotFoundException
An error returned when a specific resource type is not found.
message
An error message to inform that the request has failed.
Type: string
See also
Required: False
resourceType
The type of resource that is not found.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
CreateBackendAuth
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3