BasicAuthProps

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

Bases: object

(experimental) Properties for a BasicAuth.

Parameters
  • 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

  • username (str) – (experimental) The username.

Stability

experimental

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 as amplify
import aws_cdk.aws_kms as kms
import aws_cdk.core as cdk

# key is of type Key
# secret_value is of type SecretValue

basic_auth_props = amplify.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

Return type

Optional[IKey]

password

(experimental) The password.

Default
  • A Secrets Manager generated password

Stability

experimental

Return type

Optional[SecretValue]

username

(experimental) The username.

Stability

experimental

Return type

str