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
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,
duration: "DurationType",
schedule_expression: "ScheduleExpressionType",
},
rotate_immediately: false,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique identifier for the new version of the secret that helps ensure idempotency.
-
#rotate_immediately ⇒ Boolean
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
-
#rotation_lambda_arn ⇒ String
The ARN of the Lambda rotation function that can rotate the secret.
-
#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 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][1
-
value to ensure uniqueness within the specified
secret.
**A suitable default value is auto-generated.** You should normally not need to pass this option.
1752 1753 1754 1755 1756 1757 1758 1759 1760 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1752 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.
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.
[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
1752 1753 1754 1755 1756 1757 1758 1759 1760 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1752 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
The ARN of the Lambda rotation function that can rotate the secret.
1752 1753 1754 1755 1756 1757 1758 1759 1760 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1752 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.
1752 1753 1754 1755 1756 1757 1758 1759 1760 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1752 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
1752 1753 1754 1755 1756 1757 1758 1759 1760 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1752 class RotateSecretRequest < Struct.new( :secret_id, :client_request_token, :rotation_lambda_arn, :rotation_rules, :rotate_immediately) SENSITIVE = [] include Aws::Structure end |