IKMSCreateKeyRequest
Interface in AWS.KMS
Interface for CreateKey requests.
Ancestors
Properties
BypassPolicyLockoutSafetyCheck
property BypassPolicyLockoutSafetyCheck: TOptional<Boolean>
Specify whether to bypass the key policy lockout safety check.
CustomKeyStoreId
property CustomKeyStoreId: string
Specify a custom key store to create the key and material.
To create a KMS key in a custom key store, you must also specify Origin with a value of AWS_CLOUDHSM.
Description
property Description: string
Specify a description for the KMS key.
KeySpec
property KeySpec: string
Specify the type of KMS key to create.
The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AWS-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. Valid values: RSA_2048 | RSA_3072 | RSA_4096 | ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | SYMMETRIC_DEFAULT | HMAC_224 | HMAC_256 | HMAC_384 | HMAC_512 | SM2.
KeyUsage
property KeyUsage: string
Specify the cryptographic operations for which you can use the KMS key.
Default value: ENCRYPT_DECRYPT. Valid values: SIGN_VERIFY | ENCRYPT_DECRYPT | GENERATE_VERIFY_MAC.
MultiRegion
property MultiRegion: TOptional<Boolean>
Specify whether to create a multi-region primary key that you can replicate into other AWS regions.
This value cannot be changed after creation.
Origin
property Origin: string
Specify the source of the key material for the KMS key.
This value cannot be changed after creation.
Policy
property Policy: string
Specify the key policy to attach to the KMS key.
If not specified, AWS KMS attaches a default key policy to the KMS key.
Tags
property Tags: TList<IKMSTag>
Type: IKMSTag
Specify a list of tags to attach to the KMS key.
Methods
AddTag
function AddTag(const ATagKey, ATagValue: string): Integer;
Add a tag to Tags.
Parameters
| Name | Description |
|---|---|
ATagKey | Specify the tag key. |
ATagValue | Specify the tag value. |
Returns
Returns the index of the tag instance added to Tags.