interface IAccessPoint 🔹

Language	Type name
.NET	Amazon.CDK.AWS.S3ObjectLambda.Alpha.IAccessPoint
Go	github.com/aws/aws-cdk-go/awscdks3objectlambdaalpha/v2#IAccessPoint
Java	software.amazon.awscdk.services.s3objectlambda.alpha.IAccessPoint
Python	aws_cdk.aws_s3objectlambda_alpha.IAccessPoint
TypeScript (source)	@aws-cdk/aws-s3objectlambda-alpha » IAccessPoint

Implemented by AccessPoint

Obtainable from AccessPoint.fromAccessPointAttributes()

The interface that represents the AccessPoint resource.

Properties

Name	Type	Description
accessPointArn🔹	string	The ARN of the access point.
accessPointCreationDate🔹	string	The creation data of the access point.
domainName🔹	string	The IPv4 DNS name of the access point.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
regionalDomainName🔹	string	The regional domain name of the access point.
stack🔹	Stack	The stack in which this resource is defined.

---

accessPointArn🔹

Type: string

The ARN of the access point.

---

accessPointCreationDate🔹

Type: string

The creation data of the access point.

---

domainName🔹

Type: string

The IPv4 DNS name of the access point.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

regionalDomainName🔹

Type: string

The regional domain name of the access point.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
virtualHostedUrlForObject(key?, options?)🔹	The virtual hosted-style URL of an S3 object through this access point.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

virtualHostedUrlForObject(key?, options?)🔹

public virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string

Parameters

• key string — The S3 key of the object.
• options VirtualHostedStyleUrlOptions — Options for generating URL.

Returns

• string

The virtual hosted-style URL of an S3 object through this access point.

Specify regional: false at the options for non-regional URL.