interface PublicAccessBlockConfigurationProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.S3.CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnMultiRegionAccessPoint_PublicAccessBlockConfigurationProperty |
Java | software.amazon.awscdk.services.s3.CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty |
Python | aws_cdk.aws_s3.CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty |
TypeScript | aws-cdk-lib » aws_s3 » CfnMultiRegionAccessPoint » PublicAccessBlockConfigurationProperty |
The PublicAccessBlock configuration that you want to apply to this Amazon S3 Multi-Region Access Point.
You can enable the configuration options in any combination. For more information about when Amazon S3 considers an 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 { aws_s3 as s3 } from 'aws-cdk-lib';
const publicAccessBlockConfigurationProperty: s3.CfnMultiRegionAccessPoint.PublicAccessBlockConfigurationProperty = {
blockPublicAcls: false,
blockPublicPolicy: false,
ignorePublicAcls: false,
restrictPublicBuckets: false,
};
Properties
Name | Type | Description |
---|---|---|
block | boolean | IResolvable | Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. |
block | boolean | IResolvable | Specifies whether Amazon S3 should block public bucket policies for this bucket. |
ignore | boolean | IResolvable | Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. |
restrict | boolean | IResolvable | Specifies whether Amazon S3 should restrict public bucket policies for this bucket. |
blockPublicAcls?
Type:
boolean |
IResolvable
(optional)
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.
blockPublicPolicy?
Type:
boolean |
IResolvable
(optional)
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.
ignorePublicAcls?
Type:
boolean |
IResolvable
(optional)
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.
restrictPublicBuckets?
Type:
boolean |
IResolvable
(optional)
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.