AmazonSecretsManagerClient.ValidateResourcePolicy Method (ValidateResourcePolicyRequest)

Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.

The API performs three checks when validating the policy:

Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.

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:ValidateResourcePolicy and 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 ValidateResourcePolicyAsync.

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

Syntax

public virtual ValidateResourcePolicyResponse ValidateResourcePolicy(
         ValidateResourcePolicyRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.ValidateResourcePolicyRequest

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

Return Value

Type: ValidateResourcePolicyResponse

The response from the ValidateResourcePolicy 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.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

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

To validate a resource-based policy to a secret


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

            bool policyValidationPassed = response.PolicyValidationPassed;
            List<ValidationErrorsEntry> validationErrors = response.ValidationErrors;

Version Information

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

AmazonSecretsManagerClient.ValidateResourcePolicy (ValidateResourcePolicyRequest)

Method