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

Inherits:

Struct

• Object
• Struct
• Aws::DLM::Types::CrossRegionCopyRule

Includes:

Structure

Defined in:

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.

<note markdown=“1”> To specify a cross-Region copy action for event-based polices, use [CrossRegionCopyAction].

</note>

[1]: docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cmk_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption.

• #copy_tags ⇒ Boolean

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

• #deprecate_rule ⇒ Types::CrossRegionCopyDeprecateRule

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

• #encrypted ⇒ Boolean

  To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter.

• #retain_rule ⇒ Types::CrossRegionCopyRetainRule

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

• #target ⇒ String

  <note markdown=“1”> Use this parameter for snapshot policies only.

• #target_region ⇒ String

  <note markdown=“1”> Use this parameter for AMI policies only.

Instance Attribute Details

#cmk_arn ⇒ String

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)

# File '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_tags ⇒ Boolean

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

Returns:

• (Boolean)

# File '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_rule ⇒ Types::CrossRegionCopyDeprecateRule

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

Returns:

• (Types::CrossRegionCopyDeprecateRule)

# File '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

#encrypted ⇒ Boolean

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)

# File '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_rule ⇒ Types::CrossRegionCopyRetainRule

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

Returns:

• (Types::CrossRegionCopyRetainRule)

# File '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 ⇒ String

<note markdown=“1”> Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead.

</note>

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

Returns:

• (String)

# File '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_region ⇒ String

<note markdown=“1”> 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.

</note>

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

Returns:

• (String)

# File '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