Package software.amazon.awscdk.services.amplify

Interface CfnApp.BasicAuthConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApp.BasicAuthConfigProperty.Jsii$Proxy

Enclosing class:

CfnApp

@Stability(Stable)
public static interface CfnApp.BasicAuthConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.amplify.*;
 BasicAuthConfigProperty basicAuthConfigProperty = BasicAuthConfigProperty.builder()
         .enableBasicAuth(false)
         .password("password")
         .username("username")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApp.BasicAuthConfigProperty.Builder	A builder for CfnApp.BasicAuthConfigProperty
static final class	CfnApp.BasicAuthConfigProperty.Jsii$Proxy	An implementation for CfnApp.BasicAuthConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnApp.BasicAuthConfigProperty.Builder	builder()
default Object	getEnableBasicAuth()	Enables basic authorization for the Amplify app's branches.
default String	getPassword()	The password for basic authorization.
default String	getUsername()	The user name for basic authorization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnableBasicAuth

@Stability(Stable)
@Nullable
default Object getEnableBasicAuth()

Enables basic authorization for the Amplify app's branches.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-enablebasicauth

getPassword

@Stability(Stable)
@Nullable
default String getPassword()

The password for basic authorization.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-password

getUsername

@Stability(Stable)
@Nullable
default String getUsername()

The user name for basic authorization.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html#cfn-amplify-app-basicauthconfig-username

builder

@Stability(Stable)
static CfnApp.BasicAuthConfigProperty.Builder builder()

Returns:

a CfnApp.BasicAuthConfigProperty.Builder of CfnApp.BasicAuthConfigProperty