Key

kms.services.k8s.aws/v1alpha1

TypeLink
GoDockms-controller/apis/v1alpha1#Key

Metadata

PropertyValue
ScopeNamespaced
KindKey
ListKindKeyList
Pluralkeys
Singularkey

Spec

bypassPolicyLockoutSafetyCheck: boolean
customKeyStoreID: string
description: string
enableKeyRotation: boolean
keySpec: string
keyUsage: string
multiRegion: boolean
origin: string
policy: string
tags:
- tagKey: string
  tagValue: string
FieldDescription
bypassPolicyLockoutSafetyCheck
Optional		boolean
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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)
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.
customKeyStoreID
Optional		string
Creates the KMS key in the specified custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
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 of AWS_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 (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
feature in KMS, which combines the convenience and extensive integration
of KMS with the isolation and control of a single-tenant key store.
description
Optional		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).

To set or change the description after the key is created, use UpdateKeyDescription.
enableKeyRotation
Optional		boolean
keySpec
Optional		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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose)
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 cryptographic 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 (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm),
kms:MacAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm)
or kms:Signing Algorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm)
in the Key Management Service Developer Guide .

Amazon Web Services services that are integrated with KMS (http://aws.amazon.com/kms/features/#AWS_Service_Integration)
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 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.

* SM2 key pairs (China Regions only) SM2
keyUsage
Optional		string
Determines the cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#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 material, specify ENCRYPT_DECRYPT
or SIGN_VERIFY.

* For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.

* For asymmetric KMS keys with SM2 key material (China Regions only),
specify ENCRYPT_DECRYPT or SIGN_VERIFY.
multiRegion
Optional		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 (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)
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 multi-Region version of a symmetric encryption KMS key,
an HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material.
However, you cannot create a multi-Region key in a custom key store.
origin
Optional		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
the value to EXTERNAL. For more information about importing key material
into KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html)
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 (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
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 custom key store. This value is valid only for symmetric encryption
KMS keys.
policy
Optional		string
The key policy to attach to the KMS key. If you do not specify a key policy,
KMS attaches a default key policy to the KMS key. For more information, see
Default key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default)
in the Key Management Service Developer Guide.

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 the CreateKey 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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)
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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency)
in the Amazon Web Services Identity and Access Management User Guide.

A key policy document can include only the following characters:

* Printable ASCII characters from the space character (\u0020) through
the end of the ASCII character range.

* Printable characters in the Basic Latin and Latin-1 Supplement character
set (through \u00FF).

* The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special
characters

For information about key policies, see Key policies in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)
in the Key Management Service Developer Guide. For help writing and formatting
a JSON policy document, see the IAM JSON Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html)
in the Identity and Access Management User Guide .
tags
Optional		array
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 (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html)
in the Key Management Service Developer Guide.

To use this parameter, you must have kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html)
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 (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html).
tags.[]
Required		object
A key-value pair. A 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.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the Amazon Web Services Billing and Cost Management User Guide. || tags.[].tagKey
Optional | string
| | tags.[].tagValue
Optional | string
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
awsAccountID: string
cloudHsmClusterID: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationDate: string
deletionDate: string
enabled: boolean
encryptionAlgorithms:
- string
expirationModel: string
keyID: string
keyManager: string
keyState: string
macAlgorithms:
- string
multiRegionConfiguration: 
  multiRegionKeyType: string
  primaryKey: 
    arn: string
    region: string
  replicaKeys:
  - arn: string
    region: string
pendingDeletionWindowInDays: integer
signingAlgorithms:
- string
validTo: string
FieldDescription
ackResourceMetadata
Optional		object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ackResourceMetadata.arn
Optional		string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required		string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.region
Required		string
Region is the AWS region in which the resource exists or will exist.
awsAccountID
Optional		string
The twelve-digit account ID of the Amazon Web Services account that owns
the KMS key.
cloudHsmClusterID
Optional		string
The cluster ID of the CloudHSM cluster that contains the key material for
the KMS key. When you create a KMS key in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html),
KMS creates the key material for the KMS key in the associated CloudHSM cluster.
This value is present only when the KMS key is created in a custom key store.
conditions
Optional		array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
conditions.[]
Required		object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional		string
A human readable message indicating details about the transition.
conditions.[].reason
Optional		string
The reason for the condition’s last transition.
conditions.[].status
Optional		string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional		string
Type is the type of the Condition
creationDate
Optional		string
The date and time when the KMS key was created.
deletionDate
Optional		string
The date and time after which KMS deletes this KMS key. This value is present
only when the KMS key is scheduled for deletion, that is, when its KeyState
is PendingDeletion.

When the primary key in a multi-Region key is scheduled for deletion but
still has replica keys, its key state is PendingReplicaDeletion and the length
of its waiting period is displayed in the PendingDeletionWindowInDays field.
enabled
Optional		boolean
Specifies whether the KMS key is enabled. When KeyState is Enabled this value
is true, otherwise it is false.
encryptionAlgorithms
Optional		array
The encryption algorithms that the KMS key supports. You cannot use the KMS
key with other encryption algorithms within KMS.

This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
encryptionAlgorithms.[]
Required		string
keyID
Optional		string
The globally unique identifier for the KMS key.
keyManager
Optional		string
The manager of the KMS key. KMS keys in your Amazon Web Services account
are either customer managed or Amazon Web Services managed. For more information
about the difference, see KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)
in the Key Management Service Developer Guide.
keyState
Optional		string
The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see
Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the Key Management Service Developer Guide.
macAlgorithms
Optional		array
The message authentication code (MAC) algorithm that the HMAC KMS key supports.

This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.
macAlgorithms.[]
Required		string
multiRegionConfiguration.multiRegionKeyType
Optional		string
multiRegionConfiguration.primaryKey
Optional		object
Describes the primary or replica key in a multi-Region key.
multiRegionConfiguration.primaryKey.arn
Optional		string
multiRegionConfiguration.primaryKey.region
Optional		string
multiRegionConfiguration.replicaKeys
Optional		array
multiRegionConfiguration.replicaKeys.[]
Required		object
Describes the primary or replica key in a multi-Region key.
multiRegionConfiguration.replicaKeys.[].region
Optional		string
pendingDeletionWindowInDays
Optional		integer
The waiting period before the primary key in a multi-Region key is deleted.
This waiting period begins when the last of its replica keys is deleted.
This value is present only when the KeyState of the KMS key is PendingReplicaDeletion.
That indicates that the KMS key is the primary key in a multi-Region key,
it is scheduled for deletion, and it still has existing replica keys.

When a single-Region KMS key or a multi-Region replica key is scheduled for
deletion, its deletion date is displayed in the DeletionDate field. However,
when the primary key in a multi-Region key is scheduled for deletion, its
waiting period doesn’t begin until all of its replica keys are deleted. This
value displays that waiting period. When the last replica key in the multi-Region
key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion
to PendingDeletion and the deletion date appears in the DeletionDate field.
signingAlgorithms
Optional		array
The signing algorithms that the KMS key supports. You cannot use the KMS
key with other signing algorithms within KMS.

This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
signingAlgorithms.[]
Required		string