Replicate Secret to Regions

secretsmanager_replicate_secret_to_regions

R Documentation

Replicates the secret to a new Regions

Description

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.

Usage

secretsmanager_replicate_secret_to_regions(SecretId, AddReplicaRegions,
  ForceOverwriteReplicaSecret)

Arguments

SecretId

[required] The ARN or name of the secret to replicate.

AddReplicaRegions

[required] A list of Regions in which to replicate the secret.

ForceOverwriteReplicaSecret

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

Value

A list with the following syntax:

list(
  ARN = "string",
  ReplicationStatus = list(
    list(
      Region = "string",
      KmsKeyId = "string",
      Status = "InSync"|"Failed"|"InProgress",
      StatusMessage = "string",
      LastAccessedDate = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$replicate_secret_to_regions(
  SecretId = "string",
  AddReplicaRegions = list(
    list(
      Region = "string",
      KmsKeyId = "string"
    )
  ),
  ForceOverwriteReplicaSecret = TRUE|FALSE
)

Examples

## Not run: 
# The following example replicates a secret to eu-west-3. The replica is
# encrypted with the AWS managed key aws/secretsmanager.
svc$replicate_secret_to_regions(
  AddReplicaRegions = list(
    list(
      Region = "eu-west-3"
    )
  ),
  ForceOverwriteReplicaSecret = TRUE,
  SecretId = "MyTestSecret"
)

## End(Not run)