AmazonSecretsManagerClient.ReplicateSecretToRegions Method (ReplicateSecretToRegionsRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ReplicateSecretToRegionsAsync.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

public virtual ReplicateSecretToRegionsResponse ReplicateSecretToRegions(
         ReplicateSecretToRegionsRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.ReplicateSecretToRegionsRequest

Container for the necessary parameters to execute the ReplicateSecretToRegions service method.

Return Value

Type: ReplicateSecretToRegionsResponse

The response from the ReplicateSecretToRegions service method, as returned by SecretsManager.

Exceptions

Exception	Condition
InternalServiceErrorException	An error occurred on the server side.
InvalidParameterException	The parameter name or value is invalid.
InvalidRequestException	A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

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

Example


var client = new AmazonSecretsManagerClient();
var response = client.ReplicateSecretToRegions(new ReplicateSecretToRegionsRequest 
{
    AddReplicaRegions = new List<ReplicaRegionType> {
        new ReplicaRegionType { Region = "eu-west-3" }
    },
    ForceOverwriteReplicaSecret = true,
    SecretId = "MyTestSecret"
});

string arn = response.ARN;
List<ReplicationStatusType> replicationStatus = response.ReplicationStatus;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonSecretsManagerClient.ReplicateSecretToRegions (ReplicateSecretToRegionsRequest)

Method