You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#forceBoolean

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

Returns:

  • (Boolean)


299
300
301
302
303
304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 299

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

#manual_snapshot_retention_periodInteger

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)


299
300
301
302
303
304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 299

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

#snapshot_identifier_listArray<String>

A list of snapshot identifiers you want to modify.

Returns:

  • (Array<String>)


299
300
301
302
303
304
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 299

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