Skip to content
v2.277.0

FileSystemConfig Struct ​

FileSystem configurations for the Lambda function.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
import * as constructs from 'constructs';

declare const connections: ec2.Connections;
declare const dependable: constructs.IDependable;
declare const policyStatement: iam.PolicyStatement;
const fileSystemConfig: lambda.FileSystemConfig = {
  arn: 'arn',
  localMountPath: 'localMountPath',

  // the properties below are optional
  connections: connections,
  dependency: [dependable],
  policies: [policyStatement],
};
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_ec2 as ec2
from aws_cdk import aws_iam as iam
from aws_cdk import aws_lambda as lambda_
import constructs as constructs

# connections: ec2.Connections
# dependable: constructs.IDependable
# policy_statement: iam.PolicyStatement

file_system_config = lambda.FileSystemConfig(
    arn="arn",
    local_mount_path="localMountPath",

    # the properties below are optional
    connections=connections,
    dependency=[dependable],
    policies=[policy_statement]
)
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.ec2.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.services.lambda.*;
import software.constructs.*;

Connections connections;
IDependable dependable;
PolicyStatement policyStatement;

FileSystemConfig fileSystemConfig = FileSystemConfig.builder()
        .arn("arn")
        .localMountPath("localMountPath")

        // the properties below are optional
        .connections(connections)
        .dependency(List.of(dependable))
        .policies(List.of(policyStatement))
        .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.EC2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.Lambda;
using Constructs;

Connections connections;
IDependable dependable;
PolicyStatement policyStatement;
var fileSystemConfig = new FileSystemConfig {
    Arn = "arn",
    LocalMountPath = "localMountPath",

    // the properties below are optional
    Connections = connections,
    Dependency = new [] { dependable },
    Policies = new [] { policyStatement }
};
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"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import constructs "github.com/aws/constructs-go/constructs"

var connections Connections
var dependable IDependable
var policyStatement PolicyStatement

fileSystemConfig := &FileSystemConfig{
	Arn: jsii.String("arn"),
	LocalMountPath: jsii.String("localMountPath"),

	// the properties below are optional
	Connections: connections,
	Dependency: []IDependable{
		dependable,
	},
	Policies: []PolicyStatement{
		policyStatement,
	},
}

Properties ​

arnstringarnstrarnStringArnstringArn*string required #
ARN of the access point.
connectionsoptionalConnectionsconnectionsoptionalConnectionsconnectionsoptionalConnectionsConnectionsoptionalConnectionsConnectionsoptionalConnections #
connections object used to allow ingress traffic from lambda function.

Default: no connections required to add extra ingress rules for Lambda function

dependencyoptionalIDependable[]dependencyoptionaltyping.List[IDependable]dependencyoptionalList<IDependable>DependencyoptionalIDependable[]Dependencyoptional*[]IDependable #
array of IDependable that lambda function depends on.

Default: no dependency

localMountPathstringlocal_mount_pathstrlocalMountPathStringLocalMountPathstringLocalMountPath*string required #
mount path in the lambda runtime environment.
policiesoptionalPolicyStatement[]policiesoptionaltyping.List[PolicyStatement]policiesoptionalList<PolicyStatement>PoliciesoptionalPolicyStatement[]Policiesoptional*[]PolicyStatement #
additional IAM policies required for the lambda function.

Default: no additional policies required