Skip to content
v2.274.0

Experimental

@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

BasicAuthProps Struct ​

Properties for a BasicAuth.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify_alpha from '@aws-cdk/aws-amplify-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';

declare const key: kms.Key;
declare const secretValue: cdk.SecretValue;
const basicAuthProps: amplify_alpha.BasicAuthProps = {
  username: 'username',

  // the properties below are optional
  encryptionKey: key,
  password: secretValue,
};

Properties ​

encryptionKeyIKeyencryption_keyIKeyencryptionKeyIKeyEncryptionKeyIKeyEncryptionKeyIKey= default master key#
The encryption key to use to encrypt the password when it's generated in Secrets Manager.
passwordSecretValuepasswordSecretValuepasswordSecretValuePasswordSecretValuePasswordSecretValue= A Secrets Manager generated pass…#
The password.
default

Default: A Secrets Manager generated password

usernamestringusernamestrusernameStringUsernamestringUsername*stringrequired#
The username.