@aws-cdk_aws-s3objectlambda-alpha.IAccessPoint

interface IAccessPoint ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.S3ObjectLambda.Alpha.IAccessPoint
Gogithub.com/aws/aws-cdk-go/awscdks3objectlambdaalpha/v2#IAccessPoint
Javasoftware.amazon.awscdk.services.s3objectlambda.alpha.IAccessPoint
Pythonaws_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

NameTypeDescription
accessPointArn๐Ÿ”นstringThe ARN of the access point.
accessPointCreationDate๐Ÿ”นstringThe creation data of the access point.
domainName๐Ÿ”นstringThe IPv4 DNS name of the access point.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
regionalDomainName๐Ÿ”นstringThe regional domain name of the access point.
stack๐Ÿ”นStackThe 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 by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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

NameDescription
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.