software.amazon.awssdk.services.s3.model

Interface PublicAccessBlockConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PublicAccessBlockConfiguration.Builder,PublicAccessBlockConfiguration>, SdkBuilder<PublicAccessBlockConfiguration.Builder,PublicAccessBlockConfiguration>, SdkPojo

Enclosing class:

PublicAccessBlockConfiguration

public static interface PublicAccessBlockConfiguration.Builder
extends SdkPojo, CopyableBuilder<PublicAccessBlockConfiguration.Builder,PublicAccessBlockConfiguration>

Method Summary

Modifier and Type	Method and Description
PublicAccessBlockConfiguration.Builder	blockPublicAcls(Boolean blockPublicAcls) Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket.
PublicAccessBlockConfiguration.Builder	blockPublicPolicy(Boolean blockPublicPolicy) Specifies whether Amazon S3 should block public bucket policies for this bucket.
PublicAccessBlockConfiguration.Builder	ignorePublicAcls(Boolean ignorePublicAcls) Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket.
PublicAccessBlockConfiguration.Builder	restrictPublicBuckets(Boolean restrictPublicBuckets) Specifies whether Amazon S3 should restrict public bucket policies for this bucket.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

blockPublicAcls

PublicAccessBlockConfiguration.Builder blockPublicAcls(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.

Parameters:

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:

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

ignorePublicAcls

PublicAccessBlockConfiguration.Builder ignorePublicAcls(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.

Parameters:

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:

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

blockPublicPolicy

PublicAccessBlockConfiguration.Builder blockPublicPolicy(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.

Parameters:

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:

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

restrictPublicBuckets

PublicAccessBlockConfiguration.Builder restrictPublicBuckets(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 AWS 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.

Parameters:

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 AWS 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:

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