Skip to content

AwsKmsKeyDetails

Source code in docs_src/capo_securityhub/types/aws_kms_key_details.py
class AwsKmsKeyDetails(TypedDict, closed=True):
    aws_account_id: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>"""
    creation_date: NotRequired["capo_securityhub.types.double.Double"]
    """<p>Indicates when the KMS key was created.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    key_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The globally unique identifier for the KMS key.</p>"""
    key_manager: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.</p>"""
    key_state: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The state of the KMS key. Valid values are as follows:</p> <ul> <li> <p> <code>Disabled</code> </p> </li> <li> <p> <code>Enabled</code> </p> </li> <li> <p> <code>PendingDeletion</code> </p> </li> <li> <p> <code>PendingImport</code> </p> </li> <li> <p> <code>Unavailable</code> </p> </li> </ul>"""
    origin: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The source of the KMS key material.</p> <p>When this value is <code>AWS_KMS</code>, KMS created the key material.</p> <p>When this value is <code>EXTERNAL</code>, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.</p> <p>When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster associated with a custom key store.</p>"""
    description: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>A description of the KMS key.</p>"""
    key_rotation_status: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the key has key rotation enabled.</p>"""

aws_account_id instance-attribute

aws_account_id: NotRequired[NonEmptyString]

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

creation_date instance-attribute

creation_date: NotRequired[Double]

Indicates when the KMS key was created.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

description instance-attribute

description: NotRequired[NonEmptyString]

A description of the KMS key.

key_id instance-attribute

key_id: NotRequired[NonEmptyString]

The globally unique identifier for the KMS key.

key_manager instance-attribute

key_manager: NotRequired[NonEmptyString]

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

key_rotation_status instance-attribute

key_rotation_status: NotRequired[Boolean]

Whether the key has key rotation enabled.

key_state instance-attribute

key_state: NotRequired[NonEmptyString]

The state of the KMS key. Valid values are as follows:

  • Disabled

  • Enabled

  • PendingDeletion

  • PendingImport

  • Unavailable

origin instance-attribute

origin: NotRequired[NonEmptyString]

The source of the KMS key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.