Struct aws_sdk_secretsmanager::operation::describe_secret::DescribeSecretOutput

#[non_exhaustive]
pub struct DescribeSecretOutput {

    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 version_ids_to_stages: Option<HashMap<String, Vec<String>>>,
    pub owning_service: Option<String>,
    pub created_date: Option<DateTime>,
    pub primary_region: Option<String>,
    pub replication_status: Option<Vec<ReplicationStatusType>>,
    /* private fields */
}

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.

arn: Option<String>

The ARN of the secret.

name: Option<String>

The name of the secret.

description: Option<String>

The description of the secret.

kms_key_id: Option<String>

The key ID or alias 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. Secrets created using the console use an KMS key ID.

rotation_enabled: Option<bool>

Specifies whether automatic rotation is turned on for this secret.

To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.

rotation_lambda_arn: Option<String>

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

rotation_rules: Option<RotationRulesType>

The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.

last_rotated_date: Option<DateTime>

The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.

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 the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.

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. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.

This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.

tags: Option<Vec<Tag>>

The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

version_ids_to_stages: Option<HashMap<String, Vec<String>>>

A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

• AWSCURRENT, which indicates the current version of the secret.

• AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

  During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

• AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

For more information about rotation and staging labels, see How rotation works.

owning_service: Option<String>

The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.

created_date: Option<DateTime>

The date the secret was created.

primary_region: Option<String>

The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

replication_status: Option<Vec<ReplicationStatusType>>

A list of the replicas of this secret and their status:

• Failed, which indicates that the replica was not created.

• InProgress, which indicates that Secrets Manager is in the process of creating the replica.

• InSync, which indicates that the replica was created.

Implementations

impl DescribeSecretOutput

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

The ARN of the secret.

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

The name of the secret.

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

The description of the secret.

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

The key ID or alias 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. Secrets created using the console use an KMS key ID.

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

Specifies whether automatic rotation is turned on for this secret.

To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.

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

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

pub fn rotation_rules(&self) -> Option<&RotationRulesType>

The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.

pub fn last_rotated_date(&self) -> Option<&DateTime>

The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.

pub fn last_changed_date(&self) -> Option<&DateTime>

The last date and time that this secret was modified in any way.

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.

pub fn deleted_date(&self) -> Option<&DateTime>

The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.

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. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.

This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.

pub fn tags(&self) -> &[Tag]

The list of tags attached to 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().

pub fn version_ids_to_stages(&self) -> Option<&HashMap<String, Vec<String>>>

A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

• AWSCURRENT, which indicates the current version of the secret.

• AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

  During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

• AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

For more information about rotation and staging labels, see How rotation works.

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

The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.

pub fn created_date(&self) -> Option<&DateTime>

The date the secret was created.

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

The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

pub fn replication_status(&self) -> &[ReplicationStatusType]

A list of the replicas of this secret and their status:

• Failed, which indicates that the replica was not created.

• InProgress, which indicates that Secrets Manager is in the process of creating the replica.

• InSync, which indicates that the replica was created.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .replication_status.is_none().

impl DescribeSecretOutput

pub fn builder() -> DescribeSecretOutputBuilder

Creates a new builder-style object to manufacture DescribeSecretOutput.

Trait Implementations

impl Clone for DescribeSecretOutput

fn clone(&self) -> DescribeSecretOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSecretOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeSecretOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for DescribeSecretOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeSecretOutput