Creates a customer master key (CMK) in the caller's AWS account.
kms_create_key(Policy, Description, KeyUsage, Origin, CustomKeyStoreId,
BypassPolicyLockoutSafetyCheck, Tags)The key policy to attach to the CMK.
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 CMK. This
reduces the risk that the CMK becomes unmanageable. For more
information, refer to the scenario in the Default Key Policy
section of the AWS 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 AWS KMS. When you create a new AWS 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size limit is 32 kilobytes (32768 bytes).
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
The source of the CMK's key material. You cannot change the origin after you create the CMK.
The default is AWS_KMS, which means AWS KMS creates the key material
in its own key store.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without
key material so that you can import key material from your existing key
management infrastructure. For more information about importing key
material into AWS KMS, see Importing Key Material
in the AWS Key Management Service Developer Guide.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in a
AWS KMS custom key store
and creates its key material in the associated AWS CloudHSM cluster. You
must also use the CustomKeyStoreId parameter to identify the custom
key store.
Creates the CMK in the specified custom key store
and the key material in its associated AWS CloudHSM cluster. To create a
CMK in a custom key store, you must also specify the Origin parameter
with a value of AWS_CLOUDHSM. The AWS 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.
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 AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the CMK 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 AWS 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 CMK.
The default value is false.
One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
svc$create_key(
Policy = "string",
Description = "string",
KeyUsage = "ENCRYPT_DECRYPT",
Origin = "AWS_KMS"|"EXTERNAL"|"AWS_CLOUDHSM",
CustomKeyStoreId = "string",
BypassPolicyLockoutSafetyCheck = TRUE|FALSE,
Tags = list(
list(
TagKey = "string",
TagValue = "string"
)
)
)
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data keys, which are used to encrypt raw data. For more information about data keys and the difference between CMKs and data keys, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
If you plan to import key material,
use the Origin parameter with a value of EXTERNAL to create a CMK
with no key material.
To create a CMK in a custom key store,
use CustomKeyStoreId parameter to specify the custom key store. You
must also use the Origin parameter with a value of AWS_CLOUDHSM. The
AWS 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.
You cannot use this operation to create a CMK in a different AWS account.
# NOT RUN {
# The following example creates a CMK.
# }
# NOT RUN {
svc$create_key(
Tags = list(
list(
TagKey = "CreatedBy",
TagValue = "ExampleUser"
)
)
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataCamp Workspace