Package software.amazon.awscdk.services.s3

Interface CfnAccessPoint.PublicAccessBlockConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnAccessPoint.PublicAccessBlockConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnAccessPoint
@Stability(Stable) public static interface CfnAccessPoint.PublicAccessBlockConfigurationProperty extends software.amazon.jsii.JsiiSerializable
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 PublicAccessBlockConfigurationProperty publicAccessBlockConfigurationProperty = PublicAccessBlockConfigurationProperty.builder()
         .blockPublicAcls(false)
         .blockPublicPolicy(false)
         .ignorePublicAcls(false)
         .restrictPublicBuckets(false)
         .build();

  • Method Details

    • getBlockPublicAcls

      @Stability(Stable) @Nullable default Object getBlockPublicAcls()
      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.

    • getBlockPublicPolicy

      @Stability(Stable) @Nullable default Object getBlockPublicPolicy()
      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.

    • getIgnorePublicAcls

      @Stability(Stable) @Nullable default Object getIgnorePublicAcls()
      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.

    • getRestrictPublicBuckets

      @Stability(Stable) @Nullable default Object getRestrictPublicBuckets()
      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.

    • builder

      @Stability(Stable) static CfnAccessPoint.PublicAccessBlockConfigurationProperty.Builder builder()
      Returns:
      a CfnAccessPoint.PublicAccessBlockConfigurationProperty.Builder of CfnAccessPoint.PublicAccessBlockConfigurationProperty