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

Class: Aws::Redshift::Types::ModifySnapshotCopyRetentionPeriodMessage

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

{
  cluster_identifier: "String", # required
  retention_period: 1, # required
  manual: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifier ⇒ String

The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Returns:

  • (String) 


6458
6459
6460
6461
6462
6463
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6458

class ModifySnapshotCopyRetentionPeriodMessage < Struct.new(
  :cluster_identifier,
  :retention_period,
  :manual)
  include Aws::Structure
end

#manual ⇒ Boolean

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Returns:

  • (Boolean) 


6458
6459
6460
6461
6462
6463
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6458

class ModifySnapshotCopyRetentionPeriodMessage < Struct.new(
  :cluster_identifier,
  :retention_period,
  :manual)
  include Aws::Structure
end

#retention_period ⇒ Integer

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Returns:

  • (Integer) 


6458
6459
6460
6461
6462
6463
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 6458

class ModifySnapshotCopyRetentionPeriodMessage < Struct.new(
  :cluster_identifier,
  :retention_period,
  :manual)
  include Aws::Structure
end