software.amazon.awssdk.services.s3control.model.PublicAccessBlockConfiguration Maven / Gradle / Ivy
Show all versions of s3control Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.s3control.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PublicAccessBlockConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField BLOCK_PUBLIC_ACLS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("BlockPublicAcls")
.getter(getter(PublicAccessBlockConfiguration::blockPublicAcls))
.setter(setter(Builder::blockPublicAcls))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BlockPublicAcls")
.unmarshallLocationName("BlockPublicAcls").build()).build();
private static final SdkField IGNORE_PUBLIC_ACLS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("IgnorePublicAcls")
.getter(getter(PublicAccessBlockConfiguration::ignorePublicAcls))
.setter(setter(Builder::ignorePublicAcls))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IgnorePublicAcls")
.unmarshallLocationName("IgnorePublicAcls").build()).build();
private static final SdkField BLOCK_PUBLIC_POLICY_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("BlockPublicPolicy")
.getter(getter(PublicAccessBlockConfiguration::blockPublicPolicy))
.setter(setter(Builder::blockPublicPolicy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BlockPublicPolicy")
.unmarshallLocationName("BlockPublicPolicy").build()).build();
private static final SdkField RESTRICT_PUBLIC_BUCKETS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("RestrictPublicBuckets")
.getter(getter(PublicAccessBlockConfiguration::restrictPublicBuckets))
.setter(setter(Builder::restrictPublicBuckets))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RestrictPublicBuckets")
.unmarshallLocationName("RestrictPublicBuckets").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BLOCK_PUBLIC_ACLS_FIELD,
IGNORE_PUBLIC_ACLS_FIELD, BLOCK_PUBLIC_POLICY_FIELD, RESTRICT_PUBLIC_BUCKETS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final Boolean blockPublicAcls;
private final Boolean ignorePublicAcls;
private final Boolean blockPublicPolicy;
private final Boolean restrictPublicBuckets;
private PublicAccessBlockConfiguration(BuilderImpl builder) {
this.blockPublicAcls = builder.blockPublicAcls;
this.ignorePublicAcls = builder.ignorePublicAcls;
this.blockPublicPolicy = builder.blockPublicPolicy;
this.restrictPublicBuckets = builder.restrictPublicBuckets;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Boolean blockPublicAcls() {
return blockPublicAcls;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Boolean ignorePublicAcls() {
return ignorePublicAcls;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Boolean blockPublicPolicy() {
return blockPublicPolicy;
}
/**
*
* 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 Services service
* 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.
*
*
* @return 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
* Services service 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.
*/
public final Boolean restrictPublicBuckets() {
return restrictPublicBuckets;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(blockPublicAcls());
hashCode = 31 * hashCode + Objects.hashCode(ignorePublicAcls());
hashCode = 31 * hashCode + Objects.hashCode(blockPublicPolicy());
hashCode = 31 * hashCode + Objects.hashCode(restrictPublicBuckets());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PublicAccessBlockConfiguration)) {
return false;
}
PublicAccessBlockConfiguration other = (PublicAccessBlockConfiguration) obj;
return Objects.equals(blockPublicAcls(), other.blockPublicAcls())
&& Objects.equals(ignorePublicAcls(), other.ignorePublicAcls())
&& Objects.equals(blockPublicPolicy(), other.blockPublicPolicy())
&& Objects.equals(restrictPublicBuckets(), other.restrictPublicBuckets());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PublicAccessBlockConfiguration").add("BlockPublicAcls", blockPublicAcls())
.add("IgnorePublicAcls", ignorePublicAcls()).add("BlockPublicPolicy", blockPublicPolicy())
.add("RestrictPublicBuckets", restrictPublicBuckets()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "BlockPublicAcls":
return Optional.ofNullable(clazz.cast(blockPublicAcls()));
case "IgnorePublicAcls":
return Optional.ofNullable(clazz.cast(ignorePublicAcls()));
case "BlockPublicPolicy":
return Optional.ofNullable(clazz.cast(blockPublicPolicy()));
case "RestrictPublicBuckets":
return Optional.ofNullable(clazz.cast(restrictPublicBuckets()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("BlockPublicAcls", BLOCK_PUBLIC_ACLS_FIELD);
map.put("IgnorePublicAcls", IGNORE_PUBLIC_ACLS_FIELD);
map.put("BlockPublicPolicy", BLOCK_PUBLIC_POLICY_FIELD);
map.put("RestrictPublicBuckets", RESTRICT_PUBLIC_BUCKETS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((PublicAccessBlockConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blockPublicAcls(Boolean blockPublicAcls);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ignorePublicAcls(Boolean ignorePublicAcls);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blockPublicPolicy(Boolean blockPublicPolicy);
/**
*
* 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 Services
* service 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.
*
*
* @param 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 Services service 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder restrictPublicBuckets(Boolean restrictPublicBuckets);
}
static final class BuilderImpl implements Builder {
private Boolean blockPublicAcls;
private Boolean ignorePublicAcls;
private Boolean blockPublicPolicy;
private Boolean restrictPublicBuckets;
private BuilderImpl() {
}
private BuilderImpl(PublicAccessBlockConfiguration model) {
blockPublicAcls(model.blockPublicAcls);
ignorePublicAcls(model.ignorePublicAcls);
blockPublicPolicy(model.blockPublicPolicy);
restrictPublicBuckets(model.restrictPublicBuckets);
}
public final Boolean getBlockPublicAcls() {
return blockPublicAcls;
}
public final void setBlockPublicAcls(Boolean blockPublicAcls) {
this.blockPublicAcls = blockPublicAcls;
}
@Override
public final Builder blockPublicAcls(Boolean blockPublicAcls) {
this.blockPublicAcls = blockPublicAcls;
return this;
}
public final Boolean getIgnorePublicAcls() {
return ignorePublicAcls;
}
public final void setIgnorePublicAcls(Boolean ignorePublicAcls) {
this.ignorePublicAcls = ignorePublicAcls;
}
@Override
public final Builder ignorePublicAcls(Boolean ignorePublicAcls) {
this.ignorePublicAcls = ignorePublicAcls;
return this;
}
public final Boolean getBlockPublicPolicy() {
return blockPublicPolicy;
}
public final void setBlockPublicPolicy(Boolean blockPublicPolicy) {
this.blockPublicPolicy = blockPublicPolicy;
}
@Override
public final Builder blockPublicPolicy(Boolean blockPublicPolicy) {
this.blockPublicPolicy = blockPublicPolicy;
return this;
}
public final Boolean getRestrictPublicBuckets() {
return restrictPublicBuckets;
}
public final void setRestrictPublicBuckets(Boolean restrictPublicBuckets) {
this.restrictPublicBuckets = restrictPublicBuckets;
}
@Override
public final Builder restrictPublicBuckets(Boolean restrictPublicBuckets) {
this.restrictPublicBuckets = restrictPublicBuckets;
return this;
}
@Override
public PublicAccessBlockConfiguration build() {
return new PublicAccessBlockConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}