aws-cdk-lib.aws_amplify.CfnBranch.BasicAuthConfigProperty

interface BasicAuthConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Amplify.CfnBranch.BasicAuthConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnBranch_BasicAuthConfigProperty
Javasoftware.amazon.awscdk.services.amplify.CfnBranch.BasicAuthConfigProperty
Pythonaws_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.

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

NameTypeDescription
passwordstringThe password for basic authorization.
usernamestringThe user name for basic authorization.
enableBasicAuth?boolean | IResolvableEnables basic authorization for the branch.

password

Type: string

The password for basic authorization.

Length Constraints: Minimum length of 1. Maximum length of 255.


username

Type: string

The user name for basic authorization.

Length Constraints: Minimum length of 1. Maximum length of 255.


enableBasicAuth?

Type: boolean | IResolvable (optional)

Enables basic authorization for the branch.