GradientEdge CDK Utils
    Preparing search index...

    Interface EfsFileSystemProps

    interface EfsFileSystemProps {
        allowAnonymousAccess?: boolean;
        authorizationConfig?: AuthorizationConfig;
        enableAutomaticBackups?: boolean;
        encrypted?: boolean;
        fileSystemName?: string;
        fileSystemPolicy?: PolicyDocument;
        kmsKey?: IKeyRef;
        lifecyclePolicy?: LifecyclePolicy;
        oneZone?: boolean;
        outOfInfrequentAccessPolicy?: OutOfInfrequentAccessPolicy;
        performanceMode?: PerformanceMode;
        provisionedThroughputPerSecond?: Size;
        provisionNewOnDeployment?: boolean;
        removalPolicy?: RemovalPolicy;
        replicationConfiguration?: ReplicationConfiguration;
        replicationOverwriteProtection?: ReplicationOverwriteProtection;
        rootDirectory?: string;
        securityGroup?: ISecurityGroup;
        throughputMode?: ThroughputMode;
        transitEncryption?: string;
        transitEncryptionPort?: number;
        transitionToArchivePolicy?: LifecyclePolicy;
        vpc: IVpc;
        vpcSubnets?: SubnetSelection;
    }

    Hierarchy

    • FileSystemProps
      • EfsFileSystemProps
    Index

    Properties

    allowAnonymousAccess? authorizationConfig? enableAutomaticBackups? encrypted? fileSystemName? fileSystemPolicy? kmsKey? lifecyclePolicy? oneZone? outOfInfrequentAccessPolicy? performanceMode? provisionedThroughputPerSecond? provisionNewOnDeployment? removalPolicy? replicationConfiguration? replicationOverwriteProtection? rootDirectory? securityGroup? throughputMode? transitEncryption? transitEncryptionPort? transitionToArchivePolicy? vpc vpcSubnets?

    Properties

    allowAnonymousAccess?: boolean

    Allow access from anonymous client that doesn't use IAM authentication.

    false when using grantRead, grantWrite, grantRootAccess or set @aws-cdk/aws-efs:denyAnonymousAccess feature flag, otherwise true

    authorizationConfig?: AuthorizationConfig
    enableAutomaticBackups?: boolean

    Whether to enable automatic backups for the file system.

    false
    encrypted?: boolean

    Defines if the data at rest in the file system is encrypted or not.

    - If your application has the '@aws-cdk/aws-efs:defaultEncryptionAtRest' feature flag set, the default is true, otherwise, the default is false.

    https://docs.aws.amazon.com/cdk/latest/guide/featureflags.html

    fileSystemName?: string

    The file system's name.

    - CDK generated name
    fileSystemPolicy?: PolicyDocument

    File system policy is an IAM resource policy used to control NFS access to an EFS file system.

    none
    kmsKey?: IKeyRef

    The KMS key used for encryption. This is required to encrypt the data at rest if

    is set to true.

    - if 'encrypted' is true, the default key for EFS (/aws/elasticfilesystem) is used
    lifecyclePolicy?: LifecyclePolicy

    A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

    - None. EFS will not transition files to the IA storage class.
    oneZone?: boolean

    Whether this is a One Zone file system. If enabled, performanceMode must be set to GENERAL_PURPOSE and vpcSubnets cannot be set.

    false

    https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type

    outOfInfrequentAccessPolicy?: OutOfInfrequentAccessPolicy

    A policy used by EFS lifecycle management to transition files from Infrequent Access (IA) storage class to primary storage class.

    - None. EFS will not transition files from IA storage to primary storage.
    performanceMode?: PerformanceMode

    The performance mode that the file system will operate under. An Amazon EFS file system's performance mode can't be changed after the file system has been created. Updating this property will replace the file system.

    PerformanceMode.GENERAL_PURPOSE
    provisionedThroughputPerSecond?: Size

    Provisioned throughput for the file system. This is a required property if the throughput mode is set to PROVISIONED. Must be at least 1MiB/s.

    - none, errors out
    provisionNewOnDeployment?: boolean
    removalPolicy?: RemovalPolicy

    The removal policy to apply to the file system.

    RemovalPolicy.RETAIN
    replicationConfiguration?: ReplicationConfiguration

    Replication configuration for the file system.

    - no replication
    replicationOverwriteProtection?: ReplicationOverwriteProtection

    Whether to enable the filesystem's replication overwrite protection or not. Set false if you want to create a read-only filesystem for use as a replication destination.

    https://docs.aws.amazon.com/efs/latest/ug/replication-use-cases.html#replicate-existing-destination

    ReplicationOverwriteProtection.ENABLED
    rootDirectory?: string
    securityGroup?: ISecurityGroup

    Security Group to assign to this file system.

    - creates new security group which allows all outbound traffic
    throughputMode?: ThroughputMode

    Enum to mention the throughput mode of the file system.

    ThroughputMode.BURSTING
    transitEncryption?: string
    transitEncryptionPort?: number
    transitionToArchivePolicy?: LifecyclePolicy

    The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

    - None. EFS will not transition files to Archive storage class.
    vpc: IVpc

    VPC to launch the file system in.

    vpcSubnets?: SubnetSelection

    Which subnets to place the mount target in the VPC.

    - the Vpc default strategy if not specified

    Settings

    Member Visibility

    On This Page

    Properties