Class PublicAccessBlockConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket.final Boolean
Specifies whether Amazon S3 should block public bucket policies for this bucket.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket.final Boolean
Specifies whether Amazon S3 should restrict public bucket policies for this bucket.static Class
<? extends PublicAccessBlockConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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 interfaceToCopyableBuilder<PublicAccessBlockConfiguration.Builder,
PublicAccessBlockConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-