Class BasicAuth
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.amplify.alpha.BasicAuth
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-27T16:51:07.074Z")
@Stability(Experimental)
public class BasicAuth
extends software.amazon.jsii.JsiiObject
(experimental) Basic Auth configuration.
Example:
App amplifyApp = App.Builder.create(this, "MyApp") .sourceCodeProvider(GitHubSourceCodeProvider.Builder.create() .owner("<user>") .repository("<repo>") .oauthToken(SecretValue.secretsManager("my-github-token")) .build()) .basicAuth(BasicAuth.fromGeneratedPassword("username")) .build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
(experimental) A fluent builder forBasicAuth
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Constructor Summary
ModifierConstructorDescriptionBasicAuth
(BasicAuthProps props) protected
BasicAuth
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
BasicAuth
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescription(experimental) Binds this Basic Auth configuration to an App.static BasicAuth
fromCredentials
(String username, SecretValue password) (experimental) Creates a Basic Auth configuration from a username and a password.static BasicAuth
fromGeneratedPassword
(String username) (experimental) Creates a Basic Auth configuration with a password generated in Secrets Manager.static BasicAuth
fromGeneratedPassword
(String username, IKey encryptionKey) (experimental) Creates a Basic Auth configuration with a password generated in Secrets Manager.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
BasicAuth
protected BasicAuth(software.amazon.jsii.JsiiObjectRef objRef) -
BasicAuth
protected BasicAuth(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
BasicAuth
- Parameters:
props
- This parameter is required.
-
-
Method Details
-
fromCredentials
@Stability(Experimental) @NotNull public static BasicAuth fromCredentials(@NotNull String username, @NotNull SecretValue password) (experimental) Creates a Basic Auth configuration from a username and a password.- Parameters:
username
- The username. This parameter is required.password
- The password. This parameter is required.
-
fromGeneratedPassword
@Stability(Experimental) @NotNull public static BasicAuth fromGeneratedPassword(@NotNull String username, @Nullable IKey encryptionKey) (experimental) Creates a Basic Auth configuration with a password generated in Secrets Manager.- Parameters:
username
- The username. This parameter is required.encryptionKey
- The encryption key to use to encrypt the password in Secrets Manager.
-
fromGeneratedPassword
@Stability(Experimental) @NotNull public static BasicAuth fromGeneratedPassword(@NotNull String username) (experimental) Creates a Basic Auth configuration with a password generated in Secrets Manager.- Parameters:
username
- The username. This parameter is required.
-
bind
@Stability(Experimental) @NotNull public BasicAuthConfig bind(@NotNull software.constructs.Construct scope, @NotNull String id) (experimental) Binds this Basic Auth configuration to an App.- Parameters:
scope
- This parameter is required.id
- This parameter is required.
-