GetFileSystem

Provides information about an Elastic File System (EFS) File System.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var fileSystemId = config.Get("fileSystemId") ?? "";
        var byId = Output.Create(Aws.Efs.GetFileSystem.InvokeAsync(new Aws.Efs.GetFileSystemArgs
        {
            FileSystemId = fileSystemId,
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/efs"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        opt0 := fileSystemId
        _, err := efs.LookupFileSystem(ctx, &efs.LookupFileSystemArgs{
            FileSystemId: &opt0,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

config = pulumi.Config()
file_system_id = config.get("fileSystemId")
if file_system_id is None:
    file_system_id = ""
by_id = aws.efs.get_file_system(file_system_id=file_system_id)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const fileSystemId = config.get("fileSystemId") || "";

const byId = pulumi.output(aws.efs.getFileSystem({
    fileSystemId: fileSystemId,
}, { async: true }));

Using GetFileSystem

function getFileSystem(args: GetFileSystemArgs, opts?: InvokeOptions): Promise<GetFileSystemResult>

function  get_file_system(creation_token=None, file_system_id=None, tags=None, opts=None)

func LookupFileSystem(ctx *Context, args *LookupFileSystemArgs, opts ...InvokeOption) (*LookupFileSystemResult, error)

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

public static class GetFileSystem {
    public static Task<GetFileSystemResult> InvokeAsync(GetFileSystemArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

CreationToken string: Restricts the list to the file system with this creation token.
FileSystemId string: The ID that identifies the file system (e.g. fs-ccfc0d65).
Tags Dictionary<string, string>

CreationToken string: Restricts the list to the file system with this creation token.
FileSystemId string: The ID that identifies the file system (e.g. fs-ccfc0d65).
Tags map[string]string

creationToken string: Restricts the list to the file system with this creation token.
fileSystemId string: The ID that identifies the file system (e.g. fs-ccfc0d65).
tags {[key: string]: string}

creation_token str: Restricts the list to the file system with this creation token.
file_system_id str: The ID that identifies the file system (e.g. fs-ccfc0d65).
tags Dict[str, str]

GetFileSystem Result

The following output properties are available:

Arn string: Amazon Resource Name of the file system.
CreationToken string
DnsName string: The DNS name for the filesystem per documented convention.
Encrypted bool: Whether EFS is encrypted.
FileSystemId string
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyId string: The ARN for the KMS encryption key.
LifecyclePolicy GetFileSystemLifecyclePolicy: A file system lifecycle policy object.
PerformanceMode string: The file system performance mode.
ProvisionedThroughputInMibps double: The throughput, measured in MiB/s, that you want to provision for the file system. * tags -A map of tags to assign to the file system.
SizeInBytes int: The current byte count used by the file system.
Tags Dictionary<string, string>
ThroughputMode string: Throughput mode for the file system.

Arn string: Amazon Resource Name of the file system.
CreationToken string
DnsName string: The DNS name for the filesystem per documented convention.
Encrypted bool: Whether EFS is encrypted.
FileSystemId string
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyId string: The ARN for the KMS encryption key.
LifecyclePolicy GetFileSystemLifecyclePolicy: A file system lifecycle policy object.
PerformanceMode string: The file system performance mode.
ProvisionedThroughputInMibps float64: The throughput, measured in MiB/s, that you want to provision for the file system. * tags -A map of tags to assign to the file system.
SizeInBytes int: The current byte count used by the file system.
Tags map[string]string
ThroughputMode string: Throughput mode for the file system.

arn string: Amazon Resource Name of the file system.
creationToken string
dnsName string: The DNS name for the filesystem per documented convention.
encrypted boolean: Whether EFS is encrypted.
fileSystemId string
id string: The provider-assigned unique ID for this managed resource.
kmsKeyId string: The ARN for the KMS encryption key.
lifecyclePolicy GetFileSystemLifecyclePolicy: A file system lifecycle policy object.
performanceMode string: The file system performance mode.
provisionedThroughputInMibps number: The throughput, measured in MiB/s, that you want to provision for the file system. * tags -A map of tags to assign to the file system.
sizeInBytes number: The current byte count used by the file system.
tags {[key: string]: string}
throughputMode string: Throughput mode for the file system.

arn str: Amazon Resource Name of the file system.
creation_token str
dns_name str: The DNS name for the filesystem per documented convention.
encrypted bool: Whether EFS is encrypted.
file_system_id str
id str: The provider-assigned unique ID for this managed resource.
kms_key_id str: The ARN for the KMS encryption key.
lifecycle_policy Dict[GetFileSystemLifecyclePolicy]: A file system lifecycle policy object.
performance_mode str: The file system performance mode.
provisioned_throughput_in_mibps float: The throughput, measured in MiB/s, that you want to provision for the file system. * tags -A map of tags to assign to the file system.
size_in_bytes float: The current byte count used by the file system.
tags Dict[str, str]
throughput_mode str: Throughput mode for the file system.

Supporting Types

GetFileSystemLifecyclePolicy

See the output API doc for this type.

TransitionToIa string

TransitionToIa string

transitionToIa string

transitionToIa str

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetFileSystem

Example Usage

Using GetFileSystem

GetFileSystem Result

Supporting Types

GetFileSystemLifecyclePolicy

Package Details

On This Page