

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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Amplify::Branch BasicAuthConfig
<a name="aws-properties-amplify-branch-basicauthconfig"></a>

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

## Syntax
<a name="aws-properties-amplify-branch-basicauthconfig-syntax"></a>

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

### JSON
<a name="aws-properties-amplify-branch-basicauthconfig-syntax.json"></a>

```
{
  "[EnableBasicAuth](#cfn-amplify-branch-basicauthconfig-enablebasicauth)" : Boolean,
  "[Password](#cfn-amplify-branch-basicauthconfig-password)" : String,
  "[Username](#cfn-amplify-branch-basicauthconfig-username)" : String
}
```

### YAML
<a name="aws-properties-amplify-branch-basicauthconfig-syntax.yaml"></a>

```
  [EnableBasicAuth](#cfn-amplify-branch-basicauthconfig-enablebasicauth): Boolean
  [Password](#cfn-amplify-branch-basicauthconfig-password): String
  [Username](#cfn-amplify-branch-basicauthconfig-username): String
```

## Properties
<a name="aws-properties-amplify-branch-basicauthconfig-properties"></a>

`EnableBasicAuth`  <a name="cfn-amplify-branch-basicauthconfig-enablebasicauth"></a>
 Enables basic authorization for the branch.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Password`  <a name="cfn-amplify-branch-basicauthconfig-password"></a>
The password for basic authorization.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Username`  <a name="cfn-amplify-branch-basicauthconfig-username"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)