software.amazon.awscdk.services.s3objectlambda

Interface IAccessPoint.Jsii$Default

All Superinterfaces:

IAccessPoint, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IAccessPoint.Jsii$Proxy

Enclosing interface:

IAccessPoint

@Internal
public static interface IAccessPoint.Jsii$Default
extends IAccessPoint, IResource.Jsii$Default

Internal default implementation for IAccessPoint.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3objectlambda.IAccessPoint

IAccessPoint.Jsii$Default, IAccessPoint.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default String	getAccessPointArn() (experimental) The ARN of the access point.
default String	getAccessPointCreationDate() (experimental) The creation data of the access point.
default String	getDomainName() (experimental) The IPv4 DNS name of the access point.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default ConstructNode	getNode() The construct tree node for this construct.
default String	getRegionalDomainName() (experimental) The regional domain name of the access point.
default Stack	getStack() The stack in which this resource is defined.
default String	virtualHostedUrlForObject(String key, VirtualHostedStyleUrlOptions options) (experimental) The virtual hosted-style URL of an S3 object through this access point.

Methods inherited from interface software.amazon.awscdk.services.s3objectlambda.IAccessPoint

virtualHostedUrlForObject, virtualHostedUrlForObject

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getAccessPointArn

@Stability(value=Experimental)
 @NotNull
default String getAccessPointArn()

(experimental) The ARN of the access point.

Specified by:

getAccessPointArn in interface IAccessPoint

getAccessPointCreationDate

@Stability(value=Experimental)
 @NotNull
default String getAccessPointCreationDate()

(experimental) The creation data of the access point.

Specified by:

getAccessPointCreationDate in interface IAccessPoint

getDomainName

@Stability(value=Experimental)
 @NotNull
default String getDomainName()

(experimental) The IPv4 DNS name of the access point.

Specified by:

getDomainName in interface IAccessPoint

getRegionalDomainName

@Stability(value=Experimental)
 @NotNull
default String getRegionalDomainName()

(experimental) The regional domain name of the access point.

Specified by:

getRegionalDomainName in interface IAccessPoint

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

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

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

virtualHostedUrlForObject

@Stability(value=Experimental)
 @NotNull
default String virtualHostedUrlForObject(@Nullable
                                                                                  String key,
                                                                                  @Nullable
                                                                                  VirtualHostedStyleUrlOptions options)

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

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

Specified by:

virtualHostedUrlForObject in interface IAccessPoint

Parameters:

key - The S3 key of the object.

options - Options for generating URL.

Returns:

an ObjectS3Url token