#[non_exhaustive]pub struct DescribeSecretOutputBuilder { /* private fields */ }
Expand description
A builder for DescribeSecretOutput
.
Implementations§
Source§impl DescribeSecretOutputBuilder
impl DescribeSecretOutputBuilder
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the secret.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the secret.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the secret.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
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.
Sourcepub fn rotation_enabled(self, input: bool) -> Self
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
.
Sourcepub fn set_rotation_enabled(self, input: Option<bool>) -> Self
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
.
Sourcepub fn get_rotation_enabled(&self) -> &Option<bool>
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
.
Sourcepub fn rotation_lambda_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_rotation_lambda_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_rotation_lambda_arn(&self) -> &Option<String>
pub fn get_rotation_lambda_arn(&self) -> &Option<String>
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
Sourcepub fn rotation_rules(self, input: RotationRulesType) -> Self
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.
Sourcepub fn set_rotation_rules(self, input: Option<RotationRulesType>) -> Self
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.
Sourcepub fn get_rotation_rules(&self) -> &Option<RotationRulesType>
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.
Sourcepub fn last_rotated_date(self, input: DateTime) -> Self
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.
Sourcepub fn set_last_rotated_date(self, input: Option<DateTime>) -> Self
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.
Sourcepub fn get_last_rotated_date(&self) -> &Option<DateTime>
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.
Sourcepub fn last_changed_date(self, input: DateTime) -> Self
pub fn last_changed_date(self, input: DateTime) -> Self
The last date and time that this secret was modified in any way.
Sourcepub fn set_last_changed_date(self, input: Option<DateTime>) -> Self
pub fn set_last_changed_date(self, input: Option<DateTime>) -> Self
The last date and time that this secret was modified in any way.
Sourcepub fn get_last_changed_date(&self) -> &Option<DateTime>
pub fn get_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, input: DateTime) -> Self
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.
Sourcepub fn set_last_accessed_date(self, input: Option<DateTime>) -> Self
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.
Sourcepub fn get_last_accessed_date(&self) -> &Option<DateTime>
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.
Sourcepub fn deleted_date(self, input: DateTime) -> Self
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
.
Sourcepub fn set_deleted_date(self, input: Option<DateTime>) -> Self
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
.
Sourcepub fn get_deleted_date(&self) -> &Option<DateTime>
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
.
Sourcepub fn next_rotation_date(self, input: DateTime) -> Self
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.
Sourcepub fn set_next_rotation_date(self, input: Option<DateTime>) -> Self
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.
Sourcepub fn get_next_rotation_date(&self) -> &Option<DateTime>
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.
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
.
The list of tags attached to the secret. To add tags to a secret, use TagResource
. To remove tags, use UntagResource
.
The list of tags attached to the secret. To add tags to a secret, use TagResource
. To remove tags, use UntagResource
.
Sourcepub fn version_ids_to_stages(self, k: impl Into<String>, v: Vec<String>) -> Self
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, callGetSecretValue
. -
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.
Sourcepub fn set_version_ids_to_stages(
self,
input: Option<HashMap<String, Vec<String>>>,
) -> Self
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, callGetSecretValue
. -
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.
Sourcepub fn get_version_ids_to_stages(&self) -> &Option<HashMap<String, Vec<String>>>
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, callGetSecretValue
. -
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.
Sourcepub fn owning_service(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_owning_service(self, input: Option<String>) -> Self
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.
Sourcepub fn get_owning_service(&self) -> &Option<String>
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.
Sourcepub fn created_date(self, input: DateTime) -> Self
pub fn created_date(self, input: DateTime) -> Self
The date the secret was created.
Sourcepub fn set_created_date(self, input: Option<DateTime>) -> Self
pub fn set_created_date(self, input: Option<DateTime>) -> Self
The date the secret was created.
Sourcepub fn get_created_date(&self) -> &Option<DateTime>
pub fn get_created_date(&self) -> &Option<DateTime>
The date the secret was created.
Sourcepub fn primary_region(self, input: impl Into<String>) -> Self
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
.
Sourcepub fn set_primary_region(self, input: Option<String>) -> Self
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
.
Sourcepub fn get_primary_region(&self) -> &Option<String>
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
.
Sourcepub fn replication_status(self, input: ReplicationStatusType) -> Self
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.
Sourcepub fn set_replication_status(
self,
input: Option<Vec<ReplicationStatusType>>,
) -> Self
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.
Sourcepub fn get_replication_status(&self) -> &Option<Vec<ReplicationStatusType>>
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.
Sourcepub fn build(self) -> DescribeSecretOutput
pub fn build(self) -> DescribeSecretOutput
Consumes the builder and constructs a DescribeSecretOutput
.
Trait Implementations§
Source§impl Clone for DescribeSecretOutputBuilder
impl Clone for DescribeSecretOutputBuilder
Source§fn clone(&self) -> DescribeSecretOutputBuilder
fn clone(&self) -> DescribeSecretOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribeSecretOutputBuilder
impl Debug for DescribeSecretOutputBuilder
Source§impl Default for DescribeSecretOutputBuilder
impl Default for DescribeSecretOutputBuilder
Source§fn default() -> DescribeSecretOutputBuilder
fn default() -> DescribeSecretOutputBuilder
impl StructuralPartialEq for DescribeSecretOutputBuilder
Auto Trait Implementations§
impl Freeze for DescribeSecretOutputBuilder
impl RefUnwindSafe for DescribeSecretOutputBuilder
impl Send for DescribeSecretOutputBuilder
impl Sync for DescribeSecretOutputBuilder
impl Unpin for DescribeSecretOutputBuilder
impl UnwindSafe for DescribeSecretOutputBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)