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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BatchModifyClusterSnapshotsMessage as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

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) —

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

#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) —

    The number of days that a manual snapshot is retained.

#snapshot_identifier_list ⇒ Array<String>

A list of snapshot identifiers you want to modify.

Returns:

  • (Array<String>) —

    A list of snapshot identifiers you want to modify.