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
}

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.

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

Returns:

  • (String)


4973
4974
4975
4976
4977
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4973

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

#retention_periodInteger

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

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

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

Returns:

  • (Integer)


4973
4974
4975
4976
4977
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4973

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