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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

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

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#block_public_policy ⇒ Boolean

Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.

Returns:

  • (Boolean) 


1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1231

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

#resource_policy ⇒ String

A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see [Permissions policy examples].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html

Returns:

  • (String) 


1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1231

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

#secret_id ⇒ String

The ARN or name of the secret to attach the resource-based policy.

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

Returns:

  • (String) 


1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1231

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