class Aws::KMS::Types::ReplicateKeyRequest

@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReplicateKeyRequest AWS API Documentation
@return [Array<Types::Tag>] : docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html [2]: docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html [1]: docs.aws.amazon.com/kms/latest/developerguide/abac.html key. For details, see [Tags in KMS].
aggregated by tags. Tags can also be used to control access to a KMS
Services generates a cost allocation report with usage and costs
When you add tags to an Amazon Web Services resource, Amazon Web
value, KMS replaces the current tag value with the specified one.
tag key. If you specify an existing tag key with a different tag
string. You cannot have more than one tag on a KMS key with the same
the tag value are required, but the tag value can be an empty (null)
Each tag consists of a tag key and a tag value. Both the tag key and
multi-Region keys. KMS does not synchronize this property.
the same tags or different tags for each key in a set of related
Tags are not a shared property of multi-Region keys. You can specify
in an IAM policy.
To use this parameter, you must have [kms:TagResource] permission
</note>
Service Developer Guide*.
KMS key. For details, see [ABAC for KMS] in the *Key Management
<note markdown=“1”> Tagging or untagging a KMS key can allow or deny permission to the
other output.
This field may be displayed in plaintext in CloudTrail logs and
Do not include confidential or sensitive information in this field.
the TagResource operation.
tag the KMS key when it is created. To tag an existing KMS key, use
Assigns one or more tags to the replica key. Use this parameter to
@!attribute [rw] tags
@return [String]
this property.
key in a set of related multi-Region keys. KMS does not synchronize
can specify the same description or a different description for each
The description is not a shared property of multi-Region keys. You
other output.
This field may be displayed in plaintext in CloudTrail logs and
Do not include confidential or sensitive information in this field.
(no description).
A description of the KMS key. The default value is an empty string
@!attribute [rw] description
@return [Boolean] : docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html [1]: docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key [PutKeyPolicy][2] request on the KMS key.
that is making the request from making a subsequent
Use this parameter only when you intend to prevent the principal
Management Service Developer Guide*.
For more information, see [Default key policy] in the *Key
indiscriminately.
becomes unmanageable. Do not set this value to true
Setting this value to true increases the risk that the KMS key
default value is false.
Skips (“bypasses”) the key policy lockout safety check. The
@!attribute [rw] bypass_policy_lockout_safety_check
@return [String] : docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html [4]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency [2]: docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key [1]: docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html Guide . Reference] in the Identity and Access Management User
formatting a JSON policy document, see the [IAM JSON Policy
the *Key Management Service Developer Guide*. For help writing and
For information about key policies, see [Key policies in KMS] in
(‘u000D`) special characters
* The tab (`u0009`), line feed (`u000A`), and carriage return
character set (through `u00FF`).
* Printable characters in the Basic Latin and Latin-1 Supplement
through the end of the ASCII character range.
* Printable ASCII characters from the space character (`u0020`)
A key policy document can include only the following characters:
Web Services Identity and Access Management User Guide*.
that I make are not always immediately visible] in the *Amazon
be immediately visible to KMS. For more information, see [Changes
new principal in a key policy because the new principal might not
principal, you might need to enforce a delay before including the
visible to KMS. When you create a new Amazon Web Services
principals. The principals in the key policy must exist and be
* Each statement in the key policy must contain one or more
`BypassPolicyLockoutSafetyCheck` to true.)
Developer Guide*. (To omit this condition, set
see [Default key policy] in the *Key Management Service
risk that the KMS key becomes unmanageable. For more information,
subsequent `PutKeyPolicy` request on the KMS key. This reduces the
* The key policy must allow the calling principal to make a
If you provide a key policy, it must meet the following criteria:
this property.
key in a set of related multi-Region keys. KMS does not synchronize
can specify the same key policy or a different key policy for each
The key policy is not a shared property of multi-Region keys. You policy] to the KMS key.
If you do not provide a key policy, KMS attaches the [default key
The key policy to attach to the KMS key. This parameter is optional.
@!attribute [rw] policy
@return [String] : docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable [3]: docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [1]: docs.aws.amazon.com/general/latest/gr/kms.html#kms_region General Reference*. Region] and [Disabling a Region] in the *Amazon Web Services
information about enabling and disabling Regions, see [Enabling a (ARNs)] in the *Amazon Web Services General Reference*. For
about Amazon Web Services partitions, see [Amazon Resource Names
Web Services account must be enabled in the Region. For information
replica Region. If the Region is not enabled by default, the Amazon
same Amazon Web Services partition. KMS must be available in the
its primary key and other replicas of that primary key, but in the
The replica must be in a different Amazon Web Services Region than
Reference*.
[KMS service endpoints] in the *Amazon Web Services General
list of Amazon Web Services Regions in which KMS is supported, see
Enter the Region ID, such as `us-east-1` or `ap-southeast-2`. For a
key.
The Region ID of the Amazon Web Services Region for this replica
@!attribute [rw] replica_region
@return [String]
DescribeKey.
To get the key ID and key ARN for a KMS key, use ListKeys or
`arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab`
* Key ARN:
* Key ID: `mrk-1234abcd12ab34cd56ef1234567890ab`
For example:
Specify the key ID or key ARN of a multi-Region primary key.
property.
DescribeKey operation to check the value of the `MultiRegionKeyType`
determine whether a KMS key is a multi-Region primary key, use the
Identifies the multi-Region primary key that is being replicated. To
@!attribute [rw] key_id

class Aws::KMS::Types::ReplicateKeyRequest

Namespace

Included Modules

Defined in