1. Packages
  2. AWS Native
  3. API Docs
  4. efs
  5. FileSystem

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws-native.efs.FileSystem

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi

    The AWS::EFS::FileSystem resource creates a new, empty file system in EFSlong (EFS). You must create a mount target (AWS::EFS::MountTarget) to mount your EFS file system on an EC2 or other AWS cloud compute resource.

    Create FileSystem Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FileSystem(name: string, args?: FileSystemArgs, opts?: CustomResourceOptions);
    @overload
    def FileSystem(resource_name: str,
                   args: Optional[FileSystemArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def FileSystem(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   availability_zone_name: Optional[str] = None,
                   backup_policy: Optional[FileSystemBackupPolicyArgs] = None,
                   bypass_policy_lockout_safety_check: Optional[bool] = None,
                   encrypted: Optional[bool] = None,
                   file_system_policy: Optional[Any] = None,
                   file_system_protection: Optional[FileSystemProtectionArgs] = None,
                   file_system_tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                   kms_key_id: Optional[str] = None,
                   lifecycle_policies: Optional[Sequence[FileSystemLifecyclePolicyArgs]] = None,
                   performance_mode: Optional[str] = None,
                   provisioned_throughput_in_mibps: Optional[float] = None,
                   replication_configuration: Optional[FileSystemReplicationConfigurationArgs] = None,
                   throughput_mode: Optional[str] = None)
    func NewFileSystem(ctx *Context, name string, args *FileSystemArgs, opts ...ResourceOption) (*FileSystem, error)
    public FileSystem(string name, FileSystemArgs? args = null, CustomResourceOptions? opts = null)
    public FileSystem(String name, FileSystemArgs args)
    public FileSystem(String name, FileSystemArgs args, CustomResourceOptions options)
    
    type: aws-native:efs:FileSystem
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileSystemArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    FileSystem Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FileSystem resource accepts the following input properties:

    AvailabilityZoneName string
    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 Pulumi.AwsNative.Efs.Inputs.FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    BypassPolicyLockoutSafetyCheck bool
    (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 bool
    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 kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
    FileSystemPolicy object

    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 to control NFS access to Amazon EFS in the Amazon EFS User Guide.

    Search the CloudFormation User Guide for AWS::EFS::FileSystem for more information about the expected schema for this property.

    FileSystemProtection Pulumi.AwsNative.Efs.Inputs.FileSystemProtection
    Describes the protection on the file system.
    FileSystemTags List<Pulumi.AwsNative.Inputs.Tag>
    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 resources in the General Reference Guide.
    KmsKeyId string

    The ID of the kms-key-long 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 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 List<Pulumi.AwsNative.Efs.Inputs.FileSystemLifecyclePolicy>

    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.

    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 string
    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 double
    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 SUP. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
    ReplicationConfiguration Pulumi.AwsNative.Efs.Inputs.FileSystemReplicationConfiguration
    Describes the replication configuration for a specific file system.
    ThroughputMode string
    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.
    AvailabilityZoneName string
    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 FileSystemBackupPolicyArgs
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    BypassPolicyLockoutSafetyCheck bool
    (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 bool
    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 kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
    FileSystemPolicy interface{}

    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 to control NFS access to Amazon EFS in the Amazon EFS User Guide.

    Search the CloudFormation User Guide for AWS::EFS::FileSystem for more information about the expected schema for this property.

    FileSystemProtection FileSystemProtectionArgs
    Describes the protection on the file system.
    FileSystemTags TagArgs
    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 resources in the General Reference Guide.
    KmsKeyId string

    The ID of the kms-key-long 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 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 []FileSystemLifecyclePolicyArgs

    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.

    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 string
    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 float64
    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 SUP. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
    ReplicationConfiguration FileSystemReplicationConfigurationArgs
    Describes the replication configuration for a specific file system.
    ThroughputMode string
    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.
    availabilityZoneName String
    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 FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    bypassPolicyLockoutSafetyCheck Boolean
    (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 Boolean
    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 kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
    fileSystemPolicy Object

    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 to control NFS access to Amazon EFS in the Amazon EFS User Guide.

    Search the CloudFormation User Guide for AWS::EFS::FileSystem for more information about the expected schema for this property.

    fileSystemProtection FileSystemProtection
    Describes the protection on the file system.
    fileSystemTags List<Tag>
    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 resources in the General Reference Guide.
    kmsKeyId String

    The ID of the kms-key-long 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 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 List<FileSystemLifecyclePolicy>

    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.

    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 String
    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 Double
    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 SUP. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
    replicationConfiguration FileSystemReplicationConfiguration
    Describes the replication configuration for a specific file system.
    throughputMode String
    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.
    availabilityZoneName string
    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 FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    bypassPolicyLockoutSafetyCheck boolean
    (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 boolean
    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 kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
    fileSystemPolicy any

    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 to control NFS access to Amazon EFS in the Amazon EFS User Guide.

    Search the CloudFormation User Guide for AWS::EFS::FileSystem for more information about the expected schema for this property.

    fileSystemProtection FileSystemProtection
    Describes the protection on the file system.
    fileSystemTags Tag[]
    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 resources in the General Reference Guide.
    kmsKeyId string

    The ID of the kms-key-long 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 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 FileSystemLifecyclePolicy[]

    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.

    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 string
    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 number
    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 SUP. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
    replicationConfiguration FileSystemReplicationConfiguration
    Describes the replication configuration for a specific file system.
    throughputMode string
    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.
    availability_zone_name str
    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.
    backup_policy FileSystemBackupPolicyArgs
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    bypass_policy_lockout_safety_check bool
    (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 bool
    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 kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
    file_system_policy Any

    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 to control NFS access to Amazon EFS in the Amazon EFS User Guide.

    Search the CloudFormation User Guide for AWS::EFS::FileSystem for more information about the expected schema for this property.

    file_system_protection FileSystemProtectionArgs
    Describes the protection on the file system.
    file_system_tags Sequence[TagArgs]
    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 resources in the General Reference Guide.
    kms_key_id str

    The ID of the kms-key-long 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 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.

    lifecycle_policies Sequence[FileSystemLifecyclePolicyArgs]

    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.

    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.

    performance_mode str
    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.
    provisioned_throughput_in_mibps float
    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 SUP. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
    replication_configuration FileSystemReplicationConfigurationArgs
    Describes the replication configuration for a specific file system.
    throughput_mode str
    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.
    availabilityZoneName String
    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 Property Map
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    bypassPolicyLockoutSafetyCheck Boolean
    (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 Boolean
    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 kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
    fileSystemPolicy Any

    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 to control NFS access to Amazon EFS in the Amazon EFS User Guide.

    Search the CloudFormation User Guide for AWS::EFS::FileSystem for more information about the expected schema for this property.

    fileSystemProtection Property Map
    Describes the protection on the file system.
    fileSystemTags List<Property Map>
    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 resources in the General Reference Guide.
    kmsKeyId String

    The ID of the kms-key-long 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 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 List<Property Map>

    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.

    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 String
    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 Number
    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 SUP. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.
    replicationConfiguration Property Map
    Describes the replication configuration for a specific file system.
    throughputMode String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FileSystem resource produces the following output properties:

    Arn string

    The Amazon Resource Name (ARN) of the EFS file system.

    Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

    FileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string

    The Amazon Resource Name (ARN) of the EFS file system.

    Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

    FileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String

    The Amazon Resource Name (ARN) of the EFS file system.

    Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

    fileSystemId String
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    id String
    The provider-assigned unique ID for this managed resource.
    arn string

    The Amazon Resource Name (ARN) of the EFS file system.

    Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

    fileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    id string
    The provider-assigned unique ID for this managed resource.
    arn str

    The Amazon Resource Name (ARN) of the EFS file system.

    Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

    file_system_id str
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    id str
    The provider-assigned unique ID for this managed resource.
    arn String

    The Amazon Resource Name (ARN) of the EFS file system.

    Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

    fileSystemId String
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    FileSystemBackupPolicy, FileSystemBackupPolicyArgs

    Status Pulumi.AwsNative.Efs.FileSystemBackupPolicyStatus
    Set the backup policy status for the file system.

    • ENABLED - Turns automatic backups on for the file system.
    • DISABLED - Turns automatic backups off for the file system.
    Status FileSystemBackupPolicyStatus
    Set the backup policy status for the file system.

    • ENABLED - Turns automatic backups on for the file system.
    • DISABLED - Turns automatic backups off for the file system.
    status FileSystemBackupPolicyStatus
    Set the backup policy status for the file system.

    • ENABLED - Turns automatic backups on for the file system.
    • DISABLED - Turns automatic backups off for the file system.
    status FileSystemBackupPolicyStatus
    Set the backup policy status for the file system.

    • ENABLED - Turns automatic backups on for the file system.
    • DISABLED - Turns automatic backups off for the file system.
    status FileSystemBackupPolicyStatus
    Set the backup policy status for the file system.

    • ENABLED - Turns automatic backups on for the file system.
    • DISABLED - Turns automatic backups off for the file system.
    status "DISABLED" | "ENABLED"
    Set the backup policy status for the file system.

    • ENABLED - Turns automatic backups on for the file system.
    • DISABLED - Turns automatic backups off for the file system.

    FileSystemBackupPolicyStatus, FileSystemBackupPolicyStatusArgs

    Disabled
    DISABLED
    Enabled
    ENABLED
    FileSystemBackupPolicyStatusDisabled
    DISABLED
    FileSystemBackupPolicyStatusEnabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    DISABLED
    DISABLED
    ENABLED
    ENABLED
    "DISABLED"
    DISABLED
    "ENABLED"
    ENABLED

    FileSystemLifecyclePolicy, FileSystemLifecyclePolicyArgs

    TransitionToArchive string
    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.
    TransitionToIa string
    The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    TransitionToPrimaryStorageClass string
    Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    TransitionToArchive string
    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.
    TransitionToIa string
    The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    TransitionToPrimaryStorageClass string
    Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transitionToArchive String
    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.
    transitionToIa String
    The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transitionToPrimaryStorageClass String
    Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transitionToArchive string
    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.
    transitionToIa string
    The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transitionToPrimaryStorageClass string
    Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transition_to_archive str
    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.
    transition_to_ia str
    The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transition_to_primary_storage_class str
    Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transitionToArchive String
    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.
    transitionToIa String
    The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
    transitionToPrimaryStorageClass String
    Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

    FileSystemProtection, FileSystemProtectionArgs

    ReplicationOverwriteProtection Pulumi.AwsNative.Efs.FileSystemProtectionReplicationOverwriteProtection

    The status of the file system's replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.
    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

    ReplicationOverwriteProtection FileSystemProtectionReplicationOverwriteProtection

    The status of the file system's replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.
    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

    replicationOverwriteProtection FileSystemProtectionReplicationOverwriteProtection

    The status of the file system's replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.
    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

    replicationOverwriteProtection FileSystemProtectionReplicationOverwriteProtection

    The status of the file system's replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.
    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

    replication_overwrite_protection FileSystemProtectionReplicationOverwriteProtection

    The status of the file system's replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.
    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

    replicationOverwriteProtection "DISABLED" | "ENABLED"

    The status of the file system's replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.
    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

    FileSystemProtectionReplicationOverwriteProtection, FileSystemProtectionReplicationOverwriteProtectionArgs

    Disabled
    DISABLED
    Enabled
    ENABLED
    FileSystemProtectionReplicationOverwriteProtectionDisabled
    DISABLED
    FileSystemProtectionReplicationOverwriteProtectionEnabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    DISABLED
    DISABLED
    ENABLED
    ENABLED
    "DISABLED"
    DISABLED
    "ENABLED"
    ENABLED

    FileSystemReplicationConfiguration, FileSystemReplicationConfigurationArgs

    Destinations List<Pulumi.AwsNative.Efs.Inputs.FileSystemReplicationDestination>
    An array of destination objects. Only one destination object is supported.
    Destinations []FileSystemReplicationDestination
    An array of destination objects. Only one destination object is supported.
    destinations List<FileSystemReplicationDestination>
    An array of destination objects. Only one destination object is supported.
    destinations FileSystemReplicationDestination[]
    An array of destination objects. Only one destination object is supported.
    destinations Sequence[FileSystemReplicationDestination]
    An array of destination objects. Only one destination object is supported.
    destinations List<Property Map>
    An array of destination objects. Only one destination object is supported.

    FileSystemReplicationDestination, FileSystemReplicationDestinationArgs

    AvailabilityZoneName string
    The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. 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 system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
    FileSystemId string
    The ID of the destination Amazon EFS file system.
    KmsKeyId string
    The ID of an kms-key-long used to protect the encrypted file system.
    Region string
    The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.
    AvailabilityZoneName string
    The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. 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 system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
    FileSystemId string
    The ID of the destination Amazon EFS file system.
    KmsKeyId string
    The ID of an kms-key-long used to protect the encrypted file system.
    Region string
    The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.
    availabilityZoneName String
    The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. 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 system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
    fileSystemId String
    The ID of the destination Amazon EFS file system.
    kmsKeyId String
    The ID of an kms-key-long used to protect the encrypted file system.
    region String
    The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.
    availabilityZoneName string
    The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. 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 system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
    fileSystemId string
    The ID of the destination Amazon EFS file system.
    kmsKeyId string
    The ID of an kms-key-long used to protect the encrypted file system.
    region string
    The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.
    availability_zone_name str
    The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. 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 system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
    file_system_id str
    The ID of the destination Amazon EFS file system.
    kms_key_id str
    The ID of an kms-key-long used to protect the encrypted file system.
    region str
    The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.
    availabilityZoneName String
    The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. 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 system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
    fileSystemId String
    The ID of the destination Amazon EFS file system.
    kmsKeyId String
    The ID of an kms-key-long used to protect the encrypted file system.
    region String
    The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi