Container for the parameters to the PutResourcePolicy operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SecretsManager.AmazonSecretsManagerRequest
Amazon.SecretsManager.Model.PutResourcePolicyRequest
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
Syntax
public class PutResourcePolicyRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The PutResourcePolicyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutResourcePolicyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BlockPublicPolicy | System.Boolean |
Gets and sets the property BlockPublicPolicy. Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren't blocked. Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:
To review permissions to your secrets, see Determine who has permissions to your secrets. |
|
|
ResourcePolicy | System.String |
Gets and sets the property ResourcePolicy. A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples. |
|
|
SecretId | System.String |
Gets and sets the property SecretId. The ARN or name of the secret to attach the resource-based policy. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN. |
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:
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