Struct aws_sdk_secretsmanager::input::rotate_secret_input::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for RotateSecretInput

Implementations

impl Builder

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

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

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

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

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

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

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

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

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

A structure that defines the rotation configuration for this secret.

pub fn set_rotation_rules(self, input: Option<RotationRulesType>) -> Self

A structure that defines the rotation configuration for this secret.

pub fn build(self) -> Result<RotateSecretInput, BuildError>

Consumes the builder and constructs a RotateSecretInput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder