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
- Struct
- Aws::SecretsManager::Types::PutResourcePolicyRequest
- Defined in:
- (unknown)
Overview
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,
}
Instance Attribute Summary collapse
-
#block_public_policy ⇒ 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.
-
#secret_id ⇒ String
Specifies the secret that you want to attach the resource-based policy to.
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.
#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.
#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 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.