Container for the parameters to the ValidateResourcePolicy operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SecretsManager.AmazonSecretsManagerRequest
Amazon.SecretsManager.Model.ValidateResourcePolicyRequest
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
Syntax
public class ValidateResourcePolicyRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The ValidateResourcePolicyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ValidateResourcePolicyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ResourcePolicy | System.String |
Gets and sets the property ResourcePolicy. A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples. |
|
|
SecretId | System.String |
Gets and sets the property SecretId. This field is reserved for internal use. |
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5