software.amazon.awscdk.services.redshift.alpha.DatabaseSecretProps Maven / Gradle / Ivy
Show all versions of redshift-alpha Show documentation
package software.amazon.awscdk.services.redshift.alpha;
/**
* (experimental) Construction properties for a DatabaseSecret.
*
* 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;
* DatabaseSecretProps databaseSecretProps = DatabaseSecretProps.builder()
* .username("username")
* // the properties below are optional
* .encryptionKey(key)
* .excludeCharacters("excludeCharacters")
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-11-15T10:25:09.581Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.redshift.alpha.$Module.class, fqn = "@aws-cdk/aws-redshift-alpha.DatabaseSecretProps")
@software.amazon.jsii.Jsii.Proxy(DatabaseSecretProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface DatabaseSecretProps extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) The username.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.String getUsername();
/**
* (experimental) The KMS key to use to encrypt the secret.
*
* Default: default master key
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.kms.IKey getEncryptionKey() {
return null;
}
/**
* (experimental) Characters to not include in the generated password.
*
* Default: '"@/\\\ \''
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.String getExcludeCharacters() {
return null;
}
/**
* @return a {@link Builder} of {@link DatabaseSecretProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link DatabaseSecretProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String username;
software.amazon.awscdk.services.kms.IKey encryptionKey;
java.lang.String excludeCharacters;
/**
* Sets the value of {@link DatabaseSecretProps#getUsername}
* @param username The username. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder username(java.lang.String username) {
this.username = username;
return this;
}
/**
* Sets the value of {@link DatabaseSecretProps#getEncryptionKey}
* @param encryptionKey The KMS key to use to encrypt the secret.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder encryptionKey(software.amazon.awscdk.services.kms.IKey encryptionKey) {
this.encryptionKey = encryptionKey;
return this;
}
/**
* Sets the value of {@link DatabaseSecretProps#getExcludeCharacters}
* @param excludeCharacters Characters to not include in the generated password.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder excludeCharacters(java.lang.String excludeCharacters) {
this.excludeCharacters = excludeCharacters;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link DatabaseSecretProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public DatabaseSecretProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link DatabaseSecretProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DatabaseSecretProps {
private final java.lang.String username;
private final software.amazon.awscdk.services.kms.IKey encryptionKey;
private final java.lang.String excludeCharacters;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.username = software.amazon.jsii.Kernel.get(this, "username", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.encryptionKey = software.amazon.jsii.Kernel.get(this, "encryptionKey", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.kms.IKey.class));
this.excludeCharacters = software.amazon.jsii.Kernel.get(this, "excludeCharacters", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.username = java.util.Objects.requireNonNull(builder.username, "username is required");
this.encryptionKey = builder.encryptionKey;
this.excludeCharacters = builder.excludeCharacters;
}
@Override
public final java.lang.String getUsername() {
return this.username;
}
@Override
public final software.amazon.awscdk.services.kms.IKey getEncryptionKey() {
return this.encryptionKey;
}
@Override
public final java.lang.String getExcludeCharacters() {
return this.excludeCharacters;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("username", om.valueToTree(this.getUsername()));
if (this.getEncryptionKey() != null) {
data.set("encryptionKey", om.valueToTree(this.getEncryptionKey()));
}
if (this.getExcludeCharacters() != null) {
data.set("excludeCharacters", om.valueToTree(this.getExcludeCharacters()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/aws-redshift-alpha.DatabaseSecretProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
DatabaseSecretProps.Jsii$Proxy that = (DatabaseSecretProps.Jsii$Proxy) o;
if (!username.equals(that.username)) return false;
if (this.encryptionKey != null ? !this.encryptionKey.equals(that.encryptionKey) : that.encryptionKey != null) return false;
return this.excludeCharacters != null ? this.excludeCharacters.equals(that.excludeCharacters) : that.excludeCharacters == null;
}
@Override
public final int hashCode() {
int result = this.username.hashCode();
result = 31 * result + (this.encryptionKey != null ? this.encryptionKey.hashCode() : 0);
result = 31 * result + (this.excludeCharacters != null ? this.excludeCharacters.hashCode() : 0);
return result;
}
}
}