software.amazon.awscdk.services.redshift.CfnClusterParameterGroupProps Maven / Gradle / Ivy
package software.amazon.awscdk.services.redshift;
/**
* Properties for defining a `CfnClusterParameterGroup`.
*
* 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.*;
* CfnClusterParameterGroupProps cfnClusterParameterGroupProps = CfnClusterParameterGroupProps.builder()
* .description("description")
* .parameterGroupFamily("parameterGroupFamily")
* // the properties below are optional
* .parameterGroupName("parameterGroupName")
* .parameters(List.of(ParameterProperty.builder()
* .parameterName("parameterName")
* .parameterValue("parameterValue")
* .build()))
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.74.0 (build 6d08790)", date = "2023-05-10T17:05:58.283Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.redshift.$Module.class, fqn = "@aws-cdk/aws-redshift.CfnClusterParameterGroupProps")
@software.amazon.jsii.Jsii.Proxy(CfnClusterParameterGroupProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface CfnClusterParameterGroupProps extends software.amazon.jsii.JsiiSerializable {
/**
* The description of the parameter group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getDescription();
/**
* The name of the cluster parameter group family that this cluster parameter group is compatible with.
*
* You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getParameterGroupFamily();
/**
* The name of the cluster parameter group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getParameterGroupName() {
return null;
}
/**
* An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
*
* For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
*
* For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Object getParameters() {
return null;
}
/**
* The list of tags for the cluster parameter group.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getTags() {
return null;
}
/**
* @return a {@link Builder} of {@link CfnClusterParameterGroupProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link CfnClusterParameterGroupProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String description;
java.lang.String parameterGroupFamily;
java.lang.String parameterGroupName;
java.lang.Object parameters;
java.util.List tags;
/**
* Sets the value of {@link CfnClusterParameterGroupProps#getDescription}
* @param description The description of the parameter group. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link CfnClusterParameterGroupProps#getParameterGroupFamily}
* @param parameterGroupFamily The name of the cluster parameter group family that this cluster parameter group is compatible with. This parameter is required.
* You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder parameterGroupFamily(java.lang.String parameterGroupFamily) {
this.parameterGroupFamily = parameterGroupFamily;
return this;
}
/**
* Sets the value of {@link CfnClusterParameterGroupProps#getParameterGroupName}
* @param parameterGroupName The name of the cluster parameter group.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder parameterGroupName(java.lang.String parameterGroupName) {
this.parameterGroupName = parameterGroupName;
return this;
}
/**
* Sets the value of {@link CfnClusterParameterGroupProps#getParameters}
* @param parameters An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
* For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
*
* For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder parameters(software.amazon.awscdk.core.IResolvable parameters) {
this.parameters = parameters;
return this;
}
/**
* Sets the value of {@link CfnClusterParameterGroupProps#getParameters}
* @param parameters An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
* For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
*
* For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder parameters(java.util.List parameters) {
this.parameters = parameters;
return this;
}
/**
* Sets the value of {@link CfnClusterParameterGroupProps#getTags}
* @param tags The list of tags for the cluster parameter group.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@SuppressWarnings("unchecked")
public Builder tags(java.util.List tags) {
this.tags = (java.util.List)tags;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link CfnClusterParameterGroupProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public CfnClusterParameterGroupProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link CfnClusterParameterGroupProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnClusterParameterGroupProps {
private final java.lang.String description;
private final java.lang.String parameterGroupFamily;
private final java.lang.String parameterGroupName;
private final java.lang.Object parameters;
private final java.util.List tags;
/**
* 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.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.parameterGroupFamily = software.amazon.jsii.Kernel.get(this, "parameterGroupFamily", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.parameterGroupName = software.amazon.jsii.Kernel.get(this, "parameterGroupName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.parameters = software.amazon.jsii.Kernel.get(this, "parameters", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.tags = software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.core.CfnTag.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.description = java.util.Objects.requireNonNull(builder.description, "description is required");
this.parameterGroupFamily = java.util.Objects.requireNonNull(builder.parameterGroupFamily, "parameterGroupFamily is required");
this.parameterGroupName = builder.parameterGroupName;
this.parameters = builder.parameters;
this.tags = (java.util.List)builder.tags;
}
@Override
public final java.lang.String getDescription() {
return this.description;
}
@Override
public final java.lang.String getParameterGroupFamily() {
return this.parameterGroupFamily;
}
@Override
public final java.lang.String getParameterGroupName() {
return this.parameterGroupName;
}
@Override
public final java.lang.Object getParameters() {
return this.parameters;
}
@Override
public final java.util.List getTags() {
return this.tags;
}
@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("description", om.valueToTree(this.getDescription()));
data.set("parameterGroupFamily", om.valueToTree(this.getParameterGroupFamily()));
if (this.getParameterGroupName() != null) {
data.set("parameterGroupName", om.valueToTree(this.getParameterGroupName()));
}
if (this.getParameters() != null) {
data.set("parameters", om.valueToTree(this.getParameters()));
}
if (this.getTags() != null) {
data.set("tags", om.valueToTree(this.getTags()));
}
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.CfnClusterParameterGroupProps"));
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;
CfnClusterParameterGroupProps.Jsii$Proxy that = (CfnClusterParameterGroupProps.Jsii$Proxy) o;
if (!description.equals(that.description)) return false;
if (!parameterGroupFamily.equals(that.parameterGroupFamily)) return false;
if (this.parameterGroupName != null ? !this.parameterGroupName.equals(that.parameterGroupName) : that.parameterGroupName != null) return false;
if (this.parameters != null ? !this.parameters.equals(that.parameters) : that.parameters != null) return false;
return this.tags != null ? this.tags.equals(that.tags) : that.tags == null;
}
@Override
public final int hashCode() {
int result = this.description.hashCode();
result = 31 * result + (this.parameterGroupFamily.hashCode());
result = 31 * result + (this.parameterGroupName != null ? this.parameterGroupName.hashCode() : 0);
result = 31 * result + (this.parameters != null ? this.parameters.hashCode() : 0);
result = 31 * result + (this.tags != null ? this.tags.hashCode() : 0);
return result;
}
}
}