Interface CfnAccessPointProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAccessPointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-12-01T16:02:28.860Z")
@Stability(Stable)
public interface CfnAccessPointProps
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.s3express.*;
Object policy;
CfnAccessPointProps cfnAccessPointProps = CfnAccessPointProps.builder()
.bucket("bucket")
// the properties below are optional
.bucketAccountId("bucketAccountId")
.name("name")
.policy(policy)
.publicAccessBlockConfiguration(PublicAccessBlockConfigurationProperty.builder()
.blockPublicAcls(false)
.blockPublicPolicy(false)
.ignorePublicAcls(false)
.restrictPublicBuckets(false)
.build())
.scope(ScopeProperty.builder()
.permissions(List.of("permissions"))
.prefixes(List.of("prefixes"))
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcConfiguration(VpcConfigurationProperty.builder()
.vpcId("vpcId")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAccessPointPropsstatic final classAn implementation forCfnAccessPointProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAccessPointProps.Builderbuilder()The name of the bucket that you want to associate the access point with.default StringThe AWS account ID that owns the bucket associated with this access point.default StringgetName()An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix--xa-s3.default ObjectThe access point policy associated with the specified access point.default ObjectPublic access is blocked by default to access points for directory buckets.default ObjectgetScope()You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.getTags()An array of tags that you can apply to access points.default ObjectIf you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBucket
The name of the bucket that you want to associate the access point with.- See Also:
-
getBucketAccountId
The AWS account ID that owns the bucket associated with this access point.- See Also:
-
getName
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.
- See Also:
-
getPolicy
The access point policy associated with the specified access point.- See Also:
-
getPublicAccessBlockConfiguration
Public access is blocked by default to access points for directory buckets.Returns union: either
IResolvableorCfnAccessPoint.PublicAccessBlockConfigurationProperty- See Also:
-
getScope
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.
Returns union: either
IResolvableorCfnAccessPoint.ScopeProperty- See Also:
-
getTags
An array of tags that you can apply to access points.Tags are key-value pairs of metadata used to categorize your access points and control access. For more information, see Using tags for attribute-based access control (ABAC) .
- See Also:
-
getVpcConfiguration
If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).Returns union: either
IResolvableorCfnAccessPoint.VpcConfigurationProperty- See Also:
-
builder
- Returns:
- a
CfnAccessPointProps.BuilderofCfnAccessPointProps
-