You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateKeyRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  policy: "PolicyType",
  description: "DescriptionType",
  key_usage: "ENCRYPT_DECRYPT", # accepts ENCRYPT_DECRYPT
  origin: "AWS_KMS", # accepts AWS_KMS, EXTERNAL
  bypass_policy_lockout_safety_check: false,
  tags: [
    {
      tag_key: "TagKeyType", # required
      tag_value: "TagValueType", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#bypass_policy_lockout_safety_checkBoolean

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the likelihood 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.

Returns:

  • (Boolean)

    A flag to indicate whether to bypass the key policy lockout safety check.

#descriptionString

A description of the CMK.

Use a description that helps you decide whether the CMK is appropriate for a task.

Returns:

  • (String)

    A description of the CMK.

#key_usageString

The intended use of the CMK.

You can use CMKs only for symmetric encryption and decryption.

Possible values:

  • ENCRYPT_DECRYPT

Returns:

  • (String)

    The intended use of the CMK.

#originString

The source of the CMK\'s key material.

The default is AWS_KMS, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL, the request 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.

The CMK\'s Origin is immutable and is set when the CMK is created.

Returns:

  • (String)

    The source of the CMK\'s key material.

#policyString

The key policy to attach to the CMK.

If you specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:

  • It must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

  • The principals that are specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.

If you do not specify a 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 policy size limit is 32 kilobytes (32768 bytes).

Returns:

  • (String)

    The key policy to attach to the CMK.

#tagsArray<Types::Tag>

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.

Returns: