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

Class: Aws::Redshift::Types::EnableSnapshotCopyMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EnableSnapshotCopyMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  cluster_identifier: "String", # required
  destination_region: "String", # required
  retention_period: 1,
  snapshot_copy_grant_name: "String",
  manual_snapshot_retention_period: 1,
}

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (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.

Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Returns:

  • (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. 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.

Returns:

  • (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.

Default: 7.

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

Returns:

  • (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.

Returns:

  • (String) —

    The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.