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

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

Overview

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

Returns:

  • (Boolean)


1708
1709
1710
1711
1712
1713
1714
1715
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1708

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

#policy_name ⇒ String

The name of the resource policy to attach. If you don't specify this field, Secrets Manager uses default. You can only attach the default policy; if you specify any other name, the operation returns an InvalidParameterException.

Returns:

  • (String)


1708
1709
1710
1711
1712
1713
1714
1715
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1708

class PutResourcePolicyRequest < Struct.new(
  :secret_id,
  :resource_policy,
  :policy_name,
  :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.

Returns:

  • (String)


1708
1709
1710
1711
1712
1713
1714
1715
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1708

class PutResourcePolicyRequest < Struct.new(
  :secret_id,
  :resource_policy,
  :policy_name,
  :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. See Finding a secret from a partial ARN.

Returns:

  • (String)


1708
1709
1710
1711
1712
1713
1714
1715
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1708

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