interface BasicAuthProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Amplify.Alpha.BasicAuthProps |
![]() | github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2#BasicAuthProps |
![]() | software.amazon.awscdk.services.amplify.alpha.BasicAuthProps |
![]() | aws_cdk.aws_amplify_alpha.BasicAuthProps |
![]() | @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
Name | Type | Description |
---|---|---|
username | string | The username. |
encryption | IKey | The encryption key to use to encrypt the password when it's generated in Secrets Manager. |
password? | Secret | The 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:
Secret
(optional, default: A Secrets Manager generated password)
The password.