Class: Aws::Redshift::Types::DeleteClusterMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass DeleteClusterMessage data as a hash:

{
  cluster_identifier: "String", # required
  skip_final_cluster_snapshot: false,
  final_cluster_snapshot_identifier: "String",
  final_cluster_snapshot_retention_period: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

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:

  • (String)


3042
3043
3044
3045
3046
3047
3048
3049
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3042

class DeleteClusterMessage < Struct.new(
  :cluster_identifier,
  :skip_final_cluster_snapshot,
  :final_cluster_snapshot_identifier,
  :final_cluster_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#final_cluster_snapshot_identifierString

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:

  • (String)


3042
3043
3044
3045
3046
3047
3048
3049
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3042

class DeleteClusterMessage < Struct.new(
  :cluster_identifier,
  :skip_final_cluster_snapshot,
  :final_cluster_snapshot_identifier,
  :final_cluster_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#final_cluster_snapshot_retention_periodInteger

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:

  • (Integer)


3042
3043
3044
3045
3046
3047
3048
3049
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3042

class DeleteClusterMessage < Struct.new(
  :cluster_identifier,
  :skip_final_cluster_snapshot,
  :final_cluster_snapshot_identifier,
  :final_cluster_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#skip_final_cluster_snapshotBoolean

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. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Returns:

  • (Boolean)


3042
3043
3044
3045
3046
3047
3048
3049
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 3042

class DeleteClusterMessage < Struct.new(
  :cluster_identifier,
  :skip_final_cluster_snapshot,
  :final_cluster_snapshot_identifier,
  :final_cluster_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end