Class BasicAuth
(experimental) Basic Auth configuration.
Inheritance
Namespace: Amazon.CDK.AWS.Amplify
Assembly: Amazon.CDK.AWS.Amplify.dll
Syntax (csharp)
public class BasicAuth : DeputyBase
Syntax (vb)
Public Class BasicAuth
Inherits DeputyBase
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
var amplifyApp = new App(this, "MyApp", new AppProps {
SourceCodeProvider = new GitHubSourceCodeProvider(new GitHubSourceCodeProviderProps {
Owner = "<user>",
Repository = "<repo>",
OauthToken = SecretValue.SecretsManager("my-github-token")
}),
BasicAuth = BasicAuth.FromGeneratedPassword("username")
});
Synopsis
Constructors
BasicAuth(IBasicAuthProps) | |
BasicAuth(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
BasicAuth(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
Bind(Construct, String) | (experimental) Binds this Basic Auth configuration to an App. |
FromCredentials(String, SecretValue) | (experimental) Creates a Basic Auth configuration from a username and a password. |
FromGeneratedPassword(String, IKey) | (experimental) Creates a Basic Auth configuration with a password generated in Secrets Manager. |
Constructors
BasicAuth(IBasicAuthProps)
public BasicAuth(IBasicAuthProps props)
Parameters
- props IBasicAuthProps
Remarks
Stability: Experimental
BasicAuth(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected BasicAuth(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
BasicAuth(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected BasicAuth(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
Bind(Construct, String)
(experimental) Binds this Basic Auth configuration to an App.
public virtual IBasicAuthConfig Bind(Construct scope, string id)
Parameters
- scope Construct
- id System.String
Returns
Remarks
Stability: Experimental
FromCredentials(String, SecretValue)
(experimental) Creates a Basic Auth configuration from a username and a password.
public static BasicAuth FromCredentials(string username, SecretValue password)
Parameters
- username System.String
The username.
- password SecretValue
The password.
Returns
Remarks
Stability: Experimental
FromGeneratedPassword(String, IKey)
(experimental) Creates a Basic Auth configuration with a password generated in Secrets Manager.
public static BasicAuth FromGeneratedPassword(string username, IKey encryptionKey = null)
Parameters
- username System.String
The username.
- encryptionKey IKey
The encryption key to use to encrypt the password in Secrets Manager.
Returns
Remarks
Stability: Experimental