AWS Classic

v5.21.1 published on Thursday, Nov 17, 2022 by Pulumi

getFileSystem

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var fileSystemId = config.Get("fileSystemId") ?? "";
    var byId = Aws.Efs.GetFileSystem.Invoke(new()
    {
        FileSystemId = fileSystemId,
    });

    var byTag = Aws.Efs.GetFileSystem.Invoke(new()
    {
        Tags = 
        {
            { "Environment", "dev" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/efs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		fileSystemId := ""
		if param := cfg.Get("fileSystemId"); param != "" {
			fileSystemId = param
		}
		_, err := efs.LookupFileSystem(ctx, &efs.LookupFileSystemArgs{
			FileSystemId: pulumi.StringRef(fileSystemId),
		}, nil)
		if err != nil {
			return err
		}
		_, err = efs.LookupFileSystem(ctx, &efs.LookupFileSystemArgs{
			Tags: map[string]interface{}{
				"Environment": "dev",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.efs.EfsFunctions;
import com.pulumi.aws.efs.inputs.GetFileSystemArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var fileSystemId = config.get("fileSystemId").orElse("");
        final var byId = EfsFunctions.getFileSystem(GetFileSystemArgs.builder()
            .fileSystemId(fileSystemId)
            .build());

        final var byTag = EfsFunctions.getFileSystem(GetFileSystemArgs.builder()
            .tags(Map.of("Environment", "dev"))
            .build());

    }
}
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)
by_tag = aws.efs.get_file_system(tags={
    "Environment": "dev",
})
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const fileSystemId = config.get("fileSystemId") || "";
const byId = aws.efs.getFileSystem({
    fileSystemId: fileSystemId,
});
const byTag = aws.efs.getFileSystem({
    tags: {
        Environment: "dev",
    },
});
configuration:
  fileSystemId:
    type: string
    default:
variables:
  byId:
    Fn::Invoke:
      Function: aws:efs:getFileSystem
      Arguments:
        fileSystemId: ${fileSystemId}
  byTag:
    Fn::Invoke:
      Function: aws:efs:getFileSystem
      Arguments:
        tags:
          Environment: dev

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(creation_token: Optional[str] = None,
                    file_system_id: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetFileSystemResult
def get_file_system_output(creation_token: Optional[pulumi.Input[str]] = None,
                    file_system_id: Optional[pulumi.Input[str]] = None,
                    tags: Optional[pulumi.Input[Mapping[str, 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:efs/getFileSystem:getFileSystem
  arguments:
    # arguments dictionary

The following arguments are supported:

CreationToken string

Restricts the list to the file system with this creation token.

FileSystemId string

ID that identifies the file system (e.g., fs-ccfc0d65).

Tags Dictionary<string, string>

Restricts the list to the file system with these tags.

CreationToken string

Restricts the list to the file system with this creation token.

FileSystemId string

ID that identifies the file system (e.g., fs-ccfc0d65).

Tags map[string]string

Restricts the list to the file system with these tags.

creationToken String

Restricts the list to the file system with this creation token.

fileSystemId String

ID that identifies the file system (e.g., fs-ccfc0d65).

tags Map<String,String>

Restricts the list to the file system with these tags.

creationToken string

Restricts the list to the file system with this creation token.

fileSystemId string

ID that identifies the file system (e.g., fs-ccfc0d65).

tags {[key: string]: string}

Restricts the list to the file system with these tags.

creation_token str

Restricts the list to the file system with this creation token.

file_system_id str

ID that identifies the file system (e.g., fs-ccfc0d65).

tags Mapping[str, str]

Restricts the list to the file system with these tags.

creationToken String

Restricts the list to the file system with this creation token.

fileSystemId String

ID that identifies the file system (e.g., fs-ccfc0d65).

tags Map<String>

Restricts the list to the file system with these tags.

getFileSystem Result

The following output properties are available:

Arn string

Amazon Resource Name of the file system.

AvailabilityZoneId string

The identifier of the Availability Zone in which the file system's One Zone storage classes exist.

AvailabilityZoneName string

The Availability Zone name in which the file system's One Zone storage classes exist.

CreationToken string
DnsName string

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

ARN for the KMS encryption key.

LifecyclePolicy Pulumi.Aws.Efs.Outputs.GetFileSystemLifecyclePolicy

File system lifecycle policy object.

PerformanceMode string

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

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.

AvailabilityZoneId string

The identifier of the Availability Zone in which the file system's One Zone storage classes exist.

AvailabilityZoneName string

The Availability Zone name in which the file system's One Zone storage classes exist.

CreationToken string
DnsName string

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

ARN for the KMS encryption key.

LifecyclePolicy GetFileSystemLifecyclePolicy

File system lifecycle policy object.

PerformanceMode string

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

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.

availabilityZoneId String

The identifier of the Availability Zone in which the file system's One Zone storage classes exist.

availabilityZoneName String

The Availability Zone name in which the file system's One Zone storage classes exist.

creationToken String
dnsName String

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

ARN for the KMS encryption key.

lifecyclePolicy GetFileSystemLifecyclePolicy

File system lifecycle policy object.

performanceMode String

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 Integer

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.

availabilityZoneId string

The identifier of the Availability Zone in which the file system's One Zone storage classes exist.

availabilityZoneName string

The Availability Zone name in which the file system's One Zone storage classes exist.

creationToken string
dnsName string

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

ARN for the KMS encryption key.

lifecyclePolicy GetFileSystemLifecyclePolicy

File system lifecycle policy object.

performanceMode string

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

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.

availability_zone_id str

The identifier of the Availability Zone in which the file system's One Zone storage classes exist.

availability_zone_name str

The Availability Zone name in which the file system's One Zone storage classes exist.

creation_token str
dns_name str

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

ARN for the KMS encryption key.

lifecycle_policy GetFileSystemLifecyclePolicy

File system lifecycle policy object.

performance_mode str

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 int

Current byte count used by the file system.

tags Mapping[str, str]
throughput_mode str

Throughput mode for the file system.

arn String

Amazon Resource Name of the file system.

availabilityZoneId String

The identifier of the Availability Zone in which the file system's One Zone storage classes exist.

availabilityZoneName String

The Availability Zone name in which the file system's One Zone storage classes exist.

creationToken String
dnsName String

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

ARN for the KMS encryption key.

lifecyclePolicy Property Map

File system lifecycle policy object.

performanceMode String

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

Current byte count used by the file system.

tags Map<String>
throughputMode String

Throughput mode for the file system.

Supporting Types

GetFileSystemLifecyclePolicy

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.