Class: Aws::SecretsManager::Types::PutResourcePolicyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecretsManager::Types::PutResourcePolicyRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-secretsmanager/types.rb
Overview
When making an API call, you may pass PutResourcePolicyRequest data as a hash:
{
secret_id: "SecretIdType", # required
resource_policy: "NonEmptyResourcePolicyType", # required
}
Instance Attribute Summary collapse
-
#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
#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*.
[1]: docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
1118 1119 1120 1121 1122 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1118 class PutResourcePolicyRequest < Struct.new( :secret_id, :resource_policy) include Aws::Structure end |
#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.
<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 that end with a hyphen followed by six characters.
</note>
1118 1119 1120 1121 1122 |
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1118 class PutResourcePolicyRequest < Struct.new( :secret_id, :resource_policy) include Aws::Structure end |