software.amazon.awscdk.services.redshift.alpha.DatabaseSecret Maven / Gradle / Ivy
Show all versions of redshift-alpha Show documentation
package software.amazon.awscdk.services.redshift.alpha;
/**
* (experimental) A database secret.
*
* 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.redshift.alpha.*;
* import software.amazon.awscdk.services.kms.*;
* Key key;
* DatabaseSecret databaseSecret = DatabaseSecret.Builder.create(this, "MyDatabaseSecret")
* .username("username")
* // the properties below are optional
* .encryptionKey(key)
* .excludeCharacters("excludeCharacters")
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-10T18:25:33.204Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.redshift.alpha.$Module.class, fqn = "@aws-cdk/aws-redshift-alpha.DatabaseSecret")
public class DatabaseSecret extends software.amazon.awscdk.services.secretsmanager.Secret {
protected DatabaseSecret(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected DatabaseSecret(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public DatabaseSecret(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.redshift.alpha.DatabaseSecretProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) A fluent builder for {@link software.amazon.awscdk.services.redshift.alpha.DatabaseSecret}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final software.constructs.Construct scope, final java.lang.String id) {
return new Builder(scope, id);
}
private final software.constructs.Construct scope;
private final java.lang.String id;
private final software.amazon.awscdk.services.redshift.alpha.DatabaseSecretProps.Builder props;
private Builder(final software.constructs.Construct scope, final java.lang.String id) {
this.scope = scope;
this.id = id;
this.props = new software.amazon.awscdk.services.redshift.alpha.DatabaseSecretProps.Builder();
}
/**
* (experimental) The username.
*
* @return {@code this}
* @param username The username. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder username(final java.lang.String username) {
this.props.username(username);
return this;
}
/**
* (experimental) The KMS key to use to encrypt the secret.
*
* Default: default master key
*
* @return {@code this}
* @param encryptionKey The KMS key to use to encrypt the secret. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder encryptionKey(final software.amazon.awscdk.services.kms.IKey encryptionKey) {
this.props.encryptionKey(encryptionKey);
return this;
}
/**
* (experimental) Characters to not include in the generated password.
*
* Default: '"@/\\\ \''
*
* @return {@code this}
* @param excludeCharacters Characters to not include in the generated password. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder excludeCharacters(final java.lang.String excludeCharacters) {
this.props.excludeCharacters(excludeCharacters);
return this;
}
/**
* @return a newly built instance of {@link software.amazon.awscdk.services.redshift.alpha.DatabaseSecret}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public software.amazon.awscdk.services.redshift.alpha.DatabaseSecret build() {
return new software.amazon.awscdk.services.redshift.alpha.DatabaseSecret(
this.scope,
this.id,
this.props.build()
);
}
}
}