Container for the parameters to the ReplicateKey operation. Replicates a multi-Region key into the specified Region. This operation creates a multi-Region replica key based on a multi-Region primary key in a different Region of the same Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a different Region. To create a multi-Region primary key, use the CreateKey operation.
This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
A replica key is a fully-functional KMS key that can be used independently of its primary and peer replica keys. A primary key and its replica keys share properties that make them interoperable. They have the same key ID and key material. They also have the same key spec, key usage, key material origin, and automatic key rotation status. KMS automatically synchronizes these shared properties among related multi-Region keys. All other properties of a replica key can differ, including its key policy, tags, aliases, and Key states of KMS keys. KMS pricing and quotas for KMS keys apply to each primary key and replica key.
When this operation completes, the new replica key has a transient key state of Creating.
This key state changes to Enabled (or PendingImport) after a few seconds
when the process of creating the new replica key is complete. While the key state
is Creating, you can manage key, but you cannot yet use it in cryptographic
operations. If you are creating and using the replica key programmatically, retry
on KMSInvalidStateException or call DescribeKey to check its KeyState
value before using it. For details about the Creating key state, see Key
states of KMS keys in the Key Management Service Developer Guide.
You cannot create more than one replica of a primary key in any Region. If the Region
already includes a replica of the key you're trying to replicate, ReplicateKey
returns an AlreadyExistsException error. If the key state of the existing replica
is PendingDeletion, you can cancel the scheduled key deletion (CancelKeyDeletion)
or wait for the key to be deleted. The new replica key you create will have the same
shared
properties as the original replica key.
The CloudTrail log of a ReplicateKey operation records a ReplicateKey
operation in the primary key's Region and a CreateKey operation in the replica
key's Region.
If you replicate a multi-Region primary key with imported key material, the replica key is created with no key material. You must import the same key material that you imported into the primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.
To convert a replica key to a primary key, use the UpdatePrimaryRegion operation.
ReplicateKey uses different default values for the KeyPolicy and Tags
parameters than those used in the KMS console. For details, see the parameter descriptions.
Cross-account use: No. You cannot use this operation to create a replica key in a different Amazon Web Services account.
Required permissions:
kms:ReplicateKeyon the primary key (in the primary key's Region). Include this permission in the primary key's key policy.kms:CreateKeyin an IAM policy in the replica Region.To use the
Tagsparameter,kms:TagResourcein an IAM policy in the replica Region.
Related operations
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.ReplicateKeyRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class ReplicateKeyRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The ReplicateKeyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ReplicateKeyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BypassPolicyLockoutSafetyCheck | System.Boolean |
Gets and sets the property BypassPolicyLockoutSafetyCheck. 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 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 request on the KMS key. |
|
|
Description | System.String |
Gets and sets the property Description. 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. |
|
|
KeyId | System.String |
Gets and sets the property KeyId.
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 Specify the key ID or key ARN of a multi-Region primary key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
Policy | System.String |
Gets and sets the property Policy. 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:
A key policy document can include only the following 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. |
|
|
ReplicaRegion | System.String |
Gets and sets the property ReplicaRegion. The Region ID of the Amazon Web Services Region for this replica key.
Enter the Region ID, such as
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 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. |
|
|
Tags | System.Collections.Generic.List<Amazon.KeyManagementService.Model.Tag> |
Gets and sets the property Tags. 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. 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. 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. |
Examples
This example creates a multi-Region replica key in us-west-2 of a multi-Region primary key in us-east-1.
To replicate a multi-Region key in a different AWS Region
var client = new AmazonKeyManagementServiceClient();
var response = client.ReplicateKey(new ReplicateKeyRequest
{
KeyId = "arn:aws:kms:us-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab", // The key ID or key ARN of the multi-Region primary key
ReplicaRegion = "us-west-2" // The Region of the new replica.
});
KeyMetadata replicaKeyMetadata = response.ReplicaKeyMetadata; // An object that displays detailed information about the replica key.
string replicaPolicy = response.ReplicaPolicy; // The key policy of the replica key. If you don't specify a key policy, the replica key gets the default key policy for a KMS key.
List<Tag> replicaTags = response.ReplicaTags; // The tags on the replica key, if any.
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5