Class: Aws::KMS::Types::CreateKeyRequest

Inherits:

Struct

Object
Struct
Aws::KMS::Types::CreateKeyRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-kms/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bypass_policy_lockout_safety_check ⇒ Boolean

Skips (“bypasses”) the key policy lockout safety check.
#custom_key_store_id ⇒ String

Creates the KMS key in the specified [custom key store].
#customer_master_key_spec ⇒ String

Instead, use the ‘KeySpec` parameter.
#description ⇒ String

A description of the KMS key.
#key_spec ⇒ String

Specifies the type of KMS key to create.
#key_usage ⇒ String

Determines the [cryptographic operations] for which you can use the KMS key.
#multi_region ⇒ Boolean

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions.
#origin ⇒ String

The source of the key material for the KMS key.
#policy ⇒ String

The key policy to attach to the KMS key.
#tags ⇒ Array<Types::Tag>

Assigns one or more tags to the KMS key.
#xks_key_id ⇒ String

Identifies the [external key] that serves as key material for the KMS key in an [external key store].

Instance Attribute Details

#bypass_policy_lockout_safety_check ⇒ `Boolean`

Skips (“bypasses”) the key policy lockout safety check. The default value is false.

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, see [Default key policy][1] in the *Key

Management Service Developer Guide*.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent

PutKeyPolicy][2: request on the KMS key.

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key [2]: docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html

Returns:

(Boolean)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_key_store_id ⇒ `String`

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.

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.

When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the ‘XksKeyId` parameter to specify an external key that serves as key material for the KMS key.

[1]: docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#customer_master_key_spec ⇒ `String`

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 supports both parameters.

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

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).

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

To set or change the description after the key is created, use UpdateKeyDescription.

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#key_spec ⇒ `String`

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 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 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][3: or [kms:Signing Algorithm] in the <i>

Key Management Service Developer Guide </i>.

Amazon Web Services services that are integrated with KMS][5: 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`
^
HMAC keys (symmetric)
- ‘HMAC_224`
- ‘HMAC_256`
- ‘HMAC_384`
- ‘HMAC_512`
Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
- ‘RSA_2048`
- ‘RSA_3072`
- ‘RSA_4096`
Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
- ‘ECC_NIST_P256` (secp256r1)
- ‘ECC_NIST_P384` (secp384r1)
- ‘ECC_NIST_P521` (secp521r1)
Other asymmetric elliptic curve key pairs (signing and verification)
- ‘ECC_SECG_P256K1` (secp256k1), commonly used for cryptocurrencies.
^
SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
- ‘SM2` (China Regions only)
^

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose [2]: docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm [3]: docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm [4]: docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm [5]: aws.amazon.com/kms/features/#AWS_Service_Integration

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#key_usage ⇒ `String`

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 pairs, specify ‘ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify ‘SIGN_VERIFY` or `KEY_AGREEMENT`.
For asymmetric KMS keys with ‘ECC_SECG_P256K1` key pairs specify `SIGN_VERIFY`.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ‘ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `KEY_AGREEMENT`.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region ⇒ `Boolean`

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 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.

[1]: docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html

Returns:

(Boolean)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#origin ⇒ `String`

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 this value to ‘EXTERNAL`. For more information about importing key material into KMS, see [Importing Key Material] in the *Key Management Service Developer Guide*. The `EXTERNAL` origin value is valid only for symmetric KMS keys.

To [create a KMS key in an CloudHSM 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 CloudHSM key store. The `KeySpec` value must be `SYMMETRIC_DEFAULT`.

To [create a KMS key in an external key store], set this value to ‘EXTERNAL_KEY_STORE`. You must also use the `CustomKeyStoreId` parameter to identify the external key store and the `XksKeyId` parameter to identify the associated external key. The `KeySpec` value must be `SYMMETRIC_DEFAULT`.

[1]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html [2]: docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html [3]: docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html [4]: docs.aws.amazon.com/kms/latest/developerguide/create-xks-keys.html

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ `String`

The key policy to attach to the KMS key.

If you provide a key policy, it must meet the following criteria:

The key policy must allow the calling principal to make a subsequent ‘PutKeyPolicy` request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy] in the *Key Management Service Developer Guide*. (To omit this condition, set `BypassPolicyLockoutSafetyCheck` to true.)
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, 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 .

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key [2]: docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency [3]: docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default [4]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

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.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

<note markdown=“1”> Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for KMS] in the *Key Management Service Developer Guide*.

</note>

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].

[1]: docs.aws.amazon.com/kms/latest/developerguide/abac.html [2]: docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html [3]: docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#xks_key_id ⇒ `String`

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][3: uses to refer to the external key. For

help, see the documentation for your external key store proxy.

This parameter is required for a KMS key with an ‘Origin` value of `EXTERNAL_KEY_STORE`. It is not valid for KMS keys with any other `Origin` value.

The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the ‘CustomKeyStoreId` parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see [Requirements for a KMS key in an external key store] in the *Key Management Service Developer Guide*.

Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as *double encryption*. For details, see [Double encryption] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-external-key [2]: docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html [3]: docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-xks-proxy [4]: docs.aws.amazon.com/create-xks-keys.html#xks-key-requirements [5]: docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html#concept-double-encryption

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 1127

class CreateKeyRequest < Struct.new(
  :policy,
  :description,
  :key_usage,
  :customer_master_key_spec,
  :key_spec,
  :origin,
  :custom_key_store_id,
  :bypass_policy_lockout_safety_check,
  :tags,
  :multi_region,
  :xks_key_id)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::KMS::Types::CreateKeyRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_policy_lockout_safety_check ⇒ Boolean

#custom_key_store_id ⇒ String

#customer_master_key_spec ⇒ String

#description ⇒ String

#key_spec ⇒ String

#key_usage ⇒ String

#multi_region ⇒ Boolean

#origin ⇒ String

#policy ⇒ String

#tags ⇒ Array<Types::Tag>

#xks_key_id ⇒ String

#bypass_policy_lockout_safety_check ⇒ `Boolean`

#custom_key_store_id ⇒ `String`

#customer_master_key_spec ⇒ `String`

#description ⇒ `String`

#key_spec ⇒ `String`

#key_usage ⇒ `String`

#multi_region ⇒ `Boolean`

#origin ⇒ `String`

#policy ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#xks_key_id ⇒ `String`