Struct rusoto_kms::KeyMetadata
source · [−]pub struct KeyMetadata {Show 21 fields
pub aws_account_id: Option<String>,
pub arn: Option<String>,
pub cloud_hsm_cluster_id: Option<String>,
pub creation_date: Option<f64>,
pub custom_key_store_id: Option<String>,
pub customer_master_key_spec: Option<String>,
pub deletion_date: Option<f64>,
pub description: Option<String>,
pub enabled: Option<bool>,
pub encryption_algorithms: Option<Vec<String>>,
pub expiration_model: Option<String>,
pub key_id: String,
pub key_manager: Option<String>,
pub key_state: Option<String>,
pub key_usage: Option<String>,
pub multi_region: Option<bool>,
pub multi_region_configuration: Option<MultiRegionConfiguration>,
pub origin: Option<String>,
pub pending_deletion_window_in_days: Option<i64>,
pub signing_algorithms: Option<Vec<String>>,
pub valid_to: Option<f64>,
}
Expand description
Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations.
Fields
aws_account_id: Option<String>
The twelve-digit account ID of the AWS account that owns the CMK.
arn: Option<String>
The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
cloud_hsm_cluster_id: Option<String>
The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
creation_date: Option<f64>
The date and time when the CMK was created.
custom_key_store_id: Option<String>
A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
customer_master_key_spec: Option<String>
Describes the type of key material in the CMK.
deletion_date: Option<f64>
The date and time after which AWS KMS deletes this CMK. This value is present only when the CMK 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.
description: Option<String>
The description of the CMK.
enabled: Option<bool>
Specifies whether the CMK is enabled. When KeyState
is Enabled
this value is true, otherwise it is false.
encryption_algorithms: Option<Vec<String>>
The encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.
This value is present only when the KeyUsage
of the CMK is ENCRYPT_DECRYPT
.
expiration_model: Option<String>
Specifies whether the CMK's key material expires. This value is present only when Origin
is EXTERNAL
, otherwise this value is omitted.
key_id: String
The globally unique identifier for the CMK.
key_manager: Option<String>
The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
key_state: Option<String>
The current status of the CMK.
For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.
key_usage: Option<String>
The cryptographic operations for which you can use the CMK.
multi_region: Option<bool>
Indicates whether the CMK is a multi-Region (True
) or regional (False
) key. This value is True
for multi-Region primary and replica CMKs and False
for regional CMKs.
For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.
multi_region_configuration: Option<MultiRegionConfiguration>
Lists the primary and replica CMKs in same multi-Region CMK. This field is present only when the value of the MultiRegion
field is True
.
For more information about any listed CMK, use the DescribeKey operation.
-
MultiRegionKeyType
indicates whether the CMK is aPRIMARY
orREPLICA
key. -
PrimaryKey
displays the key ARN and Region of the primary key. This field displays the current CMK if it is the primary key. -
ReplicaKeys
displays the key ARNs and Regions of all replica keys. This field includes the current CMK if it is a replica key.
origin: Option<String>
The source of the CMK's key material. When this value is AWS_KMS
, AWS KMS created the key material. When this value is EXTERNAL
, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM
, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
pending_deletion_window_in_days: Option<i64>
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 CMK is PendingReplicaDeletion
. That indicates that the CMK is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.
When a regional CMK or a replica key in a multi-Region 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.
signing_algorithms: Option<Vec<String>>
The signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.
This field appears only when the KeyUsage
of the CMK is SIGN_VERIFY
.
valid_to: Option<f64>
The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin
is EXTERNAL
and whose ExpirationModel
is KEY_MATERIAL_EXPIRES
, otherwise this value is omitted.
Trait Implementations
sourceimpl Clone for KeyMetadata
impl Clone for KeyMetadata
sourcefn clone(&self) -> KeyMetadata
fn clone(&self) -> KeyMetadata
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for KeyMetadata
impl Debug for KeyMetadata
sourceimpl Default for KeyMetadata
impl Default for KeyMetadata
sourcefn default() -> KeyMetadata
fn default() -> KeyMetadata
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for KeyMetadata
impl<'de> Deserialize<'de> for KeyMetadata
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<KeyMetadata> for KeyMetadata
impl PartialEq<KeyMetadata> for KeyMetadata
sourcefn eq(&self, other: &KeyMetadata) -> bool
fn eq(&self, other: &KeyMetadata) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &KeyMetadata) -> bool
fn ne(&self, other: &KeyMetadata) -> bool
This method tests for !=
.
impl StructuralPartialEq for KeyMetadata
Auto Trait Implementations
impl RefUnwindSafe for KeyMetadata
impl Send for KeyMetadata
impl Sync for KeyMetadata
impl Unpin for KeyMetadata
impl UnwindSafe for KeyMetadata
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more