aws-cdk-lib.aws_amplify.CfnBranch.BasicAuthConfigProperty

BasicAuthConfigProperty Struct

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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

enableBasicAuth?optionalboolean | IResolvableenable_basic_auth?optionaltyping.Union[bool, IResolvable]enableBasicAuth?optionalBooleanEnableBasicAuth?optionalboolEnableBasicAuth?optionalinterface{}#

Enables basic authorization for the branch.

passwordstringpasswordstrpasswordStringPasswordstringPassword*stringrequired#

The password for basic authorization.

usernamestringusernamestrusernameStringUsernamestringUsername*stringrequired#