interface CfnAccessPointProps

Language	Type name
.NET	Amazon.CDK.AWS.S3.CfnAccessPointProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnAccessPointProps
Java	software.amazon.awscdk.services.s3.CfnAccessPointProps
Python	aws_cdk.aws_s3.CfnAccessPointProps
TypeScript	aws-cdk-lib » aws_s3 » CfnAccessPointProps

Properties for defining a CfnAccessPoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

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';

declare const policy: any;
const cfnAccessPointProps: s3.CfnAccessPointProps = {
  bucket: 'bucket',

  // the properties below are optional
  bucketAccountId: 'bucketAccountId',
  name: 'name',
  policy: policy,
  publicAccessBlockConfiguration: {
    blockPublicAcls: false,
    blockPublicPolicy: false,
    ignorePublicAcls: false,
    restrictPublicBuckets: false,
  },
  vpcConfiguration: {
    vpcId: 'vpcId',
  },
};

Properties

Name	Type	Description
bucket	string	The name of the bucket associated with this access point.
bucketAccountId?	string	The AWS account ID associated with the S3 bucket associated with this access point.
name?	string	The name of this access point.
policy?	any	The access point policy associated with this access point.
publicAccessBlockConfiguration?	IResolvable | PublicAccessBlockConfigurationProperty	The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
vpcConfiguration?	IResolvable | VpcConfigurationProperty	The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

---

bucket

Type: string

The name of the bucket associated with this access point.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucket

---

bucketAccountId?

Type: string (optional)

The AWS account ID associated with the S3 bucket associated with this access point.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-bucketaccountid

---

name?

Type: string (optional)

The name of this access point.

If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-name

---

policy?

Type: any (optional)

The access point policy associated with this access point.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-policy

---

publicAccessBlockConfiguration?

Type: IResolvable | PublicAccessBlockConfigurationProperty (optional)

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-publicaccessblockconfiguration

---

vpcConfiguration?

Type: IResolvable | VpcConfigurationProperty (optional)

The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html#cfn-s3-accesspoint-vpcconfiguration