Class AccessPointProps
(experimental) The S3 object lambda access point configuration.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.S3ObjectLambda.Alpha
Assembly: Amazon.CDK.AWS.S3ObjectLambda.Alpha.dll
Syntax (csharp)
public class AccessPointProps : Object, IAccessPointProps
Syntax (vb)
Public Class AccessPointProps
Inherits Object
Implements IAccessPointProps
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
AccessPointProps() |
Properties
AccessPointName | (experimental) The name of the S3 object lambda access point. |
Bucket | (experimental) The bucket to which this access point belongs. |
CloudWatchMetricsEnabled | (experimental) Whether CloudWatch metrics are enabled for the access point. |
Handler | (experimental) The Lambda function used to transform objects. |
Payload | (experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request. |
SupportsGetObjectPartNumber | (experimental) Whether the Lambda function can process |
SupportsGetObjectRange | (experimental) Whether the Lambda function can process |
Constructors
AccessPointProps()
public AccessPointProps()
Properties
AccessPointName
(experimental) The name of the S3 object lambda access point.
public string AccessPointName { get; set; }
Property Value
System.String
Remarks
Default: a unique name will be generated
Stability: Experimental
Bucket
(experimental) The bucket to which this access point belongs.
public IBucket Bucket { get; set; }
Property Value
Remarks
Stability: Experimental
CloudWatchMetricsEnabled
(experimental) Whether CloudWatch metrics are enabled for the access point.
public Nullable<bool> CloudWatchMetricsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
Handler
(experimental) The Lambda function used to transform objects.
public IFunction Handler { get; set; }
Property Value
Remarks
Stability: Experimental
Payload
(experimental) Additional JSON that provides supplemental data passed to the Lambda function on every request.
public IDictionary<string, object> Payload { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: - No data.
Stability: Experimental
SupportsGetObjectPartNumber
(experimental) Whether the Lambda function can process GetObject-PartNumber
requests.
public Nullable<bool> SupportsGetObjectPartNumber { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
SupportsGetObjectRange
(experimental) Whether the Lambda function can process GetObject-Range
requests.
public Nullable<bool> SupportsGetObjectRange { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental