com.amazonaws.services.s3control.model

Class PublicAccessBlockConfiguration

java.lang.Object

com.amazonaws.services.s3control.model.PublicAccessBlockConfiguration

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PublicAccessBlockConfiguration
extends Object
implements Serializable, Cloneable

The container element for all Public Access Block configuration options. You can enable the configuration options in any combination.

Amazon S3 considers a bucket policy public unless at least one of the following conditions is true:

1. The policy limits access to a set of CIDRs using aws:SourceIp. For more information on CIDR, see http://www.rfc-editor.org/rfc/rfc4632.txt

2. The policy grants permissions, not including any "bad actions," to one of the following:

   • A fixed AWS principal, user, role, or service principal

   • A fixed aws:SourceArn

   • A fixed aws:SourceVpc

   • A fixed aws:SourceVpce

   • A fixed aws:SourceOwner

   • A fixed aws:SourceAccount

   • A fixed value of s3:x-amz-server-side-encryption-aws-kms-key-id

   • A fixed value of aws:userid outside the pattern "AROLEID:*"

"Bad actions" are those that could expose the data inside a bucket to reads or writes by the public. These actions are s3:Get*, s3:List*, s3:AbortMultipartUpload, s3:Delete*, s3:Put*, and s3:RestoreObject.

The star notation for bad actions indicates that all matching operations are considered bad actions. For example, because s3:Get* is a bad action, s3:GetObject, s3:GetObjectVersion, and s3:GetObjectAcl are all bad actions.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PublicAccessBlockConfiguration()

Method Summary

Modifier and Type	Method and Description
PublicAccessBlockConfiguration	clone()
boolean	equals(Object obj)
Boolean	getBlockPublicAcls() Specifies whether Amazon S3 should block public ACLs for buckets in this account.
Boolean	getBlockPublicPolicy() Specifies whether Amazon S3 should block public bucket policies for buckets in this account.
Boolean	getIgnorePublicAcls() Specifies whether Amazon S3 should ignore public ACLs for buckets in this account.
Boolean	getRestrictPublicBuckets() Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account.
int	hashCode()
Boolean	isBlockPublicAcls() Specifies whether Amazon S3 should block public ACLs for buckets in this account.
Boolean	isBlockPublicPolicy() Specifies whether Amazon S3 should block public bucket policies for buckets in this account.
Boolean	isIgnorePublicAcls() Specifies whether Amazon S3 should ignore public ACLs for buckets in this account.
Boolean	isRestrictPublicBuckets() Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account.
void	setBlockPublicAcls(Boolean blockPublicAcls) Specifies whether Amazon S3 should block public ACLs for buckets in this account.
void	setBlockPublicPolicy(Boolean blockPublicPolicy) Specifies whether Amazon S3 should block public bucket policies for buckets in this account.
void	setIgnorePublicAcls(Boolean ignorePublicAcls) Specifies whether Amazon S3 should ignore public ACLs for buckets in this account.
void	setRestrictPublicBuckets(Boolean restrictPublicBuckets) Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account.
String	toString() Returns a string representation of this object.
PublicAccessBlockConfiguration	withBlockPublicAcls(Boolean blockPublicAcls) Specifies whether Amazon S3 should block public ACLs for buckets in this account.
PublicAccessBlockConfiguration	withBlockPublicPolicy(Boolean blockPublicPolicy) Specifies whether Amazon S3 should block public bucket policies for buckets in this account.
PublicAccessBlockConfiguration	withIgnorePublicAcls(Boolean ignorePublicAcls) Specifies whether Amazon S3 should ignore public ACLs for buckets in this account.
PublicAccessBlockConfiguration	withRestrictPublicBuckets(Boolean restrictPublicBuckets) Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PublicAccessBlockConfiguration

public PublicAccessBlockConfiguration()

Method Detail

setBlockPublicAcls

public void setBlockPublicAcls(Boolean blockPublicAcls)

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

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that enabling this setting doesn't affect existing policies or ACLs.

Parameters:

blockPublicAcls - Specifies whether Amazon S3 should block public ACLs for buckets in this account. Setting this element to TRUE causes the following behavior:

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that enabling this setting doesn't affect existing policies or ACLs.

getBlockPublicAcls

public Boolean getBlockPublicAcls()

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

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that enabling this setting doesn't affect existing policies or ACLs.

Returns:

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

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that enabling this setting doesn't affect existing policies or ACLs.

withBlockPublicAcls

public PublicAccessBlockConfiguration withBlockPublicAcls(Boolean blockPublicAcls)

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

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that enabling this setting doesn't affect existing policies or ACLs.

Parameters:

blockPublicAcls - Specifies whether Amazon S3 should block public ACLs for buckets in this account. Setting this element to TRUE causes the following behavior:

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that 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.

isBlockPublicAcls

public Boolean isBlockPublicAcls()

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

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that enabling this setting doesn't affect existing policies or ACLs.

Returns:

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

• PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access.

• PUT Object calls will fail if the request includes an object ACL.

Note that enabling this setting doesn't affect existing policies or ACLs.

setIgnorePublicAcls

public void setIgnorePublicAcls(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.

Note that 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 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.

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

getIgnorePublicAcls

public Boolean getIgnorePublicAcls()

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.

Note that 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 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.

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

withIgnorePublicAcls

public PublicAccessBlockConfiguration withIgnorePublicAcls(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.

Note that 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 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.

Note that 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.

isIgnorePublicAcls

public Boolean isIgnorePublicAcls()

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.

Note that 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 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.

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

setBlockPublicPolicy

public void setBlockPublicPolicy(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.

Note that enabling this setting doesn't affect existing bucket policies.

Parameters:

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.

Note that enabling this setting doesn't affect existing bucket policies.

getBlockPublicPolicy

public Boolean getBlockPublicPolicy()

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.

Note that enabling this setting doesn't affect existing bucket policies.

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.

Note that enabling this setting doesn't affect existing bucket policies.

withBlockPublicPolicy

public PublicAccessBlockConfiguration withBlockPublicPolicy(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.

Note that enabling this setting doesn't affect existing bucket policies.

Parameters:

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.

Note that enabling this setting doesn't affect existing bucket policies.

Returns:

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

isBlockPublicPolicy

public Boolean isBlockPublicPolicy()

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.

Note that enabling this setting doesn't affect existing bucket policies.

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.

Note that enabling this setting doesn't affect existing bucket policies.

setRestrictPublicBuckets

public void setRestrictPublicBuckets(Boolean restrictPublicBuckets)

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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 buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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.

getRestrictPublicBuckets

public Boolean getRestrictPublicBuckets()

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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 buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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.

withRestrictPublicBuckets

public PublicAccessBlockConfiguration withRestrictPublicBuckets(Boolean restrictPublicBuckets)

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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 buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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.

isRestrictPublicBuckets

public Boolean isRestrictPublicBuckets()

Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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 buckets in this account. If this element is set to TRUE, then only the bucket owner and AWS Services can access buckets with public policies.

Note that 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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PublicAccessBlockConfiguration clone()

Overrides:

clone in class Object