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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1885

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

#external_secret_rotation_metadata ⇒ Array<Types::ExternalSecretRotationMetadataItem>

The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see

Using Secrets Manager managed external secrets][1

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html

Returns:



1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1885

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

#external_secret_rotation_role_arn ⇒ String

The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see [Security and permissions].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/mes-security.html

Returns:

  • (String) 


1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1885

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :external_secret_rotation_metadata,
  :external_secret_rotation_role_arn,
  :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.

The default for ‘RotateImmediately` is `true`. If you don’t specify this value, Secrets Manager rotates the secret immediately.

If you set ‘RotateImmediately` to `false`, Secrets Manager tests the rotation configuration by running the [ `testSecret` step] of the Lambda rotation function. This test creates an `AWSPENDING` version of the secret and then removes it.

When changing an existing rotation schedule and setting ‘RotateImmediately` to `false`:

  • If using ‘AutomaticallyAfterDays` or a `ScheduleExpression` with `rate()`, the previously scheduled rotation might still occur.

  • To prevent unintended rotations, use a ‘ScheduleExpression` with `cron()` for granular control over rotation windows.

Rotation is an asynchronous process. For more information, see [How rotation works].

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

Returns:

  • (Boolean) 


1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1885

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :external_secret_rotation_metadata,
  :external_secret_rotation_role_arn,
  :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) 


1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1885

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

#rotation_rules ⇒ Types::RotationRulesType

A structure that defines the rotation configuration for this secret.

When changing an existing rotation schedule and setting ‘RotateImmediately` to `false`:

* If using `AutomaticallyAfterDays` or a `ScheduleExpression` with
 `rate()`, the previously scheduled rotation might still occur.

  • To prevent unintended rotations, use a ‘ScheduleExpression` with `cron()` for granular control over rotation windows.

Returns:



1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1885

class RotateSecretRequest < Struct.new(
  :secret_id,
  :client_request_token,
  :rotation_lambda_arn,
  :rotation_rules,
  :external_secret_rotation_metadata,
  :external_secret_rotation_role_arn,
  :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) 


1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1885

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