Package software.amazon.awscdk.services.amplify.alpha

Interface BasicAuthProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BasicAuthProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:49.496Z")
@Stability(Experimental)
public interface BasicAuthProps
extends software.amazon.jsii.JsiiSerializable

(experimental) 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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BasicAuthProps.Builder	A builder for BasicAuthProps
static final class	BasicAuthProps.Jsii$Proxy	An implementation for BasicAuthProps

Method Summary

Modifier and Type	Method	Description
static BasicAuthProps.Builder	builder()
default IKey	getEncryptionKey()	(experimental) The encryption key to use to encrypt the password when it's generated in Secrets Manager.
default SecretValue	getPassword()	(experimental) The password.
String	getUsername()	(experimental) The username.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUsername

@Stability(Experimental)
@NotNull
String getUsername()

(experimental) The username.

getEncryptionKey

@Stability(Experimental)
@Nullable
default IKey getEncryptionKey()

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

Default: - default master key

getPassword

@Stability(Experimental)
@Nullable
default SecretValue getPassword()

(experimental) The password.

Default: - A Secrets Manager generated password

builder

@Stability(Experimental)
static BasicAuthProps.Builder builder()

Returns:

a BasicAuthProps.Builder of BasicAuthProps