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

Class PutResourcePolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest
software.amazon.awssdk.services.dynamodb.model.PutResourcePolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutResourcePolicyRequest extends DynamoDbRequest implements ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

  • Method Details

    • resourceArn

      public final 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.

      Returns:
      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.

    • policy

      public final 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.

      Returns:
      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.

    • expectedRevisionId

      public final 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.

      Returns:
      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.

    • confirmRemoveSelfResourceAccess

      public final 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.

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

    • toBuilder

      public PutResourcePolicyRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>
      Specified by:
      toBuilder in class DynamoDbRequest
      Returns:
      a builder for type T

    • builder

      public static PutResourcePolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutResourcePolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.