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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass RotateSecretRequest data as a hash:

{
  secret_id: "SecretIdType", # required
  client_request_token: "ClientRequestTokenType",
  rotation_lambda_arn: "RotationLambdaARNType",
  rotation_rules: {
    automatically_after_days: 1,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

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 your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a [UUID-type] value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the `VersionId` of the new version.

**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)

1774
1775
1776
1777
1778
1779
1780
1781
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1774

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

#rotation_lambda_arnString

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

Returns:

  • (String)

1774
1775
1776
1777
1778
1779
1780
1781
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1774

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

#rotation_rulesTypes::RotationRulesType

A structure that defines the rotation configuration for this secret.


1774
1775
1776
1777
1778
1779
1780
1781
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1774

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

#secret_idString

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.

Returns:

  • (String)

1774
1775
1776
1777
1778
1779
1780
1781
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1774

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