Container for the parameters to the ReplicateSecretToRegions operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SecretsManager.AmazonSecretsManagerRequest
Amazon.SecretsManager.Model.ReplicateSecretToRegionsRequest
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
Syntax
public class ReplicateSecretToRegionsRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The ReplicateSecretToRegionsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ReplicateSecretToRegionsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AddReplicaRegions | System.Collections.Generic.List<Amazon.SecretsManager.Model.ReplicaRegionType> |
Gets and sets the property AddReplicaRegions. A list of Regions in which to replicate the secret. |
|
|
ForceOverwriteReplicaSecret | System.Boolean |
Gets and sets the property ForceOverwriteReplicaSecret. Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten. |
|
|
SecretId | System.String |
Gets and sets the property SecretId. The ARN or name of the secret to replicate. |
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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5