Class AccessPoint

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

Inheritance

System.Object

Resource

AccessPoint

Implements

IAccessPoint

IResource

Constructs.IConstruct

Constructs.IDependable

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

Syntax (vb)

Public Class AccessPoint
    Inherits Resource
    Implements IAccessPoint, IResource

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(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
AccessPoint(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
AccessPoint(Construct, String, IAccessPointProps)

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.
RegionalDomainName	(experimental) Implement the `IAccessPoint.regionalDomainName` field.

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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected AccessPoint(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

AccessPoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected AccessPoint(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

AccessPoint(Construct, String, IAccessPointProps)

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

Parameters

scope Constructs.Construct
id System.String
props IAccessPointProps

Remarks

Stability: Experimental

Properties

AccessPointArn

(experimental) The ARN of the access point.

public virtual string AccessPointArn { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

AccessPointCreationDate

(experimental) The creation data of the access point.

public virtual string AccessPointCreationDate { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

AccessPointName

(experimental) The ARN of the access point.

public virtual string AccessPointName { get; }

Property Value

System.String

Remarks

Stability: Experimental

DomainName

(experimental) Implement the IAccessPoint.domainName field.

public virtual string DomainName { get; }

Property Value

System.String

Remarks

Stability: Experimental

RegionalDomainName

(experimental) Implement the IAccessPoint.regionalDomainName field.

public virtual string RegionalDomainName { get; }

Property Value

System.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 Constructs.Construct
id System.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 System.String
options IVirtualHostedStyleUrlOptions

Returns

System.String

Remarks

Stability: Experimental

Implements

IAccessPoint

IResource

Constructs.IConstruct

Constructs.IDependable