Package software.amazon.awssdk.services.s3.model

Class PublicAccessBlockConfiguration

java.lang.Object

software.amazon.awssdk.services.s3.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 bucket. 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PublicAccessBlockConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	blockPublicAcls()	Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket.
Boolean	blockPublicPolicy()	Specifies whether Amazon S3 should block public bucket policies for this bucket.
static PublicAccessBlockConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	ignorePublicAcls()	Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket.
Boolean	restrictPublicBuckets()	Specifies whether Amazon S3 should restrict public bucket policies for this bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends PublicAccessBlockConfiguration.Builder>	serializableBuilderClass()
PublicAccessBlockConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

blockPublicAcls

public final Boolean blockPublicAcls()

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

• PUT Bucket ACL and PUT Object ACL 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.

Returns:

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

• PUT Bucket ACL and PUT Object ACL 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.

ignorePublicAcls

public final Boolean ignorePublicAcls()

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

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

Returns:

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

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

blockPublicPolicy

public final Boolean blockPublicPolicy()

Specifies whether Amazon S3 should block public bucket policies for this bucket. 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.

Returns:

Specifies whether Amazon S3 should block public bucket policies for this bucket. 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.

restrictPublicBuckets

public final Boolean restrictPublicBuckets()

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy.

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.

Returns:

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has a public policy.

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.

toBuilder

public PublicAccessBlockConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PublicAccessBlockConfiguration.Builder,PublicAccessBlockConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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