Skip to content

Put Resource Policy

secretsmanager_put_resource_policy R Documentation

Attaches a resource-based permission policy to a secret

Description

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.

Usage

secretsmanager_put_resource_policy(SecretId, ResourcePolicy,
  BlockPublicPolicy)

Arguments

SecretId

[required] 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.

ResourcePolicy

[required] A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

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:

  • Identity-based policies attached to associated Amazon Web Services principals (for example, IAM roles)

  • Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

To review permissions to your secrets, see Determine who has permissions to your secrets.

Value

A list with the following syntax: 

list(
  ARN = "string",
  Name = "string"
)

Request syntax

svc$put_resource_policy(
  SecretId = "string",
  ResourcePolicy = "string",
  BlockPublicPolicy = TRUE|FALSE
)

Examples

## Not run: 
# The following example shows how to add a resource-based policy to a
# secret.
svc$put_resource_policy(
  ResourcePolicy = "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"A...",
  SecretId = "MyTestDatabaseSecret"
)

## End(Not run)