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,
};
python
# 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
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.amplify.alpha.*;
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.kms.*;
Key key;
SecretValue secretValue;
BasicAuthProps basicAuthProps = BasicAuthProps.builder()
.username("username")
// the properties below are optional
.encryptionKey(key)
.password(secretValue)
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Amplify.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Amplify.Alpha;
using Amazon.CDK;
using Amazon.CDK.AWS.KMS;
Key key;
SecretValue secretValue;
var basicAuthProps = new BasicAuthProps {
Username = "username",
// the properties below are optional
EncryptionKey = key,
Password = secretValue
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import amplify_alpha "github.com/aws/aws-cdk-go/awscdkamplifyalpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var key Key
var secretValue SecretValue
basicAuthProps := &BasicAuthProps{
Username: jsii.String("username"),
// the properties below are optional
EncryptionKey: key,
Password: secretValue,
}
Properties
encryptionKeyoptionalIKeyencryption_keyoptionalIKeyencryptionKeyoptionalIKeyEncryptionKeyoptionalIKeyEncryptionKeyoptionalIKey#The encryption key to use to encrypt the password when it's generated in Secrets Manager.
Default: default master key
passwordoptionalSecretValuepasswordoptionalSecretValuepasswordoptionalSecretValuePasswordoptionalSecretValuePasswordoptionalSecretValue#The password.
Default: A Secrets Manager generated password
The username.