Struct aws_sdk_securityhub::types::AwsKmsKeyDetails

#[non_exhaustive]
pub struct AwsKmsKeyDetails {
    pub aws_account_id: Option<String>,
    pub creation_date: Option<f64>,
    pub key_id: Option<String>,
    pub key_manager: Option<String>,
    pub key_state: Option<String>,
    pub origin: Option<String>,
    pub description: Option<String>,
    pub key_rotation_status: Option<bool>,
}

Contains metadata about an KMS key.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aws_account_id: Option<String>

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

creation_date: Option<f64>

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

key_id: Option<String>

The globally unique identifier for the KMS key.

key_manager: Option<String>

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

key_state: Option<String>

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

• Disabled

• Enabled

• PendingDeletion

• PendingImport

• Unavailable

origin: Option<String>

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.

description: Option<String>

A description of the KMS key.

key_rotation_status: Option<bool>

Whether the key has key rotation enabled.

Implementations

impl AwsKmsKeyDetails

pub fn aws_account_id(&self) -> Option<&str>

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

pub fn creation_date(&self) -> Option<f64>

Indicates when the KMS key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

pub fn key_id(&self) -> Option<&str>

The globally unique identifier for the KMS key.

pub fn key_manager(&self) -> Option<&str>

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

pub fn key_state(&self) -> Option<&str>

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

• Disabled

• Enabled

• PendingDeletion

• PendingImport

• Unavailable

pub fn origin(&self) -> Option<&str>

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.

pub fn description(&self) -> Option<&str>

A description of the KMS key.

pub fn key_rotation_status(&self) -> Option<bool>

Whether the key has key rotation enabled.

impl AwsKmsKeyDetails

pub fn builder() -> AwsKmsKeyDetailsBuilder

Creates a new builder-style object to manufacture AwsKmsKeyDetails.

Trait Implementations

impl Clone for AwsKmsKeyDetails

fn clone(&self) -> AwsKmsKeyDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AwsKmsKeyDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AwsKmsKeyDetails

fn eq(&self, other: &AwsKmsKeyDetails) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AwsKmsKeyDetails