REPLICATESECRETTOREGIONS()`¶

About ReplicateSecretToRegions¶

Replicates the secret to a new Regions. See Multi-Region secrets.

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:ReplicateSecretToRegions. If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Encrypt to the key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Method Signature¶

METHODS /AWS1/IF_SMR~REPLICATESECRETTOREGIONS
  IMPORTING
    !IV_SECRETID TYPE /AWS1/SMRSECRETIDTYPE OPTIONAL
    !IT_ADDREPLICAREGIONS TYPE /AWS1/CL_SMRREPLICAREGIONTYPE=>TT_ADDREPLICAREGIONLISTTYPE OPTIONAL
    !IV_FORCEOVERWRITERPLSECRET TYPE /AWS1/SMRBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_smrrpltesecrettoreg01
  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 replicate.

`it_addreplicaregions` `TYPE /AWS1/CL_SMRREPLICAREGIONTYPE=>TT_ADDREPLICAREGIONLISTTYPE` `TT_ADDREPLICAREGIONLISTTYPE`¶

A list of Regions in which to replicate the secret.

Optional arguments:¶

`iv_forceoverwriterplsecret` `TYPE /AWS1/SMRBOOLEANTYPE` `/AWS1/SMRBOOLEANTYPE`¶

Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_smrrpltesecrettoreg01` `/AWS1/CL_SMRRPLTESECRETTOREG01`¶

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->replicatesecrettoregions(
  it_addreplicaregions = VALUE /aws1/cl_smrreplicaregiontype=>tt_addreplicaregionlisttype(
    (
      new /aws1/cl_smrreplicaregiontype(
        iv_kmskeyid = |string|
        iv_region = |string|
      )
    )
  )
  iv_forceoverwriterplsecret = ABAP_TRUE
  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( ).
  LOOP AT lo_result->get_replicationstatus( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_regiontype = lo_row_1->get_region( ).
      lv_kmskeyidtype = lo_row_1->get_kmskeyid( ).
      lv_statustype = lo_row_1->get_status( ).
      lv_statusmessagetype = lo_row_1->get_statusmessage( ).
      lv_lastaccesseddatetype = lo_row_1->get_lastaccesseddate( ).
    ENDIF.
  ENDLOOP.
ENDIF.

Example¶

The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key aws/secretsmanager.

DATA(lo_result) = lo_client->replicatesecrettoregions(
  it_addreplicaregions = VALUE /aws1/cl_smrreplicaregiontype=>tt_addreplicaregionlisttype(
    ( new /aws1/cl_smrreplicaregiontype( iv_region = |eu-west-3| )  )
  )
  iv_forceoverwriterplsecret = ABAP_TRUE
  iv_secretid = |MyTestSecret|
).

/AWS1/IF_SMR=>REPLICATESECRETTOREGIONS()¶