Class: Aws::SecretsManager::Types::RotateSecretRequest

Inherits:

Struct

• Object
• Struct
• Aws::SecretsManager::Types::RotateSecretRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-secretsmanager/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A unique identifier for the new version of the secret.

• #rotate_immediately ⇒ Boolean

  Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.

• #rotation_lambda_arn ⇒ String

  For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.

• #rotation_rules ⇒ Types::RotationRulesType

  A structure that defines the rotation configuration for this secret.

• #secret_id ⇒ String

  The ARN or name of the secret to rotate.

Instance Attribute Details

#client_request_token ⇒ String

A unique identifier for the new version of the secret. 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.

<note markdown=“1”> If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

</note>

If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ‘ClientRequestToken` and include it in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a [UUID-type] value to ensure uniqueness of your versions within the specified secret.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: wikipedia.org/wiki/Universally_unique_identifier

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1765

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :rotate_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#rotate_immediately ⇒ Boolean

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

For secrets that use a Lambda rotation function to rotate, 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.

By default, Secrets Manager rotates the secret immediately.

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_lambda-functions.html#rotate-secrets_lambda-functions-code

Returns:

• (Boolean)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1765

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :rotate_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_lambda_arn ⇒ 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*.

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1765

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :rotate_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_rules ⇒ Types::RotationRulesType

A structure that defines the rotation configuration for this secret.

Returns:

• (Types::RotationRulesType)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1765

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :rotate_immediately)
  SENSITIVE = []
  include Aws::Structure
end

#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].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1765

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :rotate_immediately)
  SENSITIVE = []
  include Aws::Structure
end