Class: Aws::KMS::Types::ReplicateKeyRequest

Inherits:

Struct

Object
Struct
Aws::KMS::Types::ReplicateKeyRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-kms/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bypass_policy_lockout_safety_check ⇒ Boolean

Skips (“bypasses”) the key policy lockout safety check.
#description ⇒ String

A description of the KMS key.
#key_id ⇒ String

Identifies the multi-Region primary key that is being replicated.
#policy ⇒ String

The key policy to attach to the KMS key.
#replica_region ⇒ String

The Region ID of the Amazon Web Services Region for this replica key.
#tags ⇒ Array<Types::Tag>

Assigns one or more tags to the replica key.

Instance Attribute Details

#bypass_policy_lockout_safety_check ⇒ `Boolean`

Skips (“bypasses”) the key policy lockout safety check. The default value is false.

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

For more information, see [Default key policy][1] in the *Key

Management Service Developer Guide*.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent

PutKeyPolicy][2: request on the KMS key.

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key [2]: docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html

Returns:

(Boolean)

# File 'lib/aws-sdk-kms/types.rb', line 5532

class ReplicateKeyRequest < Struct.new(
  :key_id,
  :replica_region,
  :policy,
  :bypass_policy_lockout_safety_check,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description of the KMS key. The default value is an empty string (no description).

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 5532

class ReplicateKeyRequest < Struct.new(
  :key_id,
  :replica_region,
  :policy,
  :bypass_policy_lockout_safety_check,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ `String`

Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the ‘MultiRegionKeyType` property.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

Key ID: ‘mrk-1234abcd12ab34cd56ef1234567890ab`
Key ARN: ‘arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab`

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 5532

class ReplicateKeyRequest < Struct.new(
  :key_id,
  :replica_region,
  :policy,
  :bypass_policy_lockout_safety_check,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ `String`

The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the [default key policy] to the KMS key.

The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.

If you provide a key policy, it must meet the following criteria:

The key policy must allow the calling principal to make a subsequent ‘PutKeyPolicy` request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy] in the *Key Management Service Developer Guide*. (To omit this condition, set `BypassPolicyLockoutSafetyCheck` to true.)
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible] in the *Amazon Web Services Identity and Access Management User Guide*.

A key policy document can include only the following characters:

Printable ASCII characters from the space character (‘u0020`) through the end of the ASCII character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through ‘u00FF`).
The tab (‘u0009`), line feed (`u000A`), and carriage return (`u000D`) special characters

For information about key policies, see [Key policies in KMS] in the *Key Management Service Developer Guide*. For help writing and formatting a JSON policy document, see the [IAM JSON Policy Reference] in the Identity and Access Management User Guide .

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default [2]: docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key [3]: docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency [4]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html [5]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 5532

class ReplicateKeyRequest < Struct.new(
  :key_id,
  :replica_region,
  :policy,
  :bypass_policy_lockout_safety_check,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#replica_region ⇒ `String`

The Region ID of the Amazon Web Services Region for this replica key.

Enter the Region ID, such as ‘us-east-1` or `ap-southeast-2`. For a list of Amazon Web Services Regions in which KMS is supported, see

KMS service endpoints][1: in the *Amazon Web Services General

Reference*.

<note markdown=“1”> HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the ‘ReplicateKey` operation returns an `UnsupportedOperationException`. For a list of Regions in which HMAC KMS keys are supported, see [HMAC keys in KMS] in the *Key Management Service Developer Guide*.

</note>

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region. For information about Amazon Web Services partitions, see [Amazon Resource Names (ARNs)] in the *Amazon Web Services General Reference*. For information about enabling and disabling Regions, see [Enabling a Region] and [Disabling a Region] in the *Amazon Web Services General Reference*.

[1]: docs.aws.amazon.com/general/latest/gr/kms.html#kms_region [2]: docs.aws.amazon.com/kms/latest/developerguide/hmac.html [3]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [4]: docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable [5]: docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 5532

class ReplicateKeyRequest < Struct.new(
  :key_id,
  :replica_region,
  :policy,
  :bypass_policy_lockout_safety_check,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

<note markdown=“1”> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for KMS] in the *Key Management Service Developer Guide*.

</note>

To use this parameter, you must have [kms:TagResource] permission in an IAM policy.

Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see [Tagging Keys].

[1]: docs.aws.amazon.com/kms/latest/developerguide/abac.html [2]: docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html [3]: docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-kms/types.rb', line 5532

class ReplicateKeyRequest < Struct.new(
  :key_id,
  :replica_region,
  :policy,
  :bypass_policy_lockout_safety_check,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::KMS::Types::ReplicateKeyRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_policy_lockout_safety_check ⇒ Boolean

#description ⇒ String

#key_id ⇒ String

#policy ⇒ String

#replica_region ⇒ String

#tags ⇒ Array<Types::Tag>

#bypass_policy_lockout_safety_check ⇒ `Boolean`

#description ⇒ `String`

#key_id ⇒ `String`

#policy ⇒ `String`

#replica_region ⇒ `String`

#tags ⇒ `Array<Types::Tag>`