AmazonSecretsManagerClient.PutResourcePolicy Method (PutResourcePolicyRequest)

Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager

For information about attaching a policy in the console, see Attach a permissions policy to a secret.

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:PutResourcePolicy. 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 PutResourcePolicyAsync.

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

Syntax

public virtual PutResourcePolicyResponse PutResourcePolicy(
         PutResourcePolicyRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.PutResourcePolicyRequest

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

Return Value

Type: PutResourcePolicyResponse

The response from the PutResourcePolicy 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.
MalformedPolicyDocumentException	The resource policy has syntax errors.
PublicPolicyException	The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

The following example shows how to add a resource-based policy to a secret.

To add a resource-based policy to a secret


            var client = new AmazonSecretsManagerClient();
            var response = client.PutResourcePolicy(new PutResourcePolicyRequest 
            {
                ResourcePolicy = "{
\"Version\":\"2012-10-17\",
\"Statement\":[{
\"Effect\":\"Allow\",
\"Principal\":{
\"AWS\":\"arn:aws:iam::123456789012:root\"
},
\"Action\":\"secretsmanager:GetSecretValue\",
\"Resource\":\"*\"
}]
}",
                SecretId = "MyTestDatabaseSecret"
            });

            string arn = response.ARN;
            string name = response.Name;

Version Information

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

AmazonSecretsManagerClient.PutResourcePolicy (PutResourcePolicyRequest)

Method