@aws-cdk_aws-amplify-alpha.BasicAuthProps

interface BasicAuthProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Amplify.Alpha.BasicAuthProps
Gogithub.com/aws/aws-cdk-go/awscdkamplifyalpha/v2#BasicAuthProps
Javasoftware.amazon.awscdk.services.amplify.alpha.BasicAuthProps
Pythonaws_cdk.aws_amplify_alpha.BasicAuthProps
TypeScript (source)@aws-cdk/aws-amplify-alpha ยป BasicAuthProps

Properties for a BasicAuth.

Example

// 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

NameTypeDescription
username๐Ÿ”นstringThe username.
encryptionKey?๐Ÿ”นIKeyThe encryption key to use to encrypt the password when it's generated in Secrets Manager.
password?๐Ÿ”นSecretValueThe password.

username๐Ÿ”น

Type: string

The username.


encryptionKey?๐Ÿ”น

Type: IKey (optional, default: default master key)

The encryption key to use to encrypt the password when it's generated in Secrets Manager.


password?๐Ÿ”น

Type: SecretValue (optional, default: A Secrets Manager generated password)

The password.