Struct aws_sdk_secretsmanager::input::RotateSecretInput

#[non_exhaustive]
pub struct RotateSecretInput {
    pub secret_id: Option<String>,
    pub client_request_token: Option<String>,
    pub rotation_lambda_arn: Option<String>,
    pub rotation_rules: Option<RotationRulesType>,
    pub rotate_immediately: Option<bool>,
}

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.

secret_id: Option<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.

client_request_token: Option<String>

A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId of the new version.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

rotation_lambda_arn: Option<String>

The ARN of the Lambda rotation function that can rotate the secret.

rotation_rules: Option<RotationRulesType>

A structure that defines the rotation configuration for this secret.

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.

If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

Implementations

impl RotateSecretInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<RotateSecret, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<RotateSecret>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RotateSecretInput

impl RotateSecretInput

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

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.

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

A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId of the new version.

If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

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

The ARN of the Lambda rotation function that can rotate the secret.

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

A structure that defines the rotation configuration for this secret.

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

If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

Trait Implementations

impl Clone for RotateSecretInput

fn clone(&self) -> RotateSecretInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RotateSecretInput

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

Formats the value using the given formatter.

impl PartialEq<RotateSecretInput> for RotateSecretInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for RotateSecretInput