put_resource_policy¶
Operation¶
put_resource_policy
¶
put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> PutResourcePolicyOutput
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutResourcePolicy. For more
information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutResourcePolicyInput | PutResourcePolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutResourcePolicyOutput
|
An instance of |
put_resource_policy
async
¶
put_resource_policy(request: PutResourcePolicyInput | PutResourcePolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutResourcePolicyInputDict]) -> PutResourcePolicyOutput
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutResourcePolicy. For more
information, see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutResourcePolicyInput | PutResourcePolicyInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutResourcePolicyInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutResourcePolicyOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
PutResourcePolicyInputDict
¶
Bases: TypedDict
Dictionary form of PutResourcePolicyInput.
Attributes¶
block_public_policy
instance-attribute
¶
block_public_policy: bool | None
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.
Warning
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.
policy_name
instance-attribute
¶
policy_name: str | None
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.
resource_policy
instance-attribute
¶
A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
secret_id
instance-attribute
¶
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.
PutResourcePolicyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutResourcePolicyInput structure.
Attributes¶
block_public_policy
class-attribute
instance-attribute
¶
block_public_policy: bool | None = ...
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.
Warning
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.
policy_name
class-attribute
instance-attribute
¶
policy_name: str | None = ...
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.
resource_policy
class-attribute
instance-attribute
¶
resource_policy: str | None = ...
A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
secret_id
class-attribute
instance-attribute
¶
secret_id: str | None = ...
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.
Output¶
PutResourcePolicyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutResourcePolicyOutput structure.
Attributes¶
policy_name
class-attribute
instance-attribute
¶
policy_name: str | None = ...
The name of the resource policy. If you didn't specify PolicyName in
the request, this is default.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.