interface IAccessPoint
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.S3ObjectLambda.Alpha.IAccessPoint |
![]() | github.com/aws/aws-cdk-go/awscdks3objectlambdaalpha/v2#IAccessPoint |
![]() | software.amazon.awscdk.services.s3objectlambda.alpha.IAccessPoint |
![]() | aws_cdk.aws_s3objectlambda_alpha.IAccessPoint |
![]() | @aws-cdk/aws-s3objectlambda-alpha ยป IAccessPoint |
Implemented by
Access
Obtainable from
Access
.fromAccessPointAttributes()
The interface that represents the AccessPoint resource.
Properties
Name | Type | Description |
---|---|---|
access | string | The ARN of the access point. |
access | string | The creation data of the access point. |
domain | string | The IPv4 DNS name of the access point. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
regional | 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:
Resource
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
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
virtual | The virtual hosted-style URL of an S3 object through this access point. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
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
).
virtualHostedUrlForObject(key?, options?)
public virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string
Parameters
- key
string
โ The S3 key of the object. - options
Virtual
โ Options for generating URL.Hosted Style Url Options
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.