ROTATESECRET()`¶

About RotateSecret¶

Configures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secrets in the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.

When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.

Method Signature¶

METHODS /AWS1/IF_SMR~ROTATESECRET
  IMPORTING
    !IV_SECRETID TYPE /AWS1/SMRSECRETIDTYPE OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/SMRCLIENTREQTOKENTYPE OPTIONAL
    !IV_ROTATIONLAMBDAARN TYPE /AWS1/SMRROTATIONLAMBDAARNTYPE OPTIONAL
    !IO_ROTATIONRULES TYPE REF TO /AWS1/CL_SMRROTATIONRULESTYPE OPTIONAL
    !IT_EXTERNALSECRETROTATIONMET TYPE /AWS1/CL_SMREXTERNALSECRETRO00=>TT_EXTERNALSECRETROTATIONMET00 OPTIONAL
    !IV_EXTERNALSECRETROTATIONR00 TYPE /AWS1/SMRROLEARNTYPE OPTIONAL
    !IV_ROTATEIMMEDIATELY TYPE /AWS1/SMRBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_smrrotatesecretrsp
  RAISING
    /AWS1/CX_SMRINTERNALSVCERROR
    /AWS1/CX_SMRINVALIDPARAMETEREX
    /AWS1/CX_SMRINVALIDREQUESTEX
    /AWS1/CX_SMRRESOURCENOTFOUNDEX
    /AWS1/CX_SMRCLIENTEXC
    /AWS1/CX_SMRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_secretid` `TYPE /AWS1/SMRSECRETIDTYPE` `/AWS1/SMRSECRETIDTYPE`¶

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.

Optional arguments:¶

`iv_clientrequesttoken` `TYPE /AWS1/SMRCLIENTREQTOKENTYPE` `/AWS1/SMRCLIENTREQTOKENTYPE`¶

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.

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.

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.

`iv_rotationlambdaarn` `TYPE /AWS1/SMRROTATIONLAMBDAARNTYPE` `/AWS1/SMRROTATIONLAMBDAARNTYPE`¶

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.

`io_rotationrules` `TYPE REF TO /AWS1/CL_SMRROTATIONRULESTYPE` `/AWS1/CL_SMRROTATIONRULESTYPE`¶

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.

`it_externalsecretrotationmet` `TYPE /AWS1/CL_SMREXTERNALSECRETRO00=>TT_EXTERNALSECRETROTATIONMET00` `TT_EXTERNALSECRETROTATIONMET00`¶

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

`iv_externalsecretrotationr00` `TYPE /AWS1/SMRROLEARNTYPE` `/AWS1/SMRROLEARNTYPE`¶

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.

`iv_rotateimmediately` `TYPE /AWS1/SMRBOOLEANTYPE` `/AWS1/SMRBOOLEANTYPE`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_smrrotatesecretrsp` `/AWS1/CL_SMRROTATESECRETRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->rotatesecret(
  io_rotationrules = new /aws1/cl_smrrotationrulestype(
    iv_automaticallyafterdays = 123
    iv_duration = |string|
    iv_scheduleexpression = |string|
  )
  it_externalsecretrotationmet = VALUE /aws1/cl_smrexternalsecretro00=>tt_externalsecretrotationmet00(
    (
      new /aws1/cl_smrexternalsecretro00(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_externalsecretrotationr00 = |string|
  iv_rotateimmediately = ABAP_TRUE
  iv_rotationlambdaarn = |string|
  iv_secretid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_secretarntype = lo_result->get_arn( ).
  lv_secretnametype = lo_result->get_name( ).
  lv_secretversionidtype = lo_result->get_versionid( ).
ENDIF.

To configure rotation for a secret¶

The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.

DATA(lo_result) = lo_client->rotatesecret(
  io_rotationrules = new /aws1/cl_smrrotationrulestype(
    iv_duration = |2h|
    iv_scheduleexpression = |cron(0 16 1,15 * ? *)|
  )
  iv_rotationlambdaarn = |arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda|
  iv_secretid = |MyTestDatabaseSecret|
).

To request an immediate rotation for a secret¶

The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.

DATA(lo_result) = lo_client->rotatesecret( iv_secretid = |MyTestDatabaseSecret| ) .

/AWS1/IF_SMR=>ROTATESECRET()¶