Struct RotateSecretRequest 

pub struct RotateSecretRequest {
    pub secret_id: String,
    pub rotation_lambda_arn: Option<String>,
    pub rotation_rules: Option<RotationRulesType>,
    pub rotate_immediately: Option<bool>,
}

AWS API: secretsmanager.v1.RotateSecretRequest

Coverage

4 of 7 fields included. Omitted fields:

• ClientRequestToken — not selected in manifest
• ExternalSecretRotationMetadata — not selected in manifest
• ExternalSecretRotationRoleArn — not selected in manifest

Fields

secret_id: String

The ARN or name of the secret to rotate. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

rotation_lambda_arn: Option<String>

For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function. For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.

rotation_rules: Option<RotationRulesType>

A structure that defines the rotation configuration for this secret. When changing an existing rotation schedule and setting RotateImmediately to false: If using AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur. To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

rotate_immediately: Option<bool>

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules. The default for RotateImmediately is true. If you don’t specify this value, Secrets Manager rotates the secret immediately. If you set RotateImmediately to false, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it. When changing an existing rotation schedule and setting RotateImmediately to false: If using AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur. To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows. Rotation is an asynchronous process. For more information, see How rotation works.

Trait Implementations

impl Clone for RotateSecretRequest

fn clone(&self) -> RotateSecretRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RotateSecretRequest

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

Formats the value using the given formatter.

impl Default for RotateSecretRequest

fn default() -> RotateSecretRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RotateSecretRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RotateSecretRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.