@aws-cdk/aws-s3objectlambda-alpha.IAccessPoint

Experimental

@aws-cdk/aws-s3objectlambda-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IAccessPoint Interface

The interface that represents the AccessPoint resource.

IAccessPoint

extends

• IResource

implemented by

• AccessPoint

Stability

Experimental

Source

lib/access-point.ts

Properties

accessPointArnstringaccess_point_arnstraccessPointArnStringAccessPointArnstringAccessPointArn*stringrequired#

The ARN of the access point.

accessPointCreationDatestringaccess_point_creation_datestraccessPointCreationDateStringAccessPointCreationDatestringAccessPointCreationDate*stringrequired#

The creation data of the access point.

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#

The IPv4 DNS name of the access point.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

regionalDomainNamestringregional_domain_namestrregionalDomainNameStringRegionalDomainNamestringRegionalDomainName*stringrequired#

The regional domain name of the access point.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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?: string, options?: VirtualHostedStyleUrlOptions): stringdef virtual_hosted_url_for_object(self, key: typing.Optional[str] = None, options: typing.Optional[VirtualHostedStyleUrlOptions] = None) -> strpublic String virtualHostedUrlForObject(String key, VirtualHostedStyleUrlOptions options)public string VirtualHostedUrlForObject(string? key = null, VirtualHostedStyleUrlOptions? options = null)func VirtualHostedUrlForObject(Key *string, Options VirtualHostedStyleUrlOptions) *string#

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

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

2 parameters · returns

Parameters

• keykeykeykeyKey — The S3 key of the object.
• optionsoptionsoptionsoptionsOptions — Options for generating URL.

Returns: an ObjectS3Url token

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining