Show / Hide Table of Contents

Class AccessPoint

(experimental) An S3 object lambda access point for intercepting and transforming GetObject requests.

Inheritance
object
Resource
AccessPoint
Implements
IAccessPoint
IResource
IConstruct
IDependable
IEnvironmentAware
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(string, IArnComponents)
Resource.GetResourceNameAttribute(string)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.S3ObjectLambda.Alpha
Assembly: Amazon.CDK.AWS.S3ObjectLambda.Alpha.dll
Syntax (csharp)
public class AccessPoint : Resource, IAccessPoint, IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class AccessPoint Inherits Resource Implements IAccessPoint, IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Lambda;
             using Amazon.CDK.AWS.S3;
             using Amazon.CDK.AWS.S3ObjectLambda.Alpha;
             using Amazon.CDK;

             var stack = new Stack();
             var bucket = new Bucket(stack, "MyBucket");
             var handler = new Function(stack, "MyFunction", new FunctionProps {
                 Runtime = Runtime.NODEJS_LATEST,
                 Handler = "index.handler",
                 Code = Code.FromAsset("lambda.zip")
             });
             new AccessPoint(stack, "MyObjectLambda", new AccessPointProps {
                 Bucket = bucket,
                 Handler = handler,
                 AccessPointName = "my-access-point",
                 Payload = new Dictionary<string, object> {
                     { "prop", "value" }
                 }
             });

Synopsis

Constructors

AccessPoint(Construct, string, IAccessPointProps)

(experimental) An S3 object lambda access point for intercepting and transforming GetObject requests.

Properties

AccessPointArn

(experimental) The ARN of the access point.

AccessPointCreationDate

(experimental) The creation data of the access point.

AccessPointName

(experimental) The ARN of the access point.

DomainName

(experimental) Implement the IAccessPoint.domainName field.

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

RegionalDomainName

(experimental) Implement the IAccessPoint.regionalDomainName field.

S3AccessPointArn

(experimental) The ARN of the S3 access point.

Methods

FromAccessPointAttributes(Construct, string, IAccessPointAttributes)

(experimental) Reference an existing AccessPoint defined outside of the CDK code.

VirtualHostedUrlForObject(string?, IVirtualHostedStyleUrlOptions?)

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

Constructors

AccessPoint(Construct, string, IAccessPointProps)

(experimental) An S3 object lambda access point for intercepting and transforming GetObject requests.

public AccessPoint(Construct scope, string id, IAccessPointProps props)
Parameters
scope Construct
id string
props IAccessPointProps
Remarks

Stability: Experimental

Properties

AccessPointArn

(experimental) The ARN of the access point.

public virtual string AccessPointArn { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: true

AccessPointCreationDate

(experimental) The creation data of the access point.

public virtual string AccessPointCreationDate { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: true

AccessPointName

(experimental) The ARN of the access point.

public virtual string AccessPointName { get; }
Property Value

string

Remarks

Stability: Experimental

DomainName

(experimental) Implement the IAccessPoint.domainName field.

public virtual string DomainName { get; }
Property Value

string

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Stability: Experimental

RegionalDomainName

(experimental) Implement the IAccessPoint.regionalDomainName field.

public virtual string RegionalDomainName { get; }
Property Value

string

Remarks

Stability: Experimental

S3AccessPointArn

(experimental) The ARN of the S3 access point.

public virtual string S3AccessPointArn { get; }
Property Value

string

Remarks

Stability: Experimental

Methods

FromAccessPointAttributes(Construct, string, IAccessPointAttributes)

(experimental) Reference an existing AccessPoint defined outside of the CDK code.

public static IAccessPoint FromAccessPointAttributes(Construct scope, string id, IAccessPointAttributes attrs)
Parameters
scope Construct
id string
attrs IAccessPointAttributes
Returns

IAccessPoint

Remarks

Stability: Experimental

VirtualHostedUrlForObject(string?, IVirtualHostedStyleUrlOptions?)

(experimental) Implement the IAccessPoint.virtualHostedUrlForObject method.

public virtual string VirtualHostedUrlForObject(string? key = null, IVirtualHostedStyleUrlOptions? options = null)
Parameters
key string
options IVirtualHostedStyleUrlOptions
Returns

string

Remarks

Stability: Experimental

Implements

IAccessPoint
IResource
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
Back to top Generated by DocFX