Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. efs
  5. getFileSystem

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.efs.getFileSystem

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    Using getFileSystem

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFileSystem(args: GetFileSystemArgs, opts?: InvokeOptions): Promise<GetFileSystemResult>
function getFileSystemOutput(args: GetFileSystemOutputArgs, opts?: InvokeOptions): Output<GetFileSystemResult>
    def get_file_system(file_system_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetFileSystemResult
def get_file_system_output(file_system_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetFileSystemResult]
    func LookupFileSystem(ctx *Context, args *LookupFileSystemArgs, opts ...InvokeOption) (*LookupFileSystemResult, error)
func LookupFileSystemOutput(ctx *Context, args *LookupFileSystemOutputArgs, opts ...InvokeOption) LookupFileSystemResultOutput

    > Note: This function is named LookupFileSystem in the Go SDK.

    public static class GetFileSystem 
{
    public static Task<GetFileSystemResult> InvokeAsync(GetFileSystemArgs args, InvokeOptions? opts = null)
    public static Output<GetFileSystemResult> Invoke(GetFileSystemInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFileSystemResult> getFileSystem(GetFileSystemArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:efs:getFileSystem
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    FileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    fileSystemId String
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    fileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    file_system_id str
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    fileSystemId String
    The ID of the EFS file system. For example: fs-abcdef0123456789a

    getFileSystem Result

    The following output properties are available:

    Arn string

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

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

    BackupPolicy Pulumi.AwsNative.Efs.Outputs.FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    FileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    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.Outputs.FileSystemProtection
    Describes the protection on the file system.
    FileSystemTags List<Pulumi.AwsNative.Outputs.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.
    LifecyclePolicies List<Pulumi.AwsNative.Efs.Outputs.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.

    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.Outputs.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.
    Arn string

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

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

    BackupPolicy FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    FileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    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 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.
    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.

    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 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.
    arn String

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

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

    backupPolicy FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    fileSystemId String
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    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.
    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.

    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.
    arn string

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

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

    backupPolicy FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    fileSystemId string
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    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.
    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.

    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.
    arn str

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

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

    backup_policy FileSystemBackupPolicy
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    file_system_id str
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    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 FileSystemProtection
    Describes the protection on the file system.
    file_system_tags Sequence[root_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.
    lifecycle_policies Sequence[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.

    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 FileSystemReplicationConfiguration
    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.
    arn String

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

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

    backupPolicy Property Map
    Use the BackupPolicy to turn automatic backups on or off for the file system.
    fileSystemId String
    The ID of the EFS file system. For example: fs-abcdef0123456789a
    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.
    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.

    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.

    Supporting Types

    FileSystemBackupPolicy

    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

    FileSystemLifecyclePolicy

    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

    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

    FileSystemReplicationConfiguration

    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

    AvailabilityZoneName string
    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
    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
    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
    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
    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
    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

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native