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

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

Overview

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, for example those that use a wildcard for the principal. By default, public policies aren’t blocked.

Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:

* Identity-based policies attached to associated Amazon Web

Services

principals (for example, IAM roles)
  • Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

To review permissions to your secrets, see [Determine who has

permissions to your secrets].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html

Returns:

  • (Boolean)


1298
1299
1300
1301
1302
1303
1304
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1298

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

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

Returns:

  • (String)


1298
1299
1300
1301
1302
1303
1304
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1298

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

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

Returns:

  • (String)


1298
1299
1300
1301
1302
1303
1304
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1298

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