Class: Aws::Redshift::Types::EnableSnapshotCopyMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Redshift::Types::EnableSnapshotCopyMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-redshift/types.rb
Overview
When making an API call, you may pass EnableSnapshotCopyMessage data as a hash:
{
cluster_identifier: "String", # required
destination_region: "String", # required
retention_period: 1,
snapshot_copy_grant_name: "String",
manual_snapshot_retention_period: 1,
}
Instance Attribute Summary collapse
-
#cluster_identifier ⇒ String
The unique identifier of the source cluster to copy snapshots from.
-
#destination_region ⇒ String
The destination AWS Region that you want to copy snapshots to.
-
#manual_snapshot_retention_period ⇒ Integer
The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region.
-
#retention_period ⇒ Integer
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
-
#snapshot_copy_grant_name ⇒ String
The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
Instance Attribute Details
#cluster_identifier ⇒ String
The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'lib/aws-sdk-redshift/types.rb', line 4586 class EnableSnapshotCopyMessage < Struct.new( :cluster_identifier, :destination_region, :retention_period, :snapshot_copy_grant_name, :manual_snapshot_retention_period) include Aws::Structure end |
#destination_region ⇒ String
The destination AWS Region that you want to copy snapshots to.
Constraints: Must be the name of a valid AWS Region. For more information, see [Regions and Endpoints] in the Amazon Web Services General Reference.
[1]: docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region
4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'lib/aws-sdk-redshift/types.rb', line 4586 class EnableSnapshotCopyMessage < Struct.new( :cluster_identifier, :destination_region, :retention_period, :snapshot_copy_grant_name, :manual_snapshot_retention_period) include Aws::Structure end |
#manual_snapshot_retention_period ⇒ Integer
The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'lib/aws-sdk-redshift/types.rb', line 4586 class EnableSnapshotCopyMessage < Struct.new( :cluster_identifier, :destination_region, :retention_period, :snapshot_copy_grant_name, :manual_snapshot_retention_period) include Aws::Structure end |
#retention_period ⇒ Integer
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'lib/aws-sdk-redshift/types.rb', line 4586 class EnableSnapshotCopyMessage < Struct.new( :cluster_identifier, :destination_region, :retention_period, :snapshot_copy_grant_name, :manual_snapshot_retention_period) include Aws::Structure end |
#snapshot_copy_grant_name ⇒ String
The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
4586 4587 4588 4589 4590 4591 4592 4593 |
# File 'lib/aws-sdk-redshift/types.rb', line 4586 class EnableSnapshotCopyMessage < Struct.new( :cluster_identifier, :destination_region, :retention_period, :snapshot_copy_grant_name, :manual_snapshot_retention_period) include Aws::Structure end |