AWS::Amplify::Branch BasicAuthConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Amplify::Branch BasicAuthConfig

Use the BasicAuthConfig property type to set password protection for a specific branch.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "EnableBasicAuth" : Boolean,
  "Password" : String,
  "Username" : String
}

YAML

  EnableBasicAuth: Boolean
  Password: String
  Username: String

Properties

EnableBasicAuth

Enables basic authorization for the branch.

Required: No

Type: Boolean

Update requires: No interruption

Password

The password for basic authorization.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Username

Property description not available.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption