AWSKMSCreateKeyRequest
Objective-C
@interface AWSKMSCreateKeyRequest
Swift
class AWSKMSCreateKeyRequest
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable bypassPolicyLockoutSafetyCheck;
Swift
var bypassPolicyLockoutSafetyCheck: NSNumber? { get set }
-
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 ofAWS_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.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable customKeyStoreId;
Swift
var customKeyStoreId: String? { get set }
-
Instead, use the
KeySpec
parameter.The
KeySpec
andCustomerMasterKeySpec
parameters work the same way. Only the names differ. We recommend that you useKeySpec
parameter in your code. However, to avoid breaking changes, KMS will support both parameters.Declaration
Objective-C
@property (nonatomic) AWSKMSCustomerMasterKeySpec customerMasterKeySpec;
Swift
var customerMasterKeySpec: AWSKMSCustomerMasterKeySpec { get set }
-
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.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable detail;
Swift
var detail: String? { get set }
-
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 algorithms that the KMS key supports. You can’t change theKeySpec
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.
Declaration
Objective-C
@property (nonatomic) AWSKMSKeySpec keySpec;
Swift
var keySpec: AWSKMSKeySpec { get set }
-
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 theKeyUsage
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
orSIGN_VERIFY
.For asymmetric KMS keys with ECC key material, specify
SIGN_VERIFY
.
Declaration
Objective-C
@property (nonatomic) AWSKMSKeyUsageType keyUsage;
Swift
var keyUsage: AWSKMSKeyUsageType { get set }
-
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 toFalse
. The default value isFalse
.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 symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable multiRegion;
Swift
var multiRegion: NSNumber? { get set }
-
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 theCustomKeyStoreId
parameter to identify the custom key store. This value is valid only for symmetric encryption KMS keys.Declaration
Objective-C
@property (nonatomic) AWSKMSOriginType origin;
Swift
var origin: AWSKMSOriginType { get set }
-
The key policy to attach to the KMS key.
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 theCreateKey
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.
If you do not provide 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.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable policy;
Swift
var policy: String? { get set }
-
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.