Class PublicAccessBlockConfiguration

java.lang.Object
software.amazon.awssdk.services.s3control.model.PublicAccessBlockConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PublicAccessBlockConfiguration.Builder,PublicAccessBlockConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class PublicAccessBlockConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PublicAccessBlockConfiguration.Builder,PublicAccessBlockConfiguration>

The PublicAccessBlock configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.

This data type is not supported for Amazon S3 on Outposts.

See Also:

  • Method Details

    • blockPublicAcls

      public final Boolean blockPublicAcls()

      Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

      • PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public.

      • PUT Object calls fail if the request includes a public ACL.

      • PUT Bucket calls fail if the request includes a public ACL.

      Enabling this setting doesn't affect existing policies or ACLs.

      This property is not supported for Amazon S3 on Outposts.

      Returns:
      Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

      • PutBucketAcl and PutObjectAcl calls fail if the specified ACL is public.

      • PUT Object calls fail if the request includes a public ACL.

      • PUT Bucket calls fail if the request includes a public ACL.

      Enabling this setting doesn't affect existing policies or ACLs.

      This property is not supported for Amazon S3 on Outposts.

    • ignorePublicAcls

      public final Boolean ignorePublicAcls()

      Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

      Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

      This property is not supported for Amazon S3 on Outposts.

      Returns:
      Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.

      Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

      This property is not supported for Amazon S3 on Outposts.

    • blockPublicPolicy

      public final Boolean blockPublicPolicy()

      Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

      Enabling this setting doesn't affect existing bucket policies.

      This property is not supported for Amazon S3 on Outposts.

      Returns:
      Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

      Enabling this setting doesn't affect existing bucket policies.

      This property is not supported for Amazon S3 on Outposts.

    • restrictPublicBuckets

      public final Boolean restrictPublicBuckets()

      Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Servicesservice principals and authorized users within this account.

      Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

      This property is not supported for Amazon S3 on Outposts.

      Returns:
      Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE restricts access to buckets with public policies to only Amazon Web Servicesservice principals and authorized users within this account.

      Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

      This property is not supported for Amazon S3 on Outposts.

    • toBuilder

      public PublicAccessBlockConfiguration.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<PublicAccessBlockConfiguration.Builder,PublicAccessBlockConfiguration>
      Returns:
      a builder for type T

    • builder

      public static PublicAccessBlockConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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