Skip to content
v2.278.0

BasicAuthConfigProperty Struct ​

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

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_amplify as amplify

basic_auth_config_property = amplify.CfnApp.BasicAuthConfigProperty(
    enable_basic_auth=False,
    password="password",
    username="username"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.amplify.*;

BasicAuthConfigProperty basicAuthConfigProperty = BasicAuthConfigProperty.builder()
        .enableBasicAuth(false)
        .password("password")
        .username("username")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Amplify;

var basicAuthConfigProperty = new BasicAuthConfigProperty {
    EnableBasicAuth = false,
    Password = "password",
    Username = "username"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

basicAuthConfigProperty := &BasicAuthConfigProperty{
	EnableBasicAuth: jsii.Boolean(false),
	Password: jsii.String("password"),
	Username: jsii.String("username"),
}

Properties ​

enableBasicAuthoptionalboolean | IResolvableenable_basic_authoptionaltyping.Union[bool, IResolvable]enableBasicAuthoptionalBooleanEnableBasicAuthoptionalboolEnableBasicAuthoptionalinterface{} #
Enables basic authorization for the Amplify app's branches.
passwordoptionalstringpasswordoptionalstrpasswordoptionalStringPasswordoptionalstringPasswordoptional*string #
The password for basic authorization.
usernameoptionalstringusernameoptionalstrusernameoptionalStringUsernameoptionalstringUsernameoptional*string #
The user name for basic authorization.