Class: Aws::SecretsManager::Types::ValidateResourcePolicyRequest

Inherits:

Struct

Object
Struct
Aws::SecretsManager::Types::ValidateResourcePolicyRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass ValidateResourcePolicyRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#resource_policy ⇒ String

A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy.
#secret_id ⇒ String

(Optional) The identifier of the secret with the resource-based policy you want to validate.

Instance Attribute Details

#resource_policy ⇒ `String`

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] in the *CLI User Guide*.publi

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

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 2426

class ValidateResourcePolicyRequest < Struct.new(
  :secret_id,
  :resource_policy)
  SENSITIVE = []
  include Aws::Structure
end

#secret_id ⇒ `String`

(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.