Class: Aws::Redshift::Types::ModifySnapshotCopyRetentionPeriodMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Redshift::Types::ModifySnapshotCopyRetentionPeriodMessage
- Defined in:
- gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb
Overview
When making an API call, you may pass ModifySnapshotCopyRetentionPeriodMessage data as a hash:
{
cluster_identifier: "String", # required
retention_period: 1, # required
manual: false,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 Amazon Web Services Region.
-
#manual ⇒ Boolean
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
-
#retention_period ⇒ Integer
The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
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 Amazon Web Services Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
8883 8884 8885 8886 8887 8888 8889 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8883 class ModifySnapshotCopyRetentionPeriodMessage < Struct.new( :cluster_identifier, :retention_period, :manual) SENSITIVE = [] include Aws::Structure end |
#manual ⇒ Boolean
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
8883 8884 8885 8886 8887 8888 8889 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8883 class ModifySnapshotCopyRetentionPeriodMessage < Struct.new( :cluster_identifier, :retention_period, :manual) SENSITIVE = [] include Aws::Structure end |
#retention_period ⇒ Integer
The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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 Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services 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.
8883 8884 8885 8886 8887 8888 8889 |
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8883 class ModifySnapshotCopyRetentionPeriodMessage < Struct.new( :cluster_identifier, :retention_period, :manual) SENSITIVE = [] include Aws::Structure end |