Package software.amazon.awssdk.services.dynamodb.model

Interface PutResourcePolicyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>, DynamoDbRequest.Builder, SdkBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutResourcePolicyRequest
public static interface PutResourcePolicyRequest.Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

  • Method Details

    • resourceArn

      PutResourcePolicyRequest.Builder resourceArn(String resourceArn)

      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.

      Parameters:
      resourceArn - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policy

      PutResourcePolicyRequest.Builder policy(String policy)

      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.

      Parameters:
      policy - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expectedRevisionId

      PutResourcePolicyRequest.Builder expectedRevisionId(String expectedRevisionId)

      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.

      Parameters:
      expectedRevisionId - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • confirmRemoveSelfResourceAccess

      PutResourcePolicyRequest.Builder confirmRemoveSelfResourceAccess(Boolean 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutResourcePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutResourcePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.