aws-cdk-lib.aws_amplify.CfnApp.BasicAuthConfigProperty

interface BasicAuthConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Amplify.CfnApp.BasicAuthConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsamplify#CfnApp_BasicAuthConfigProperty
Javasoftware.amazon.awscdk.services.amplify.CfnApp.BasicAuthConfigProperty
Pythonaws_cdk.aws_amplify.CfnApp.BasicAuthConfigProperty
TypeScript aws-cdk-lib » aws_amplify » CfnApp » BasicAuthConfigProperty

Use the BasicAuthConfig property type to set password protection at an app level to all your branches.

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.CfnApp.BasicAuthConfigProperty = {
  enableBasicAuth: false,
  password: 'password',
  username: 'username',
};

Properties

NameTypeDescription
enableBasicAuth?boolean | IResolvableEnables basic authorization for the Amplify app's branches.
password?stringThe password for basic authorization.
username?stringThe user name for basic authorization.

enableBasicAuth?

Type: boolean | IResolvable (optional)

Enables basic authorization for the Amplify app's branches.


password?

Type: string (optional)

The password for basic authorization.

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


username?

Type: string (optional)

The user name for basic authorization.

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