AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amplify Backend CreateBackendAuth API operation.

Syntax

New-AMPBBackendAuth
-AppId <String>
-PasswordPolicy_AdditionalConstraint <String[]>
-ResourceConfig_AuthResource <AuthResources>
-BackendEnvironmentName <String>
-Facebook_ClientId <String>
-Google_ClientId <String>
-LoginWithAmazon_ClientId <String>
-SignInWithApple_ClientId <String>
-Facebook_ClientSecret <String>
-Google_ClientSecret <String>
-LoginWithAmazon_ClientSecret <String>
-ForgotPassword_DeliveryMethod <DeliveryMethod>
-VerificationMessage_DeliveryMethod <DeliveryMethod>
-OAuth_DomainPrefix <String>
-ResourceConfig_UserPoolConfigs_ForgotPassword_EmailSettings_EmailMessage <String>
-EmailSettings_EmailMessage <String>
-ResourceConfig_UserPoolConfigs_ForgotPassword_EmailSettings_EmailSubject <String>
-EmailSettings_EmailSubject <String>
-IdentityPoolConfigs_IdentityPoolName <String>
-SignInWithApple_KeyId <String>
-Mfa_MFAMode <MFAMode>
-Settings_MfaType <String[]>
-PasswordPolicy_MinimumLength <Double>
-OAuth_OAuthGrantType <OAuthGrantType>
-OAuth_OAuthScope <String[]>
-SignInWithApple_PrivateKey <String>
-OAuth_RedirectSignInURIs <String[]>
-OAuth_RedirectSignOutURIs <String[]>
-UserPoolConfigs_RequiredSignUpAttribute <String[]>
-ResourceName <String>
-ResourceConfig_Service <Service>
-UserPoolConfigs_SignInMethod <SignInMethod>
-ResourceConfig_UserPoolConfigs_ForgotPassword_SmsSettings_SmsMessage <String>
-Settings_SmsMessage <String>
-SmsSettings_SmsMessage <String>
-SignInWithApple_TeamId <String>
-IdentityPoolConfigs_UnauthenticatedLogin <Boolean>
-UserPoolConfigs_UserPoolName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonAmplifyBackendConfig>

Description

Creates a new backend authentication resource.

Parameters

-AppId <String>
The app ID.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-BackendEnvironmentName <String>
The name of the backend environment.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonAmplifyBackendConfig>
Amazon.PowerShell.Cmdlets.AMPB.AmazonAmplifyBackendClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EmailSettings_EmailMessage <String>
The contents of the email message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_VerificationMessage_EmailSettings_EmailMessage
-EmailSettings_EmailSubject <String>
The contents of the subject line of the email message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_VerificationMessage_EmailSettings_EmailSubject
-Facebook_ClientId <String>
Describes the client_id, which can be obtained from the third-party social federation provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_Facebook_ClientId
-Facebook_ClientSecret <String>
Describes the client_secret, which can be obtained from third-party social federation providers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_Facebook_ClientSecret
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ForgotPassword_DeliveryMethod <DeliveryMethod>
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_ForgotPassword_DeliveryMethod
-Google_ClientId <String>
Describes the client_id, which can be obtained from the third-party social federation provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_Google_ClientId
-Google_ClientSecret <String>
Describes the client_secret, which can be obtained from third-party social federation providers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_Google_ClientSecret
-IdentityPoolConfigs_IdentityPoolName <String>
Name of the Amazon Cognito identity pool used for authorization.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_IdentityPoolConfigs_IdentityPoolName
-IdentityPoolConfigs_UnauthenticatedLogin <Boolean>
Set to true or false based on whether you want to enable guest authorization to your Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_IdentityPoolConfigs_UnauthenticatedLogin
-LoginWithAmazon_ClientId <String>
Describes the client_id, which can be obtained from the third-party social federation provider.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_LoginWithAmazon_ClientId
-LoginWithAmazon_ClientSecret <String>
Describes the client_secret, which can be obtained from third-party social federation providers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_LoginWithAmazon_ClientSecret
-Mfa_MFAMode <MFAMode>
Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_Mfa_MFAMode
-OAuth_DomainPrefix <String>
The domain prefix for your Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_DomainPrefix
-OAuth_OAuthGrantType <OAuthGrantType>
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_OAuthGrantType
-OAuth_OAuthScope <String[]>
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_OAuthScopes
-OAuth_RedirectSignInURIs <String[]>
The redirected URI for signing in to your Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_RedirectSignInURIs
-OAuth_RedirectSignOutURIs <String[]>
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_RedirectSignOutURIs
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AppId parameter. The -PassThru parameter is deprecated, use -Select '^AppId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PasswordPolicy_AdditionalConstraint <String[]>
Additional constraints for the password used to access the backend of your Amplify project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_PasswordPolicy_AdditionalConstraints
-PasswordPolicy_MinimumLength <Double>
The minimum length of the password used to access the backend of your Amplify project.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_PasswordPolicy_MinimumLength
-ResourceConfig_AuthResource <AuthResources>
Defines whether you want to configure only authentication or both authentication and authorization settings.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_AuthResources
-ResourceConfig_Service <Service>
Defines the service name to use when configuring an authentication resource in your Amplify project.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfig_UserPoolConfigs_ForgotPassword_EmailSettings_EmailMessage <String>
The contents of the email message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfig_UserPoolConfigs_ForgotPassword_EmailSettings_EmailSubject <String>
The contents of the subject line of the email message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfig_UserPoolConfigs_ForgotPassword_SmsSettings_SmsMessage <String>
The contents of the SMS message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceName <String>
The name of this resource.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AmplifyBackend.Model.CreateBackendAuthResponse). Specifying the name of a property of type Amazon.AmplifyBackend.Model.CreateBackendAuthResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Settings_MfaType <String[]>
The supported MFA types.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_Mfa_Settings_MfaTypes
-Settings_SmsMessage <String>
The body of the SMS message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_Mfa_Settings_SmsMessage
-SignInWithApple_ClientId <String>
Describes the client_id (also called Services ID) that comes from Apple.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_SignInWithApple_ClientId
-SignInWithApple_KeyId <String>
Describes the key_id that comes from Apple.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_SignInWithApple_KeyId
-SignInWithApple_PrivateKey <String>
Describes the private_key that comes from Apple.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_SignInWithApple_PrivateKey
-SignInWithApple_TeamId <String>
Describes the team_id that comes from Apple.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_OAuth_SocialProviderSettings_SignInWithApple_TeamId
-SmsSettings_SmsMessage <String>
The contents of the SMS message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_VerificationMessage_SmsSettings_SmsMessage
-UserPoolConfigs_RequiredSignUpAttribute <String[]>
The required attributes to sign up new users in the user pool.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_RequiredSignUpAttributes
-UserPoolConfigs_SignInMethod <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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_SignInMethod
-UserPoolConfigs_UserPoolName <String>
The Amazon Cognito user pool name.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_UserPoolName
-VerificationMessage_DeliveryMethod <DeliveryMethod>
The type of verification message to send.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResourceConfig_UserPoolConfigs_VerificationMessage_DeliveryMethod

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.AmplifyBackend.Model.CreateBackendAuthResponse
This cmdlet returns an Amazon.AmplifyBackend.Model.CreateBackendAuthResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z