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

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 PutResourcePolicyRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#block_public_policyBoolean

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)


1263
1264
1265
1266
1267
1268
1269
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1263

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

#resource_policyString

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

Returns:

  • (String)


1263
1264
1265
1266
1267
1268
1269
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1263

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

#secret_idString

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. See Finding a secret from a partial ARN.

Returns:

  • (String)


1263
1264
1265
1266
1267
1268
1269
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1263

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