BasicAuthProps

class aws_cdk.aws_amplify_alpha.BasicAuthProps(*, username, encryption_key=None, password=None)

Bases: object

(experimental) Properties for a BasicAuth.

Parameters:

username (str) – (experimental) The username.
encryption_key (Optional[IKey]) – (experimental) The encryption key to use to encrypt the password when it’s generated in Secrets Manager. Default: - default master key
password (Optional[SecretValue]) – (experimental) The password. Default: - A Secrets Manager generated password

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_amplify_alpha as amplify_alpha
import aws_cdk as cdk
from aws_cdk import aws_kms as kms

# key: kms.Key
# secret_value: cdk.SecretValue

basic_auth_props = amplify_alpha.BasicAuthProps(
    username="username",

    # the properties below are optional
    encryption_key=key,
    password=secret_value
)

Attributes

encryption_key

(experimental) The encryption key to use to encrypt the password when it’s generated in Secrets Manager.

Default:

default master key

Stability:

experimental

password

(experimental) The password.

Default:

A Secrets Manager generated password

Stability:

experimental

username

(experimental) The username.

Stability:: experimental