AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-secretsmanager/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

Instance Attribute Details

#resource_policyString

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

Returns:

  • (String)


2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2426

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

#secret_idString

(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.

Returns:

  • (String)


2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 2426

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