Struct aws_sdk_secretsmanager::operation::describe_secret::builders::DescribeSecretOutputBuilder

#[non_exhaustive]
pub struct DescribeSecretOutputBuilder { /* private fields */ }

A builder for DescribeSecretOutput.

Implementations

impl DescribeSecretOutputBuilder

pub fn arn(self, input: impl Into<String>) -> Self

The ARN of the secret.

pub fn set_arn(self, input: Option<String>) -> Self

The ARN of the secret.

pub fn get_arn(&self) -> &Option<String>

The ARN of the secret.

pub fn name(self, input: impl Into<String>) -> Self

The name of the secret.

pub fn set_name(self, input: Option<String>) -> Self

The name of the secret.

pub fn get_name(&self) -> &Option<String>

The name of the secret.

pub fn description(self, input: impl Into<String>) -> Self

The description of the secret.

pub fn set_description(self, input: Option<String>) -> Self

The description of the secret.

pub fn get_description(&self) -> &Option<String>

The description of the secret.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

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 set_kms_key_id(self, input: Option<String>) -> Self

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 get_kms_key_id(&self) -> &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.

pub fn rotation_enabled(self, input: bool) -> Self

Specifies whether automatic rotation is turned on for this secret.

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

pub fn set_rotation_enabled(self, input: Option<bool>) -> Self

Specifies whether automatic rotation is turned on for this secret.

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

pub fn get_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, input: impl Into<String>) -> Self

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

pub fn set_rotation_lambda_arn(self, input: Option<String>) -> Self

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

pub fn get_rotation_lambda_arn(&self) -> &Option<String>

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

pub fn rotation_rules(self, input: RotationRulesType) -> Self

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 set_rotation_rules(self, input: Option<RotationRulesType>) -> Self

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 get_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, input: DateTime) -> Self

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 set_last_rotated_date(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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

pub fn set_last_changed_date(self, input: Option<DateTime>) -> Self

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

pub fn get_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, input: DateTime) -> Self

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 set_last_accessed_date(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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 set_deleted_date(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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 set_next_rotation_date(self, input: Option<DateTime>) -> Self

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 get_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, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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

pub fn version_ids_to_stages(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to version_ids_to_stages.

To override the contents of this collection use set_version_ids_to_stages.

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 set_version_ids_to_stages( self, input: Option<HashMap<String, Vec<String>>>, ) -> Self

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 get_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, input: impl Into<String>) -> Self

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

pub fn set_owning_service(self, input: Option<String>) -> Self

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

pub fn get_owning_service(&self) -> &Option<String>

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, input: DateTime) -> Self

The date the secret was created.

pub fn set_created_date(self, input: Option<DateTime>) -> Self

The date the secret was created.

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

The date the secret was created.

pub fn primary_region(self, input: impl Into<String>) -> Self

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

pub fn set_primary_region(self, input: Option<String>) -> Self

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

pub fn get_primary_region(&self) -> &Option<String>

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, input: ReplicationStatusType) -> Self

Appends an item to replication_status.

To override the contents of this collection use set_replication_status.

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.

pub fn set_replication_status( self, input: Option<Vec<ReplicationStatusType>>, ) -> Self

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.

pub fn get_replication_status(&self) -> &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.

pub fn build(self) -> DescribeSecretOutput

Consumes the builder and constructs a DescribeSecretOutput.

Trait Implementations

impl Clone for DescribeSecretOutputBuilder

fn clone(&self) -> DescribeSecretOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSecretOutputBuilder

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

Formats the value using the given formatter.

impl Default for DescribeSecretOutputBuilder

fn default() -> DescribeSecretOutputBuilder

Returns the “default value” for a type.

impl PartialEq for DescribeSecretOutputBuilder

fn eq(&self, other: &DescribeSecretOutputBuilder) -> 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 StructuralPartialEq for DescribeSecretOutputBuilder