Skip to content
v2.276.0

S3FilesConfigProperty Struct ​

Setting controls how your function accesses data from an Amazon S3 file system.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const s3FilesConfigProperty: lambda.CfnFunction.S3FilesConfigProperty = {
  directS3Read: 'directS3Read',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

s3_files_config_property = lambda.CfnFunction.S3FilesConfigProperty(
    direct_s3_read="directS3Read"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;

S3FilesConfigProperty s3FilesConfigProperty = S3FilesConfigProperty.builder()
        .directS3Read("directS3Read")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var s3FilesConfigProperty = new S3FilesConfigProperty {
    DirectS3Read = "directS3Read"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

s3FilesConfigProperty := &S3FilesConfigProperty{
	DirectS3Read: jsii.String("directS3Read"),
}

Properties ​

directS3Readoptionalstringdirect_s3_readoptionalstrdirectS3ReadoptionalStringDirectS3ReadoptionalstringDirectS3Readoptional*string#
Specifies if a function reads from the file system for the lowest latency, or through Amazon S3 Files feature "direct Amazon S3 bucket reads" for the highest throughput.
notes

Valid values:

  • AUTO (default) – Direct reads are active for functions you configure with 512 MB or more of memory.
  • ENABLED – Enforces all reads are directly from the Amazon S3 bucket, regardless of available memory (less than 512 MB).
  • DISABLED – Routes all reads through the file system, regardless of memory configuration.

To use direct reads, you must grant the execution role the s3:GetObject and s3:GetObjectVersion permissions. If a direct read fails, Lambda automatically falls back to reading through the file system.