software.amazon.awssdk.services.rds.model.ModifyGlobalClusterRequest Maven / Gradle / Ivy
Show all versions of rds Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rds.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModifyGlobalClusterRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField GLOBAL_CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GlobalClusterIdentifier").getter(getter(ModifyGlobalClusterRequest::globalClusterIdentifier))
.setter(setter(Builder::globalClusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GlobalClusterIdentifier").build())
.build();
private static final SdkField NEW_GLOBAL_CLUSTER_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NewGlobalClusterIdentifier")
.getter(getter(ModifyGlobalClusterRequest::newGlobalClusterIdentifier))
.setter(setter(Builder::newGlobalClusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NewGlobalClusterIdentifier").build())
.build();
private static final SdkField DELETION_PROTECTION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DeletionProtection").getter(getter(ModifyGlobalClusterRequest::deletionProtection))
.setter(setter(Builder::deletionProtection))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeletionProtection").build())
.build();
private static final SdkField ENGINE_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EngineVersion").getter(getter(ModifyGlobalClusterRequest::engineVersion))
.setter(setter(Builder::engineVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EngineVersion").build()).build();
private static final SdkField ALLOW_MAJOR_VERSION_UPGRADE_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("AllowMajorVersionUpgrade")
.getter(getter(ModifyGlobalClusterRequest::allowMajorVersionUpgrade))
.setter(setter(Builder::allowMajorVersionUpgrade))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllowMajorVersionUpgrade").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
GLOBAL_CLUSTER_IDENTIFIER_FIELD, NEW_GLOBAL_CLUSTER_IDENTIFIER_FIELD, DELETION_PROTECTION_FIELD,
ENGINE_VERSION_FIELD, ALLOW_MAJOR_VERSION_UPGRADE_FIELD));
private final String globalClusterIdentifier;
private final String newGlobalClusterIdentifier;
private final Boolean deletionProtection;
private final String engineVersion;
private final Boolean allowMajorVersionUpgrade;
private ModifyGlobalClusterRequest(BuilderImpl builder) {
super(builder);
this.globalClusterIdentifier = builder.globalClusterIdentifier;
this.newGlobalClusterIdentifier = builder.newGlobalClusterIdentifier;
this.deletionProtection = builder.deletionProtection;
this.engineVersion = builder.engineVersion;
this.allowMajorVersionUpgrade = builder.allowMajorVersionUpgrade;
}
/**
*
* The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing global database cluster.
*
*
*
*
* @return The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing global database cluster.
*
*
*/
public final String globalClusterIdentifier() {
return globalClusterIdentifier;
}
/**
*
* The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster2
*
*
* @return The new cluster identifier for the global database cluster. This value is stored as a lowercase
* string.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster2
*/
public final String newGlobalClusterIdentifier() {
return newGlobalClusterIdentifier;
}
/**
*
* Specifies whether to enable deletion protection for the global database cluster. The global database cluster
* can't be deleted when deletion protection is enabled.
*
*
* @return Specifies whether to enable deletion protection for the global database cluster. The global database
* cluster can't be deleted when deletion protection is enabled.
*/
public final Boolean deletionProtection() {
return deletionProtection;
}
/**
*
* The version number of the database engine to which you want to upgrade.
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global
* databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
*
*
* To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora
* global databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
*
*
* @return The version number of the database engine to which you want to upgrade.
*
* To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global
* databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
*
*
* To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based
* Aurora global databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
*/
public final String engineVersion() {
return engineVersion;
}
/**
*
* Specifies whether to allow major version upgrades.
*
*
* Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a
* different major version than the global cluster's current version.
*
*
* If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to
* the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
*
*
* @return Specifies whether to allow major version upgrades.
*
* Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a
* different major version than the global cluster's current version.
*
*
* If you upgrade the major version of a global database, the cluster and DB instance parameter groups are
* set to the default parameter groups for the new version. Apply any custom parameter groups after
* completing the upgrade.
*/
public final Boolean allowMajorVersionUpgrade() {
return allowMajorVersionUpgrade;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(globalClusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(newGlobalClusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(deletionProtection());
hashCode = 31 * hashCode + Objects.hashCode(engineVersion());
hashCode = 31 * hashCode + Objects.hashCode(allowMajorVersionUpgrade());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ModifyGlobalClusterRequest)) {
return false;
}
ModifyGlobalClusterRequest other = (ModifyGlobalClusterRequest) obj;
return Objects.equals(globalClusterIdentifier(), other.globalClusterIdentifier())
&& Objects.equals(newGlobalClusterIdentifier(), other.newGlobalClusterIdentifier())
&& Objects.equals(deletionProtection(), other.deletionProtection())
&& Objects.equals(engineVersion(), other.engineVersion())
&& Objects.equals(allowMajorVersionUpgrade(), other.allowMajorVersionUpgrade());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("ModifyGlobalClusterRequest").add("GlobalClusterIdentifier", globalClusterIdentifier())
.add("NewGlobalClusterIdentifier", newGlobalClusterIdentifier()).add("DeletionProtection", deletionProtection())
.add("EngineVersion", engineVersion()).add("AllowMajorVersionUpgrade", allowMajorVersionUpgrade()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GlobalClusterIdentifier":
return Optional.ofNullable(clazz.cast(globalClusterIdentifier()));
case "NewGlobalClusterIdentifier":
return Optional.ofNullable(clazz.cast(newGlobalClusterIdentifier()));
case "DeletionProtection":
return Optional.ofNullable(clazz.cast(deletionProtection()));
case "EngineVersion":
return Optional.ofNullable(clazz.cast(engineVersion()));
case "AllowMajorVersionUpgrade":
return Optional.ofNullable(clazz.cast(allowMajorVersionUpgrade()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModifyGlobalClusterRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing global database cluster.
*
*
*
*
* @param globalClusterIdentifier
* The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* Must match the identifier of an existing global database cluster.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder globalClusterIdentifier(String globalClusterIdentifier);
/**
*
* The new cluster identifier for the global database cluster. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster2
*
*
* @param newGlobalClusterIdentifier
* The new cluster identifier for the global database cluster. This value is stored as a lowercase
* string.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 letters, numbers, or hyphens.
*
*
* -
*
* The first character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
*
*
* Example: my-cluster2
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder newGlobalClusterIdentifier(String newGlobalClusterIdentifier);
/**
*
* Specifies whether to enable deletion protection for the global database cluster. The global database cluster
* can't be deleted when deletion protection is enabled.
*
*
* @param deletionProtection
* Specifies whether to enable deletion protection for the global database cluster. The global database
* cluster can't be deleted when deletion protection is enabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deletionProtection(Boolean deletionProtection);
/**
*
* The version number of the database engine to which you want to upgrade.
*
*
* To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora global
* databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
*
*
* To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based Aurora
* global databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
*
*
* @param engineVersion
* The version number of the database engine to which you want to upgrade.
*
* To list all of the available engine versions for aurora-mysql (for MySQL-based Aurora
* global databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
*
*
* To list all of the available engine versions for aurora-postgresql (for PostgreSQL-based
* Aurora global databases), use the following command:
*
*
* aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder engineVersion(String engineVersion);
/**
*
* Specifies whether to allow major version upgrades.
*
*
* Constraints: Must be enabled if you specify a value for the EngineVersion parameter that's a
* different major version than the global cluster's current version.
*
*
* If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set
* to the default parameter groups for the new version. Apply any custom parameter groups after completing the
* upgrade.
*
*
* @param allowMajorVersionUpgrade
* Specifies whether to allow major version upgrades.
*
* Constraints: Must be enabled if you specify a value for the EngineVersion parameter
* that's a different major version than the global cluster's current version.
*
*
* If you upgrade the major version of a global database, the cluster and DB instance parameter groups
* are set to the default parameter groups for the new version. Apply any custom parameter groups after
* completing the upgrade.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String globalClusterIdentifier;
private String newGlobalClusterIdentifier;
private Boolean deletionProtection;
private String engineVersion;
private Boolean allowMajorVersionUpgrade;
private BuilderImpl() {
}
private BuilderImpl(ModifyGlobalClusterRequest model) {
super(model);
globalClusterIdentifier(model.globalClusterIdentifier);
newGlobalClusterIdentifier(model.newGlobalClusterIdentifier);
deletionProtection(model.deletionProtection);
engineVersion(model.engineVersion);
allowMajorVersionUpgrade(model.allowMajorVersionUpgrade);
}
public final String getGlobalClusterIdentifier() {
return globalClusterIdentifier;
}
public final void setGlobalClusterIdentifier(String globalClusterIdentifier) {
this.globalClusterIdentifier = globalClusterIdentifier;
}
@Override
public final Builder globalClusterIdentifier(String globalClusterIdentifier) {
this.globalClusterIdentifier = globalClusterIdentifier;
return this;
}
public final String getNewGlobalClusterIdentifier() {
return newGlobalClusterIdentifier;
}
public final void setNewGlobalClusterIdentifier(String newGlobalClusterIdentifier) {
this.newGlobalClusterIdentifier = newGlobalClusterIdentifier;
}
@Override
public final Builder newGlobalClusterIdentifier(String newGlobalClusterIdentifier) {
this.newGlobalClusterIdentifier = newGlobalClusterIdentifier;
return this;
}
public final Boolean getDeletionProtection() {
return deletionProtection;
}
public final void setDeletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
}
@Override
public final Builder deletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
return this;
}
public final String getEngineVersion() {
return engineVersion;
}
public final void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
@Override
public final Builder engineVersion(String engineVersion) {
this.engineVersion = engineVersion;
return this;
}
public final Boolean getAllowMajorVersionUpgrade() {
return allowMajorVersionUpgrade;
}
public final void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
this.allowMajorVersionUpgrade = allowMajorVersionUpgrade;
}
@Override
public final Builder allowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade) {
this.allowMajorVersionUpgrade = allowMajorVersionUpgrade;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ModifyGlobalClusterRequest build() {
return new ModifyGlobalClusterRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}