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

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

Overview

[Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.

To specify a cross-Region copy action for event-based polices, use CrossRegionCopyAction.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cmk_arnString

The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used.

Returns:

  • (String)


450
451
452
453
454
455
456
457
458
459
460
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 450

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

#copy_tagsBoolean

Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.

Returns:

  • (Boolean)


450
451
452
453
454
455
456
457
458
459
460
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 450

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

#deprecate_ruleTypes::CrossRegionCopyDeprecateRule

[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.



450
451
452
453
454
455
456
457
458
459
460
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 450

class CrossRegionCopyRule < Struct.new(
  :target_region,
  :target,
  :encrypted,
  :cmk_arn,
  :copy_tags,
  :retain_rule,
  :deprecate_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)


450
451
452
453
454
455
456
457
458
459
460
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 450

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

#retain_ruleTypes::CrossRegionCopyRetainRule

The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.



450
451
452
453
454
455
456
457
458
459
460
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 450

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

#targetString

Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

[Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

Returns:

  • (String)


450
451
452
453
454
455
456
457
458
459
460
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 450

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

#target_regionString

Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies.

[Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.

Returns:

  • (String)


450
451
452
453
454
455
456
457
458
459
460
# File 'gems/aws-sdk-dlm/lib/aws-sdk-dlm/types.rb', line 450

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