Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.KMS.ReplicateKey

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 Using multi-Region keys 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 state. 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 state: Effect on your KMS key in the Key Management Service Developer Guide.

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:ReplicateKey on the primary key (in the primary key's Region). Include this permission in the primary key's key policy.
kms:CreateKey in an IAM policy in the replica Region.
To use the Tags parameter, kms:TagResource in an IAM policy in the replica Region.

Related operations

CreateKey
UpdatePrimaryRegion

Synopsis

data ReplicateKey = ReplicateKey' {
- bypassPolicyLockoutSafetyCheck :: Maybe Bool
- policy :: Maybe Text
- description :: Maybe Text
- tags :: Maybe [Tag]
- keyId :: Text
- replicaRegion :: Text
}
newReplicateKey :: Text -> Text -> ReplicateKey
replicateKey_bypassPolicyLockoutSafetyCheck :: Lens' ReplicateKey (Maybe Bool)
replicateKey_policy :: Lens' ReplicateKey (Maybe Text)
replicateKey_description :: Lens' ReplicateKey (Maybe Text)
replicateKey_tags :: Lens' ReplicateKey (Maybe [Tag])
replicateKey_keyId :: Lens' ReplicateKey Text
replicateKey_replicaRegion :: Lens' ReplicateKey Text
data ReplicateKeyResponse = ReplicateKeyResponse' {
- replicaKeyMetadata :: Maybe KeyMetadata
- replicaPolicy :: Maybe Text
- replicaTags :: Maybe [Tag]
- httpStatus :: Int
}
newReplicateKeyResponse :: Int -> ReplicateKeyResponse
replicateKeyResponse_replicaKeyMetadata :: Lens' ReplicateKeyResponse (Maybe KeyMetadata)
replicateKeyResponse_replicaPolicy :: Lens' ReplicateKeyResponse (Maybe Text)
replicateKeyResponse_replicaTags :: Lens' ReplicateKeyResponse (Maybe [Tag])
replicateKeyResponse_httpStatus :: Lens' ReplicateKeyResponse Int

Creating a Request

data ReplicateKey Source #

See: newReplicateKey smart constructor.

Constructors

ReplicateKey'

Fields

bypassPolicyLockoutSafetyCheck :: Maybe Bool
A flag to indicate whether to bypass the key policy lockout safety check.
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, refer to the scenario in the Default Key Policy section 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.
The default value is false.
policy :: Maybe Text
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:
- If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the /Key Management Service Developer Guide/ .
- 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 (for example, an IAM user or role), 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 /Identity and Access Management User Guide/ .
- The key policy size quota is 32 kilobytes (32768 bytes).
description :: Maybe Text
A description of the KMS key. The default value is an empty string (no description).
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.
tags :: Maybe [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.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
keyId :: Text
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.
replicaRegion :: Text
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 in the Amazon Web Services General Reference.
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.

Instances

Instances details

Eq ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods (==) :: ReplicateKey -> ReplicateKey -> Bool # (/=) :: ReplicateKey -> ReplicateKey -> Bool #
Read ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods readsPrec :: Int -> ReadS ReplicateKey # readList :: ReadS [ReplicateKey] # readPrec :: ReadPrec ReplicateKey # readListPrec :: ReadPrec [ReplicateKey] #
Show ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods showsPrec :: Int -> ReplicateKey -> ShowS # show :: ReplicateKey -> String # showList :: [ReplicateKey] -> ShowS #
Generic ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Associated Types type Rep ReplicateKey :: Type -> Type # Methods from :: ReplicateKey -> Rep ReplicateKey x # to :: Rep ReplicateKey x -> ReplicateKey #
NFData ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods rnf :: ReplicateKey -> () #
Hashable ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods hashWithSalt :: Int -> ReplicateKey -> Int # hash :: ReplicateKey -> Int #
ToJSON ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods toJSON :: ReplicateKey -> Value # toEncoding :: ReplicateKey -> Encoding # toJSONList :: [ReplicateKey] -> Value # toEncodingList :: [ReplicateKey] -> Encoding #
AWSRequest ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Associated Types type AWSResponse ReplicateKey # Methods request :: ReplicateKey -> Request ReplicateKey # response :: MonadResource m => Logger -> Service -> Proxy ReplicateKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReplicateKey))) #
ToHeaders ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods toHeaders :: ReplicateKey -> [Header] #
ToPath ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods toPath :: ReplicateKey -> ByteString #
ToQuery ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods toQuery :: ReplicateKey -> QueryString #
type Rep ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey type Rep ReplicateKey = D1 ('MetaData "ReplicateKey" "Amazonka.KMS.ReplicateKey" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "ReplicateKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bypassPolicyLockoutSafetyCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "replicaRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ReplicateKey Source #
Instance details Defined in Amazonka.KMS.ReplicateKey type AWSResponse ReplicateKey = ReplicateKeyResponse

newReplicateKey Source #

Arguments

:: Text	`$sel:keyId:ReplicateKey'`
-> Text	`$sel:replicaRegion:ReplicateKey'`
-> ReplicateKey

Create a value of ReplicateKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bypassPolicyLockoutSafetyCheck:ReplicateKey', replicateKey_bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.

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, refer to the scenario in the Default Key Policy section 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.

The default value is false.

$sel:policy:ReplicateKey', replicateKey_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:

If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the /Key Management Service Developer Guide/ .
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 (for example, an IAM user or role), 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 /Identity and Access Management User Guide/ .
The key policy size quota is 32 kilobytes (32768 bytes).

$sel:description:ReplicateKey', replicateKey_description - A description of the KMS key. The default value is an empty string (no description).

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.

$sel:tags:ReplicateKey', replicateKey_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.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.

$sel:keyId:ReplicateKey', replicateKey_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 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.

$sel:replicaRegion:ReplicateKey', replicateKey_replicaRegion - 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 in the Amazon Web Services General Reference.

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.

Request Lenses

replicateKey_bypassPolicyLockoutSafetyCheck :: Lens' ReplicateKey (Maybe Bool) Source #

A flag to indicate whether to bypass the key policy lockout safety check.

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, refer to the scenario in the Default Key Policy section 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.

The default value is false.

replicateKey_policy :: Lens' ReplicateKey (Maybe Text) Source #

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:

If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the /Key Management Service Developer Guide/ .
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 (for example, an IAM user or role), 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 /Identity and Access Management User Guide/ .
The key policy size quota is 32 kilobytes (32768 bytes).

replicateKey_description :: Lens' ReplicateKey (Maybe Text) Source #

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

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.

replicateKey_tags :: Lens' ReplicateKey (Maybe [Tag]) Source #

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.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.

replicateKey_keyId :: Lens' ReplicateKey Text Source #

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.

replicateKey_replicaRegion :: Lens' ReplicateKey Text Source #

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 in the Amazon Web Services General Reference.

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.

Destructuring the Response

data ReplicateKeyResponse Source #

See: newReplicateKeyResponse smart constructor.

Constructors

ReplicateKeyResponse'

Fields

replicaKeyMetadata :: Maybe KeyMetadata
Displays details about the new replica key, including its Amazon Resource Name (key ARN) and key state. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.
replicaPolicy :: Maybe Text
The key policy of the new replica key. The value is a key policy document in JSON format.
replicaTags :: Maybe [Tag]
The tags on the new replica key. The value is a list of tag key and tag value pairs.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ReplicateKeyResponse Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods (==) :: ReplicateKeyResponse -> ReplicateKeyResponse -> Bool # (/=) :: ReplicateKeyResponse -> ReplicateKeyResponse -> Bool #
Read ReplicateKeyResponse Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods readsPrec :: Int -> ReadS ReplicateKeyResponse # readList :: ReadS [ReplicateKeyResponse] # readPrec :: ReadPrec ReplicateKeyResponse # readListPrec :: ReadPrec [ReplicateKeyResponse] #
Show ReplicateKeyResponse Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods showsPrec :: Int -> ReplicateKeyResponse -> ShowS # show :: ReplicateKeyResponse -> String # showList :: [ReplicateKeyResponse] -> ShowS #
Generic ReplicateKeyResponse Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Associated Types type Rep ReplicateKeyResponse :: Type -> Type # Methods from :: ReplicateKeyResponse -> Rep ReplicateKeyResponse x # to :: Rep ReplicateKeyResponse x -> ReplicateKeyResponse #
NFData ReplicateKeyResponse Source #
Instance details Defined in Amazonka.KMS.ReplicateKey Methods rnf :: ReplicateKeyResponse -> () #
type Rep ReplicateKeyResponse Source #
Instance details Defined in Amazonka.KMS.ReplicateKey type Rep ReplicateKeyResponse = D1 ('MetaData "ReplicateKeyResponse" "Amazonka.KMS.ReplicateKey" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "ReplicateKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "replicaKeyMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyMetadata)) :: S1 ('MetaSel ('Just "replicaPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "replicaTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newReplicateKeyResponse Source #

Arguments

:: Int	`$sel:httpStatus:ReplicateKeyResponse'`
-> ReplicateKeyResponse

Create a value of ReplicateKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:replicaKeyMetadata:ReplicateKeyResponse', replicateKeyResponse_replicaKeyMetadata - Displays details about the new replica key, including its Amazon Resource Name (key ARN) and key state. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

$sel:replicaPolicy:ReplicateKeyResponse', replicateKeyResponse_replicaPolicy - The key policy of the new replica key. The value is a key policy document in JSON format.

$sel:replicaTags:ReplicateKeyResponse', replicateKeyResponse_replicaTags - The tags on the new replica key. The value is a list of tag key and tag value pairs.

$sel:httpStatus:ReplicateKeyResponse', replicateKeyResponse_httpStatus - The response's http status code.

Response Lenses

replicateKeyResponse_replicaKeyMetadata :: Lens' ReplicateKeyResponse (Maybe KeyMetadata) Source #

Displays details about the new replica key, including its Amazon Resource Name (key ARN) and key state. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

replicateKeyResponse_replicaPolicy :: Lens' ReplicateKeyResponse (Maybe Text) Source #

The key policy of the new replica key. The value is a key policy document in JSON format.

replicateKeyResponse_replicaTags :: Lens' ReplicateKeyResponse (Maybe [Tag]) Source #

The tags on the new replica key. The value is a list of tag key and tag value pairs.

replicateKeyResponse_httpStatus :: Lens' ReplicateKeyResponse Int Source #

The response's http status code.