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

Class: Aws::Redshift::Types::ModifyClusterSnapshotMessage

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

{
  snapshot_identifier: "String", # required
  manual_snapshot_retention_period: 1,
  force: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#forceBoolean

A Boolean option to override an exception if the retention period has already passed.

Returns:

  • (Boolean)


6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6149

class ModifyClusterSnapshotMessage < Struct.new(
  :snapshot_identifier,
  :manual_snapshot_retention_period,
  :force)
  include Aws::Structure
end

#manual_snapshot_retention_periodInteger

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

If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

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

Returns:

  • (Integer)


6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6149

class ModifyClusterSnapshotMessage < Struct.new(
  :snapshot_identifier,
  :manual_snapshot_retention_period,
  :force)
  include Aws::Structure
end

#snapshot_identifierString

The identifier of the snapshot whose setting you want to modify.

Returns:

  • (String)


6149
6150
6151
6152
6153
6154
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6149

class ModifyClusterSnapshotMessage < Struct.new(
  :snapshot_identifier,
  :manual_snapshot_retention_period,
  :force)
  include Aws::Structure
end