class Aws::SecretsManager::Types::PutResourcePolicyRequest

@note When making an API call, you may pass PutResourcePolicyRequest

data as a hash:

    {
      secret_id: "SecretIdType", # required
      resource_policy: "NonEmptyResourcePolicyType", # required
      block_public_policy: false,
    }

@!attribute [rw] secret_id

Specifies the secret that you want to attach the resource-based
policy. You can specify either the ARN or the friendly name of the
secret.

<note markdown="1"> If you specify an ARN, we generally recommend that you specify a
complete ARN. You can specify a partial ARN too—for example, if you
don’t include the final hyphen and six random characters that
Secrets Manager adds at the end of the ARN when you created the
secret. A partial ARN match can work as long as it uniquely matches
only one secret. However, if your secret has a name that ends in a
hyphen followed by six characters (before Secrets Manager adds the
hyphen and six characters to the ARN) and you try to use that as a
partial ARN, then those characters cause Secrets Manager to assume
that you’re specifying a complete ARN. This confusion can cause
unexpected results. To avoid this situation, we recommend that you
don’t create secret names ending with a hyphen followed by six
characters.

 If you specify an incomplete ARN without the random suffix, and
instead provide the 'friendly name', you *must* not include the
random suffix. If you do include the random suffix added by Secrets
Manager, you receive either a *ResourceNotFoundException* or an
*AccessDeniedException* error, depending on your permissions.

 </note>
@return [String]

@!attribute [rw] resource_policy

A JSON-formatted string constructed according to the grammar and
syntax for an Amazon Web Services resource-based policy. The policy
in the string identifies who can access or manage this secret and
its versions. For information on how to format a JSON parameter for
the various command line tool environments, see [Using JSON for
Parameters][1] in the *CLI User Guide*.

[1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
@return [String]

@!attribute [rw] block_public_policy

(Optional) If you set the parameter, `BlockPublicPolicy` to true,
then you block resource-based policies that allow broad access to
the secret.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutResourcePolicyRequest AWS API Documentation

Constants

SENSITIVE