Class: Aws::Redshift::Types::BatchModifyClusterSnapshotsMessage

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 BatchModifyClusterSnapshotsMessage data as a hash:

{
  snapshot_identifier_list: ["String"], # required
  manual_snapshot_retention_period: 1,
  force: false,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#force ⇒ Boolean

A boolean value indicating whether to override an exception if the retention period has passed.

Returns:

  • (Boolean) 


531
532
533
534
535
536
537
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 531

class BatchModifyClusterSnapshotsMessage < Struct.new(
  :snapshot_identifier_list,
  :manual_snapshot_retention_period,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#manual_snapshot_retention_period ⇒ Integer

The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

The number must be either -1 or an integer between 1 and 3,653.

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

Returns:

  • (Integer) 


531
532
533
534
535
536
537
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 531

class BatchModifyClusterSnapshotsMessage < Struct.new(
  :snapshot_identifier_list,
  :manual_snapshot_retention_period,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_identifier_list ⇒ Array<String>

A list of snapshot identifiers you want to modify.

Returns:

  • (Array<String>) 


531
532
533
534
535
536
537
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 531

class BatchModifyClusterSnapshotsMessage < Struct.new(
  :snapshot_identifier_list,
  :manual_snapshot_retention_period,
  :force)
  SENSITIVE = []
  include Aws::Structure
end