CreateKeyRequest
Types
Properties
Skips ("bypasses") the key policy lockout safety check. The default value is false.
Instead, use the KeySpec
parameter.
Creates the KMS key in the specified custom key store. The ConnectionState
of the custom key store must be CONNECTED
. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
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).
Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT
, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For a detailed description of all supported key specs, see Key spec reference in the Key Management Service Developer Guide.
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.
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.
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.
Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.