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

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 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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

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)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5407

class EnableSnapshotCopyMessage < Struct.new(
  :cluster_identifier,
  :destination_region,
  :retention_period,
  :snapshot_copy_grant_name,
  :manual_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#destination_regionString

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)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5407

class EnableSnapshotCopyMessage < Struct.new(
  :cluster_identifier,
  :destination_region,
  :retention_period,
  :snapshot_copy_grant_name,
  :manual_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#manual_snapshot_retention_periodInteger

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)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5407

class EnableSnapshotCopyMessage < Struct.new(
  :cluster_identifier,
  :destination_region,
  :retention_period,
  :snapshot_copy_grant_name,
  :manual_snapshot_retention_period)
  SENSITIVE = []
  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.

Default: 7.

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

Returns:

  • (Integer)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5407

class EnableSnapshotCopyMessage < Struct.new(
  :cluster_identifier,
  :destination_region,
  :retention_period,
  :snapshot_copy_grant_name,
  :manual_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_copy_grant_nameString

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)


5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5407

class EnableSnapshotCopyMessage < Struct.new(
  :cluster_identifier,
  :destination_region,
  :retention_period,
  :snapshot_copy_grant_name,
  :manual_snapshot_retention_period)
  SENSITIVE = []
  include Aws::Structure
end