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",
  target: "Target",
  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)


401
402
403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 401

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :target,
  :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)


401
402
403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 401

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :target,
  :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)


401
402
403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 401

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

#retain_ruleTypes::CrossRegionCopyRetainRule

The retention rule.



401
402
403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 401

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

#targetString

The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.

If you specify an ARN, you must omit TargetRegion. You cannot specify a target Region and a target Outpost in the same rule.

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 401

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

#target_regionString

The target Region for the snapshot copies.

If you specify a target Region, you must omit Target. You cannot specify a target Region and a target Outpost in the same rule.

Returns:

  • (String)


401
402
403
404
405
406
407
408
409
410
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 401

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