public static interface CreateKeyRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateKeyRequest.Builder |
bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
|
CreateKeyRequest.Builder |
customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
Deprecated.
This parameter has been deprecated. Instead, use the KeySpec parameter.
|
CreateKeyRequest.Builder |
customerMasterKeySpec(String customerMasterKeySpec)
Deprecated.
This parameter has been deprecated. Instead, use the KeySpec parameter.
|
CreateKeyRequest.Builder |
customKeyStoreId(String customKeyStoreId)
Creates the KMS key in the specified custom key
store and the key material in its associated CloudHSM cluster.
|
CreateKeyRequest.Builder |
description(String description)
A description of the KMS key.
|
CreateKeyRequest.Builder |
keySpec(KeySpec keySpec)
Specifies the type of KMS key to create.
|
CreateKeyRequest.Builder |
keySpec(String keySpec)
Specifies the type of KMS key to create.
|
CreateKeyRequest.Builder |
keyUsage(KeyUsageType keyUsage)
Determines the cryptographic operations for which you can use the KMS key.
|
CreateKeyRequest.Builder |
keyUsage(String keyUsage)
Determines the cryptographic operations for which you can use the KMS key.
|
CreateKeyRequest.Builder |
multiRegion(Boolean multiRegion)
Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions.
|
CreateKeyRequest.Builder |
origin(OriginType origin)
The source of the key material for the KMS key.
|
CreateKeyRequest.Builder |
origin(String origin)
The source of the key material for the KMS key.
|
CreateKeyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateKeyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateKeyRequest.Builder |
policy(String policy)
The key policy to attach to the KMS key.
|
CreateKeyRequest.Builder |
tags(Collection<Tag> tags)
Assigns one or more tags to the KMS key.
|
CreateKeyRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Assigns one or more tags to the KMS key.
|
CreateKeyRequest.Builder |
tags(Tag... tags)
Assigns one or more tags to the KMS key.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateKeyRequest.Builder policy(String policy)
The key policy to attach to the KMS key. If you do not specify a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to True, the key policy must allow
the principal that is making the CreateKey request to make a subsequent PutKeyPolicy
request on the KMS 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 Amazon Web Services Identity and Access Management User Guide.
A key policy document must conform to the following rules.
Up to 32 kilobytes (32768 bytes)
Must be UTF-8 encoded
The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.
The Sid element in a key policy statement can include spaces. (Spaces are prohibited in the
Sid element of an IAM policy document.)
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
policy - The key policy to attach to the KMS key. If you do not specify a key policy, KMS attaches a default
key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to True, the key policy must
allow the principal that is making the CreateKey request to make a subsequent
PutKeyPolicy request on the KMS 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 Amazon Web Services Identity and Access Management User Guide.
A key policy document must conform to the following rules.
Up to 32 kilobytes (32768 bytes)
Must be UTF-8 encoded
The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.
The Sid element in a key policy statement can include spaces. (Spaces are prohibited in
the Sid element of an IAM policy document.)
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
CreateKeyRequest.Builder description(String description)
A description of the KMS key.
Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).
To set or change the description after the key is created, use UpdateKeyDescription.
description - A description of the KMS key.
Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).
To set or change the description after the key is created, use UpdateKeyDescription.
CreateKeyRequest.Builder keyUsage(String keyUsage)
Determines the cryptographic operations for which you can use the KMS key. The default value is
ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS
key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is
created.
Select only one valid value.
For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or
SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is
ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption
KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key
is created.
Select only one valid value.
For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or
SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
KeyUsageType,
KeyUsageTypeCreateKeyRequest.Builder keyUsage(KeyUsageType keyUsage)
Determines the cryptographic operations for which you can use the KMS key. The default value is
ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS
key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is
created.
Select only one valid value.
For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or
SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is
ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption
KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key
is created.
Select only one valid value.
For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or
SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
KeyUsageType,
KeyUsageType@Deprecated CreateKeyRequest.Builder customerMasterKeySpec(String customerMasterKeySpec)
Instead, use the KeySpec parameter.
The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
changes, KMS will support both parameters.
customerMasterKeySpec - Instead, use the KeySpec parameter.
The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the
names differ. We recommend that you use KeySpec parameter in your code. However, to avoid
breaking changes, KMS will support both parameters.
CustomerMasterKeySpec,
CustomerMasterKeySpec@Deprecated CreateKeyRequest.Builder customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
Instead, use the KeySpec parameter.
The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
changes, KMS will support both parameters.
customerMasterKeySpec - Instead, use the KeySpec parameter.
The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the
names differ. We recommend that you use KeySpec parameter in your code. However, to avoid
breaking changes, KMS will support both parameters.
CustomerMasterKeySpec,
CustomerMasterKeySpecCreateKeyRequest.Builder keySpec(String keySpec)
Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key,
see Choosing
a KMS key type in the Key Management Service Developer Guide .
The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair.
It also determines the cryptographic algorithms that the KMS key supports. You can't change the
KeySpec after the KMS key is created. To further restrict the algorithms that can be used with
the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
KMS supports the following key specs for KMS keys:
Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a
KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for
your KMS key, see Choosing
a KMS key type in the Key Management Service Developer Guide .
The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key
pair. It also determines the cryptographic algorithms that the KMS key supports. You can't change the
KeySpec after the KMS key is created. To further restrict the algorithms that can be used
with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
KMS supports the following key specs for KMS keys:
Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
KeySpec,
KeySpecCreateKeyRequest.Builder keySpec(KeySpec keySpec)
Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key,
see Choosing
a KMS key type in the Key Management Service Developer Guide .
The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair.
It also determines the cryptographic algorithms that the KMS key supports. You can't change the
KeySpec after the KMS key is created. To further restrict the algorithms that can be used with
the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
KMS supports the following key specs for KMS keys:
Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a
KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for
your KMS key, see Choosing
a KMS key type in the Key Management Service Developer Guide .
The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key
pair. It also determines the cryptographic algorithms that the KMS key supports. You can't change the
KeySpec after the KMS key is created. To further restrict the algorithms that can be used
with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
KMS supports the following key specs for KMS keys:
Symmetric encryption key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
KeySpec,
KeySpecCreateKeyRequest.Builder origin(String origin)
The source of the key material for the KMS key. You cannot change the origin after you create the KMS key.
The default is AWS_KMS, which means that KMS creates the key material.
To create a KMS key with no key material (for imported key material), set the value to EXTERNAL.
For more information about importing key material into KMS, see Importing Key Material
in the Key Management Service Developer Guide. This value is valid only for symmetric encryption KMS
keys.
To create a KMS key in an KMS custom key
store and create its key material in the associated CloudHSM cluster, set this value to
AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the
custom key store. This value is valid only for symmetric encryption KMS keys.
origin - The source of the key material for the KMS key. You cannot change the origin after you create the KMS
key. The default is AWS_KMS, which means that KMS creates the key material.
To create a KMS key with no key material (for imported key material), set the value to
EXTERNAL. For more information about importing key material into KMS, see Importing Key
Material in the Key Management Service Developer Guide. This value is valid only for
symmetric encryption KMS keys.
To create a KMS key in an KMS custom key
store and create its key material in the associated CloudHSM cluster, set this value to
AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify
the custom key store. This value is valid only for symmetric encryption KMS keys.
OriginType,
OriginTypeCreateKeyRequest.Builder origin(OriginType origin)
The source of the key material for the KMS key. You cannot change the origin after you create the KMS key.
The default is AWS_KMS, which means that KMS creates the key material.
To create a KMS key with no key material (for imported key material), set the value to EXTERNAL.
For more information about importing key material into KMS, see Importing Key Material
in the Key Management Service Developer Guide. This value is valid only for symmetric encryption KMS
keys.
To create a KMS key in an KMS custom key
store and create its key material in the associated CloudHSM cluster, set this value to
AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the
custom key store. This value is valid only for symmetric encryption KMS keys.
origin - The source of the key material for the KMS key. You cannot change the origin after you create the KMS
key. The default is AWS_KMS, which means that KMS creates the key material.
To create a KMS key with no key material (for imported key material), set the value to
EXTERNAL. For more information about importing key material into KMS, see Importing Key
Material in the Key Management Service Developer Guide. This value is valid only for
symmetric encryption KMS keys.
To create a KMS key in an KMS custom key
store and create its key material in the associated CloudHSM cluster, set this value to
AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify
the custom key store. This value is valid only for symmetric encryption KMS keys.
OriginType,
OriginTypeCreateKeyRequest.Builder customKeyStoreId(String customKeyStoreId)
Creates the KMS key in the specified custom key
store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store,
you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The
CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a
different Availability Zone in the Region.
This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
customKeyStoreId - Creates the KMS key in the specified custom key
store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key
store, you must also specify the Origin parameter with a value of
AWS_CLOUDHSM. The CloudHSM cluster that is associated with the custom key store must have
at least two active HSMs, each in a different Availability Zone in the Region.
This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
CreateKeyRequest.Builder bypassPolicyLockoutSafetyCheck(Boolean 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 include a policy in the request and 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.
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 include a policy in the request and 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.
CreateKeyRequest.Builder tags(Collection<Tag> tags)
Assigns one or more tags to the KMS 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 ABAC in KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
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.
tags - Assigns one or more tags to the KMS 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 ABAC in KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
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.
CreateKeyRequest.Builder tags(Tag... tags)
Assigns one or more tags to the KMS 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 ABAC in KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
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.
tags - Assigns one or more tags to the KMS 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 ABAC in KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
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.
CreateKeyRequest.Builder tags(Consumer<Tag.Builder>... tags)
Assigns one or more tags to the KMS 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 ABAC in KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
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.
This is a convenience method that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateKeyRequest.Builder multiRegion(Boolean multiRegion)
Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.
For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this
parameter or set it to False. The default value is False.
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.
This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
You can create a multi-Region version of a symmetric encryption KMS key, an HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material. However, you cannot create a multi-Region key in a custom key store.
multiRegion - Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
cannot change this value after you create the KMS key.
For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit
this parameter or set it to False. The default value is False.
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.
This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
You can create a multi-Region version of a symmetric encryption KMS key, an HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material. However, you cannot create a multi-Region key in a custom key store.
CreateKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.