DeleteDbInstanceRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.DeleteDbInstanceRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DeleteDbInstanceRequest
extends RdsRequest
implements ToCopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DeleteDbInstanceRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DeleteDbInstanceRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DeleteDbInstanceRequest.Builder`	`builder()`
`String`	`dbInstanceIdentifier()` The DB instance identifier for the DB instance to be deleted.
`Boolean`	`deleteAutomatedBackups()` A value that indicates whether to remove automated backups immediately after the DB instance is deleted.
`boolean`	`equals(Object obj)`
`String`	`finalDBSnapshotIdentifier()` The `DBSnapshotIdentifier` of the new DB snapshot created when `SkipFinalSnapshot` is set to `false`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeleteDbInstanceRequest.Builder>`	`serializableBuilderClass()`
`Boolean`	`skipFinalSnapshot()` A value that indicates whether a final DB snapshot is created before the DB instance is deleted.
`DeleteDbInstanceRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbInstanceIdentifier
```
public String 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.
    Returns:
    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.
  - skipFinalSnapshot
```
public Boolean skipFinalSnapshot()
```
    A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.
    
    When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.
    
    Specify true when deleting a Read Replica.
    
    The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
    
    Default: false
    
    Returns:
    
    A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.
    
    When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.
    
    Specify true when deleting a Read Replica.
    
    The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
    
    Default: false
  - finalDBSnapshotIdentifier
```
public String finalDBSnapshotIdentifier()
```
    The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot is set to false.
    
    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
    
    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.
    Returns:
    The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot is set to false.
    
    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
    
    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.
  - deleteAutomatedBackups
```
public Boolean deleteAutomatedBackups()
```
    A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. This parameter defaults to true.
    
    Returns:
    
    A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. This parameter defaults to true.
  - toBuilder
```
public DeleteDbInstanceRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeleteDbInstanceRequest.Builder,DeleteDbInstanceRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static DeleteDbInstanceRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeleteDbInstanceRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class DeleteDbInstanceRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbInstanceIdentifier

skipFinalSnapshot

finalDBSnapshotIdentifier

deleteAutomatedBackups

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields