Struct aws_sdk_secretsmanager::types::SecretListEntry
source · #[non_exhaustive]pub struct SecretListEntry {Show 17 fields
pub arn: Option<String>,
pub name: Option<String>,
pub description: Option<String>,
pub kms_key_id: Option<String>,
pub rotation_enabled: Option<bool>,
pub rotation_lambda_arn: Option<String>,
pub rotation_rules: Option<RotationRulesType>,
pub last_rotated_date: Option<DateTime>,
pub last_changed_date: Option<DateTime>,
pub last_accessed_date: Option<DateTime>,
pub deleted_date: Option<DateTime>,
pub next_rotation_date: Option<DateTime>,
pub tags: Option<Vec<Tag>>,
pub secret_versions_to_stages: Option<HashMap<String, Vec<String>>>,
pub owning_service: Option<String>,
pub created_date: Option<DateTime>,
pub primary_region: Option<String>,
}
Expand description
A structure that contains the details about a secret. It does not include the encrypted SecretString
and SecretBinary
values. To get those values, use GetSecretValue .
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.arn: Option<String>
The Amazon Resource Name (ARN) of the secret.
name: Option<String>
The friendly name of the secret.
description: Option<String>
The user-provided description of the secret.
kms_key_id: Option<String>
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
rotation_enabled: Option<bool>
Indicates whether automatic, scheduled rotation is enabled for this secret.
rotation_lambda_arn: Option<String>
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret
.
rotation_rules: Option<RotationRulesType>
A structure that defines the rotation configuration for the secret.
last_rotated_date: Option<DateTime>
The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.
last_changed_date: Option<DateTime>
The last date and time that this secret was modified in any way.
last_accessed_date: Option<DateTime>
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
deleted_date: Option<DateTime>
The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays
parameter of the DeleteSecret
operation.
next_rotation_date: Option<DateTime>
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource
. To remove tags, use UntagResource
.
secret_versions_to_stages: Option<HashMap<String, Vec<String>>>
A list of all of the currently assigned SecretVersionStage
staging labels and the SecretVersionId
attached to each one. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to deletion. Such versions are not included in this list.
owning_service: Option<String>
Returns the name of the service that created the secret.
created_date: Option<DateTime>
The date and time when a secret was created.
primary_region: Option<String>
The Region where Secrets Manager originated the secret.
Implementations§
source§impl SecretListEntry
impl SecretListEntry
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The user-provided description of the secret.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
sourcepub fn rotation_enabled(&self) -> Option<bool>
pub fn rotation_enabled(&self) -> Option<bool>
Indicates whether automatic, scheduled rotation is enabled for this secret.
sourcepub fn rotation_lambda_arn(&self) -> Option<&str>
pub fn rotation_lambda_arn(&self) -> Option<&str>
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret
.
sourcepub fn rotation_rules(&self) -> Option<&RotationRulesType>
pub fn rotation_rules(&self) -> Option<&RotationRulesType>
A structure that defines the rotation configuration for the secret.
sourcepub fn last_rotated_date(&self) -> Option<&DateTime>
pub fn last_rotated_date(&self) -> Option<&DateTime>
The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.
sourcepub fn last_changed_date(&self) -> Option<&DateTime>
pub fn last_changed_date(&self) -> Option<&DateTime>
The last date and time that this secret was modified in any way.
sourcepub fn last_accessed_date(&self) -> Option<&DateTime>
pub fn last_accessed_date(&self) -> Option<&DateTime>
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
sourcepub fn deleted_date(&self) -> Option<&DateTime>
pub fn deleted_date(&self) -> Option<&DateTime>
The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays
parameter of the DeleteSecret
operation.
sourcepub fn next_rotation_date(&self) -> Option<&DateTime>
pub fn next_rotation_date(&self) -> Option<&DateTime>
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource
. To remove tags, use UntagResource
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none()
.
sourcepub fn secret_versions_to_stages(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn secret_versions_to_stages(&self) -> Option<&HashMap<String, Vec<String>>>
A list of all of the currently assigned SecretVersionStage
staging labels and the SecretVersionId
attached to each one. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to deletion. Such versions are not included in this list.
sourcepub fn owning_service(&self) -> Option<&str>
pub fn owning_service(&self) -> Option<&str>
Returns the name of the service that created the secret.
sourcepub fn created_date(&self) -> Option<&DateTime>
pub fn created_date(&self) -> Option<&DateTime>
The date and time when a secret was created.
sourcepub fn primary_region(&self) -> Option<&str>
pub fn primary_region(&self) -> Option<&str>
The Region where Secrets Manager originated the secret.
source§impl SecretListEntry
impl SecretListEntry
sourcepub fn builder() -> SecretListEntryBuilder
pub fn builder() -> SecretListEntryBuilder
Creates a new builder-style object to manufacture SecretListEntry
.
Trait Implementations§
source§impl Clone for SecretListEntry
impl Clone for SecretListEntry
source§fn clone(&self) -> SecretListEntry
fn clone(&self) -> SecretListEntry
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SecretListEntry
impl Debug for SecretListEntry
source§impl PartialEq for SecretListEntry
impl PartialEq for SecretListEntry
impl StructuralPartialEq for SecretListEntry
Auto Trait Implementations§
impl Freeze for SecretListEntry
impl RefUnwindSafe for SecretListEntry
impl Send for SecretListEntry
impl Sync for SecretListEntry
impl Unpin for SecretListEntry
impl UnwindSafe for SecretListEntry
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)