software.amazon.awssdk.services.rds.model.DeleteDbInstanceRequest Maven / Gradle / Ivy
/*
* 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 DeleteDbInstanceRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_INSTANCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceIdentifier").getter(getter(DeleteDbInstanceRequest::dbInstanceIdentifier))
.setter(setter(Builder::dbInstanceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceIdentifier").build())
.build();
private static final SdkField SKIP_FINAL_SNAPSHOT_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("SkipFinalSnapshot").getter(getter(DeleteDbInstanceRequest::skipFinalSnapshot))
.setter(setter(Builder::skipFinalSnapshot))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SkipFinalSnapshot").build()).build();
private static final SdkField FINAL_DB_SNAPSHOT_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FinalDBSnapshotIdentifier").getter(getter(DeleteDbInstanceRequest::finalDBSnapshotIdentifier))
.setter(setter(Builder::finalDBSnapshotIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FinalDBSnapshotIdentifier").build())
.build();
private static final SdkField DELETE_AUTOMATED_BACKUPS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DeleteAutomatedBackups").getter(getter(DeleteDbInstanceRequest::deleteAutomatedBackups))
.setter(setter(Builder::deleteAutomatedBackups))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeleteAutomatedBackups").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_INSTANCE_IDENTIFIER_FIELD,
SKIP_FINAL_SNAPSHOT_FIELD, FINAL_DB_SNAPSHOT_IDENTIFIER_FIELD, DELETE_AUTOMATED_BACKUPS_FIELD));
private final String dbInstanceIdentifier;
private final Boolean skipFinalSnapshot;
private final String finalDBSnapshotIdentifier;
private final Boolean deleteAutomatedBackups;
private DeleteDbInstanceRequest(BuilderImpl builder) {
super(builder);
this.dbInstanceIdentifier = builder.dbInstanceIdentifier;
this.skipFinalSnapshot = builder.skipFinalSnapshot;
this.finalDBSnapshotIdentifier = builder.finalDBSnapshotIdentifier;
this.deleteAutomatedBackups = builder.deleteAutomatedBackups;
}
/**
*
* The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the name of an existing DB instance.
*
*
*
*
* @return The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* Must match the name of an existing DB instance.
*
*
*/
public final String dbInstanceIdentifier() {
return dbInstanceIdentifier;
}
/**
*
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you
* enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB
* snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
*
*
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
*
*
*
* When a DB instance is in a failure state and has a status of failed,
* incompatible-restore, or incompatible-network, RDS can delete the instance only if you
* enable this parameter.
*
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting.
*
*
* This setting is required for RDS Custom.
*
*
* @return A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.
* If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS
* creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB
* snapshot is created.
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
* parameter.
*
*
*
* When a DB instance is in a failure state and has a status of failed,
* incompatible-restore, or incompatible-network, RDS can delete the instance only
* if you enable this parameter.
*
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting.
*
*
* This setting is required for RDS Custom.
*/
public final Boolean skipFinalSnapshot() {
return skipFinalSnapshot;
}
/**
*
* The DBSnapshotIdentifier of the new DBSnapshot created when the
* SkipFinalSnapshot parameter is disabled.
*
*
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
*
*
*
* This setting doesn't apply to RDS Custom.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* Can't be specified when deleting a read replica.
*
*
*
*
* @return The DBSnapshotIdentifier of the new DBSnapshot created when the
* SkipFinalSnapshot parameter is disabled.
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
*
*
*
* This setting doesn't apply to RDS Custom.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* Can't be specified when deleting a read replica.
*
*
*/
public final String finalDBSnapshotIdentifier() {
return finalDBSnapshotIdentifier;
}
/**
*
* A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This
* parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is
* deleted.
*
*
* @return A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
* This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB
* instance is deleted.
*/
public final Boolean deleteAutomatedBackups() {
return deleteAutomatedBackups;
}
@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(dbInstanceIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(skipFinalSnapshot());
hashCode = 31 * hashCode + Objects.hashCode(finalDBSnapshotIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(deleteAutomatedBackups());
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 DeleteDbInstanceRequest)) {
return false;
}
DeleteDbInstanceRequest other = (DeleteDbInstanceRequest) obj;
return Objects.equals(dbInstanceIdentifier(), other.dbInstanceIdentifier())
&& Objects.equals(skipFinalSnapshot(), other.skipFinalSnapshot())
&& Objects.equals(finalDBSnapshotIdentifier(), other.finalDBSnapshotIdentifier())
&& Objects.equals(deleteAutomatedBackups(), other.deleteAutomatedBackups());
}
/**
* 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("DeleteDbInstanceRequest").add("DBInstanceIdentifier", dbInstanceIdentifier())
.add("SkipFinalSnapshot", skipFinalSnapshot()).add("FinalDBSnapshotIdentifier", finalDBSnapshotIdentifier())
.add("DeleteAutomatedBackups", deleteAutomatedBackups()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(dbInstanceIdentifier()));
case "SkipFinalSnapshot":
return Optional.ofNullable(clazz.cast(skipFinalSnapshot()));
case "FinalDBSnapshotIdentifier":
return Optional.ofNullable(clazz.cast(finalDBSnapshotIdentifier()));
case "DeleteAutomatedBackups":
return Optional.ofNullable(clazz.cast(deleteAutomatedBackups()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeleteDbInstanceRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must match the name of an existing DB instance.
*
*
*
*
* @param dbInstanceIdentifier
* The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* Must match the name of an existing DB instance.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstanceIdentifier(String dbInstanceIdentifier);
/**
*
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If
* you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates
* a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is
* created.
*
*
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
*
*
*
* When a DB instance is in a failure state and has a status of failed,
* incompatible-restore, or incompatible-network, RDS can delete the instance only if
* you enable this parameter.
*
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting.
*
*
* This setting is required for RDS Custom.
*
*
* @param skipFinalSnapshot
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the
* instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this
* parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't
* enabled, and the DB snapshot is created.
*
* If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier
* parameter.
*
*
*
* When a DB instance is in a failure state and has a status of failed,
* incompatible-restore, or incompatible-network, RDS can delete the instance
* only if you enable this parameter.
*
*
* If you delete a read replica or an RDS Custom instance, you must enable this setting.
*
*
* This setting is required for RDS Custom.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder skipFinalSnapshot(Boolean skipFinalSnapshot);
/**
*
* The DBSnapshotIdentifier of the new DBSnapshot created when the
* SkipFinalSnapshot parameter is disabled.
*
*
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
*
*
*
* This setting doesn't apply to RDS Custom.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* Can't be specified when deleting a read replica.
*
*
*
*
* @param finalDBSnapshotIdentifier
* The DBSnapshotIdentifier of the new DBSnapshot created when the
* SkipFinalSnapshot parameter is disabled.
*
* If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
*
*
*
* This setting doesn't apply to RDS Custom.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 letters or numbers.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* Can't be specified when deleting a read replica.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder finalDBSnapshotIdentifier(String finalDBSnapshotIdentifier);
/**
*
* A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This
* parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance
* is deleted.
*
*
* @param deleteAutomatedBackups
* A value that indicates whether to remove automated backups immediately after the DB instance is
* deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately
* after the DB instance is deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deleteAutomatedBackups(Boolean deleteAutomatedBackups);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbInstanceIdentifier;
private Boolean skipFinalSnapshot;
private String finalDBSnapshotIdentifier;
private Boolean deleteAutomatedBackups;
private BuilderImpl() {
}
private BuilderImpl(DeleteDbInstanceRequest model) {
super(model);
dbInstanceIdentifier(model.dbInstanceIdentifier);
skipFinalSnapshot(model.skipFinalSnapshot);
finalDBSnapshotIdentifier(model.finalDBSnapshotIdentifier);
deleteAutomatedBackups(model.deleteAutomatedBackups);
}
public final String getDbInstanceIdentifier() {
return dbInstanceIdentifier;
}
public final void setDbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
}
@Override
public final Builder dbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
return this;
}
public final Boolean getSkipFinalSnapshot() {
return skipFinalSnapshot;
}
public final void setSkipFinalSnapshot(Boolean skipFinalSnapshot) {
this.skipFinalSnapshot = skipFinalSnapshot;
}
@Override
public final Builder skipFinalSnapshot(Boolean skipFinalSnapshot) {
this.skipFinalSnapshot = skipFinalSnapshot;
return this;
}
public final String getFinalDBSnapshotIdentifier() {
return finalDBSnapshotIdentifier;
}
public final void setFinalDBSnapshotIdentifier(String finalDBSnapshotIdentifier) {
this.finalDBSnapshotIdentifier = finalDBSnapshotIdentifier;
}
@Override
public final Builder finalDBSnapshotIdentifier(String finalDBSnapshotIdentifier) {
this.finalDBSnapshotIdentifier = finalDBSnapshotIdentifier;
return this;
}
public final Boolean getDeleteAutomatedBackups() {
return deleteAutomatedBackups;
}
public final void setDeleteAutomatedBackups(Boolean deleteAutomatedBackups) {
this.deleteAutomatedBackups = deleteAutomatedBackups;
}
@Override
public final Builder deleteAutomatedBackups(Boolean deleteAutomatedBackups) {
this.deleteAutomatedBackups = deleteAutomatedBackups;
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 DeleteDbInstanceRequest build() {
return new DeleteDbInstanceRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}