interface CfnFileSystemProps

Language	Type name
.NET	`Amazon.CDK.AWS.EFS.CfnFileSystemProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsefs#CfnFileSystemProps`
Java	`software.amazon.awscdk.services.efs.CfnFileSystemProps`
Python	`aws_cdk.aws_efs.CfnFileSystemProps`
TypeScript	`aws-cdk-lib` » `aws_efs` » `CfnFileSystemProps`

Properties for defining a CfnFileSystem.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_efs as efs } from 'aws-cdk-lib';

declare const fileSystemPolicy: any;
const cfnFileSystemProps: efs.CfnFileSystemProps = {
  availabilityZoneName: 'availabilityZoneName',
  backupPolicy: {
    status: 'status',
  },
  bypassPolicyLockoutSafetyCheck: false,
  encrypted: false,
  fileSystemPolicy: fileSystemPolicy,
  fileSystemProtection: {
    replicationOverwriteProtection: 'replicationOverwriteProtection',
  },
  fileSystemTags: [{
    key: 'key',
    value: 'value',
  }],
  kmsKeyId: 'kmsKeyId',
  lifecyclePolicies: [{
    transitionToArchive: 'transitionToArchive',
    transitionToIa: 'transitionToIa',
    transitionToPrimaryStorageClass: 'transitionToPrimaryStorageClass',
  }],
  performanceMode: 'performanceMode',
  provisionedThroughputInMibps: 123,
  replicationConfiguration: {
    destinations: [{
      availabilityZoneName: 'availabilityZoneName',
      fileSystemId: 'fileSystemId',
      kmsKeyId: 'kmsKeyId',
      region: 'region',
      roleArn: 'roleArn',
      status: 'status',
      statusMessage: 'statusMessage',
    }],
  },
  throughputMode: 'throughputMode',
};

Properties

Name	Type	Description
availabilityZoneName?	`string`	For One Zone file systems, specify the AWS Availability Zone in which to create the file system.
backupPolicy?	`IResolvable` `\|` `BackupPolicyProperty`	Use the `BackupPolicy` to turn automatic backups on or off for the file system.
bypassPolicyLockoutSafetyCheck?	`boolean \|` `IResolvable`	(Optional) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check.
encrypted?	`boolean \|` `IResolvable`	A Boolean value that, if true, creates an encrypted file system.
fileSystemPolicy?	`any`	The `FileSystemPolicy` for the EFS file system.
fileSystemProtection?	`IResolvable` `\|` `FileSystemProtectionProperty`	Describes the protection on the file system.
fileSystemTags?	`ElasticFileSystemTagProperty[]`	Use to create one or more tags associated with the file system.
kmsKeyId?	`string`	The ID of the AWS KMS key to be used to protect the encrypted file system.
lifecyclePolicies?	`IResolvable` `\|` `IResolvable` `\|` `LifecyclePolicyProperty[]`	An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object.
performanceMode?	`string`	The performance mode of the file system.
provisionedThroughputInMibps?	`number`	The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.
replicationConfiguration?	`IResolvable` `\|` `ReplicationConfigurationProperty`	Describes the replication configuration for a specific file system.
throughputMode?	`string`	Specifies the throughput mode for the file system.

availabilityZoneName?

Type: string (optional)

For One Zone file systems, specify the AWS Availability Zone in which to create the file system.

Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see EFS file system types in the Amazon EFS User Guide .

One Zone file systems are not available in all Availability Zones in AWS Regions where Amazon EFS is available.

backupPolicy?

Type: IResolvable | BackupPolicyProperty (optional)

Use the BackupPolicy to turn automatic backups on or off for the file system.

bypassPolicyLockoutSafetyCheck?

Type: boolean | IResolvable (optional)

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

encrypted?

Type: boolean | IResolvable (optional)

A Boolean value that, if true, creates an encrypted file system.

When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted file system.

fileSystemPolicy?

Type: any (optional)

The FileSystemPolicy for the EFS file system.

A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using IAM to control NFS access to Amazon EFS in the Amazon EFS User Guide .

fileSystemProtection?

Type: IResolvable | FileSystemProtectionProperty (optional)

Describes the protection on the file system.

fileSystemTags?

Type: ElasticFileSystemTagProperty[] (optional)

Use to create one or more tags associated with the file system.

Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see Tagging AWS resources in the AWS General Reference Guide .

kmsKeyId?

Type: string (optional)

The ID of the AWS KMS key to be used to protect the encrypted file system.

This parameter is only required if you want to use a nondefault KMS key . If this parameter is not specified, the default KMS key for Amazon EFS is used. This ID can be in one of the following formats:

Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
Key alias - A previously created display name for a key, for example alias/projectKey1 .
Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .

If KmsKeyId is specified, the Encrypted parameter must be set to true.

lifecyclePolicies?

Type: IResolvable | IResolvable | LifecyclePolicyProperty[] (optional)

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

A LifecycleConfiguration object informs Lifecycle management of the following:

When to move files in the file system from primary storage to IA storage.
When to move files in the file system from primary storage or IA storage to Archive storage.
When to move files that are in IA or Archive storage to primary storage.

Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToArchive TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

performanceMode?

Type: string (optional)

The performance mode of the file system.

We recommend generalPurpose performance mode for all file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The maxIO mode is not supported on One Zone file systems.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

Default is generalPurpose .

provisionedThroughputInMibps?

Type: number (optional)

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.

Required if ThroughputMode is set to provisioned . Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact AWS Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .

replicationConfiguration?

Type: IResolvable | ReplicationConfigurationProperty (optional)

Describes the replication configuration for a specific file system.

throughputMode?

Type: string (optional)

Specifies the throughput mode for the file system.

The mode can be bursting , provisioned , or elastic . If you set ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps . After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

Default is bursting .