Class DeleteClusterRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DeleteClusterRequest.Builder,
DeleteClusterRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DeleteClusterRequest.Builder
builder()
final String
The identifier of the cluster to be deleted.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The identifier of the final snapshot that is to be created immediately before deleting the cluster.final Integer
The number of days that a manual snapshot is retained.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
static Class
<? extends DeleteClusterRequest.Builder> final Boolean
Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterIdentifier
The identifier of the cluster to be deleted.
Constraints:
-
Must contain lowercase characters.
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
- Returns:
- The identifier of the cluster to be deleted.
Constraints:
-
Must contain lowercase characters.
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
-
-
-
skipFinalClusterSnapshot
Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If
true
, a final cluster snapshot is not created. Iffalse
, a final cluster snapshot is created before the cluster is deleted.The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is
false
.Default:
false
- Returns:
- Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster.
If
true
, a final cluster snapshot is not created. Iffalse
, a final cluster snapshot is created before the cluster is deleted.The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is
false
.Default:
false
-
finalClusterSnapshotIdentifier
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be
false
.Constraints:
-
Must be 1 to 255 alphanumeric characters.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
- Returns:
- The identifier of the final snapshot that is to be created immediately before deleting the cluster. If
this parameter is provided, SkipFinalClusterSnapshot must be
false
.Constraints:
-
Must be 1 to 255 alphanumeric characters.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
-
-
-
finalClusterSnapshotRetentionPeriod
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
- Returns:
- The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is
retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
-
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 interfaceToCopyableBuilder<DeleteClusterRequest.Builder,
DeleteClusterRequest> - Specified by:
toBuilder
in classRedshiftRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-