interface CfnAccessPointProps
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_s3express.CfnAccessPointProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awss3express#CfnAccessPointProps |
![]() | software.amazon.awscdk.services.s3express.CfnAccessPointProps |
![]() | aws_cdk.aws_s3express.CfnAccessPointProps |
![]() | aws-cdk-lib » aws_s3express » CfnAccessPointProps |
Properties for defining a CfnAccessPoint
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3express as s3express } from 'aws-cdk-lib';
declare const policy: any;
const cfnAccessPointProps: s3express.CfnAccessPointProps = {
bucket: 'bucket',
// the properties below are optional
bucketAccountId: 'bucketAccountId',
name: 'name',
policy: policy,
publicAccessBlockConfiguration: {
blockPublicAcls: false,
blockPublicPolicy: false,
ignorePublicAcls: false,
restrictPublicBuckets: false,
},
scope: {
permissions: ['permissions'],
prefixes: ['prefixes'],
},
vpcConfiguration: {
vpcId: 'vpcId',
},
};
Properties
Name | Type | Description |
---|---|---|
bucket | string | The name of the bucket that you want to associate the access point with. |
bucket | string | The AWS account ID that owns the bucket associated with this access point. |
name? | string | An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix --xa-s3 . |
policy? | any | The access point policy associated with the specified access point. |
public | IResolvable | Public | Public access is blocked by default to access points for directory buckets. |
scope? | IResolvable | Scope | You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both. |
vpc | IResolvable | Vpc | If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC). |
bucket
Type:
string
The name of the bucket that you want to associate the access point with.
bucketAccountId?
Type:
string
(optional)
The AWS account ID that owns the bucket associated with this access point.
name?
Type:
string
(optional)
An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix --xa-s3
.
For example, accesspointname--zoneID--xa-s3.
policy?
Type:
any
(optional)
The access point policy associated with the specified access point.
publicAccessBlockConfiguration?
Type:
IResolvable
|
Public
(optional)
Public access is blocked by default to access points for directory buckets.
scope?
Type:
IResolvable
|
Scope
(optional)
You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.
For more information, see Manage the scope of your access points for directory buckets.
vpcConfiguration?
Type:
IResolvable
|
Vpc
(optional)
If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).