You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecretsManager::Types::PutResourcePolicyRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutResourcePolicyRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#block_public_policy ⇒ Boolean

Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.

Returns:

  • (Boolean) —

    Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.

#resource_policy ⇒ String

A JSON-formatted string that\'s constructed according to the grammar and syntax for an AWS 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 in the AWS CLI User Guide.

Returns:

  • (String) —

    A JSON-formatted string that\'s constructed according to the grammar and syntax for an AWS resource-based policy.

#secret_id ⇒ String

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

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.

Returns:

  • (String) —

    Specifies the secret that you want to attach the resource-based policy to.