Skip to content

PutResourcePolicyInput

Source code in docs_src/capo_dynamodb/types/put_resource_policy_input.py
class PutResourcePolicyInput(TypedDict, closed=True):
    resource_arn: "capo_dynamodb.types.resource_arn_string.ResourceArnString"
    """<p>The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.</p> <p>You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the <code>Resource</code> field of a given <code>Statement</code> in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple <code>Statement</code> fields in your policy document.</p>"""
    policy: "capo_dynamodb.types.resource_policy.ResourcePolicy"
    """<p>An Amazon Web Services resource-based policy document in JSON format.</p> <ul> <li> <p>The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.</p> </li> <li> <p>Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.</p> </li> </ul> <p>For a full list of all considerations that apply while attaching a resource-based policy, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html">Resource-based policy considerations</a>.</p>"""
    expected_revision_id: NotRequired[
        "capo_dynamodb.types.policy_revision_id.PolicyRevisionId"
    ]
    """<p>A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.</p> <note> <p>When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a <code>PolicyNotFoundException</code>.</p> </note> <p>To conditionally attach a policy when no policy exists for the resource, specify <code>NO_POLICY</code> for the revision ID.</p>"""
    confirm_remove_self_resource_access: "capo_dynamodb.types.confirm_remove_self_resource_access.ConfirmRemoveSelfResourceAccess"
    """<p>Set this parameter to <code>true</code> to confirm that you want to remove your permissions to change the policy of this resource in the future.</p>"""

confirm_remove_self_resource_access instance-attribute

confirm_remove_self_resource_access: ConfirmRemoveSelfResourceAccess

Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.

expected_revision_id instance-attribute

expected_revision_id: NotRequired[PolicyRevisionId]

A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.

When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.

To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.

policy instance-attribute

An Amazon Web Services resource-based policy document in JSON format.

  • The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.

  • Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.

For a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.

resource_arn instance-attribute

resource_arn: ResourceArnString

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.

You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.