Class: Aws::DLM::Types::CrossRegionCopyRule

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb

Overview

Note:

When making an API call, you may pass CrossRegionCopyRule data as a hash:

{
  target_region: "TargetRegion", # required
  encrypted: false, # required
  cmk_arn: "CmkArn",
  copy_tags: false,
  retain_rule: {
    interval: 1,
    interval_unit: "DAYS", # accepts DAYS, WEEKS, MONTHS, YEARS
  },
}

Specifies a rule for cross-Region snapshot copies.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cmk_arnString

The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

Returns:

  • (String)


369
370
371
372
373
374
375
376
377
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 369

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :encrypted,
  :cmk_arn,
  :copy_tags,
  :retain_rule)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tagsBoolean

Copy all user-defined tags from the source snapshot to the copied snapshot.

Returns:

  • (Boolean)


369
370
371
372
373
374
375
376
377
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 369

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :encrypted,
  :cmk_arn,
  :copy_tags,
  :retain_rule)
  SENSITIVE = []
  include Aws::Structure
end

#encryptedBoolean

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.

Returns:

  • (Boolean)


369
370
371
372
373
374
375
376
377
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 369

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :encrypted,
  :cmk_arn,
  :copy_tags,
  :retain_rule)
  SENSITIVE = []
  include Aws::Structure
end

#retain_ruleTypes::CrossRegionCopyRetainRule

The retention rule.



369
370
371
372
373
374
375
376
377
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 369

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :encrypted,
  :cmk_arn,
  :copy_tags,
  :retain_rule)
  SENSITIVE = []
  include Aws::Structure
end

#target_regionString

The target Region.

Returns:

  • (String)


369
370
371
372
373
374
375
376
377
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 369

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :encrypted,
  :cmk_arn,
  :copy_tags,
  :retain_rule)
  SENSITIVE = []
  include Aws::Structure
end