Skip to content

Get Resource Policy

secretsmanager_get_resource_policy R Documentation

Retrieves the JSON text of the resource-based policy document attached to the secret

Description

Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached 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:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Usage

secretsmanager_get_resource_policy(SecretId)

Arguments

SecretId

[required] The ARN or name of the secret to retrieve the attached resource-based policy for.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Value

A list with the following syntax:

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

Request syntax

svc$get_resource_policy(
  SecretId = "string"
)

Examples

## Not run: 
# The following example shows how to retrieve the resource-based policy
# that is attached to a secret.
svc$get_resource_policy(
  SecretId = "MyTestDatabaseSecret"
)

## End(Not run)