interface BasicAuthConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.Amplify.CfnBranch.BasicAuthConfigProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnBranch_BasicAuthConfigProperty
Java	software.amazon.awscdk.services.amplify.CfnBranch.BasicAuthConfigProperty
Python	aws_cdk.aws_amplify.CfnBranch.BasicAuthConfigProperty
TypeScript	aws-cdk-lib » aws_amplify » CfnBranch » BasicAuthConfigProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_amplify as amplify } from 'aws-cdk-lib';
const basicAuthConfigProperty: amplify.CfnBranch.BasicAuthConfigProperty = {
  password: 'password',
  username: 'username',

  // the properties below are optional
  enableBasicAuth: false,
};

Properties

Name	Type	Description
password	string	The password for basic authorization.
username	string
enableBasicAuth?	boolean | IResolvable	Enables basic authorization for the branch.

---

password

Type: string

The password for basic authorization.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-password

---

username

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-username

---

enableBasicAuth?

Type: boolean | IResolvable (optional)

Enables basic authorization for the branch.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-basicauthconfig.html#cfn-amplify-branch-basicauthconfig-enablebasicauth