@pulumi/aws/efs/getFileSystem.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Provides information about an Elastic File System (EFS) File System.
 *
 * ## Example Usage
 *
 * ```typescript
 * 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",
 *     },
 * });
 * ```
 */
export declare function getFileSystem(args?: GetFileSystemArgs, opts?: pulumi.InvokeOptions): Promise<GetFileSystemResult>;
/**
 * A collection of arguments for invoking getFileSystem.
 */
export interface GetFileSystemArgs {
    /**
     * Restricts the list to the file system with this creation token.
     */
    creationToken?: string;
    /**
     * ID that identifies the file system (e.g., fs-ccfc0d65).
     */
    fileSystemId?: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Restricts the list to the file system with these tags.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getFileSystem.
 */
export interface GetFileSystemResult {
    /**
     * Amazon Resource Name of the file system.
     */
    readonly arn: string;
    /**
     * The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
     */
    readonly availabilityZoneId: string;
    /**
     * The Availability Zone name in which the file system's One Zone storage classes exist.
     */
    readonly availabilityZoneName: string;
    readonly creationToken: string;
    /**
     * DNS name for the filesystem per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).
     */
    readonly dnsName: string;
    /**
     * Whether EFS is encrypted.
     */
    readonly encrypted: boolean;
    readonly fileSystemId: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * ARN for the KMS encryption key.
     */
    readonly kmsKeyId: string;
    /**
     * File system [lifecycle policy](https://docs.aws.amazon.com/efs/latest/ug/API_LifecyclePolicy.html) object.
     */
    readonly lifecyclePolicies: outputs.efs.GetFileSystemLifecyclePolicy[];
    /**
     * The value of the file system's `Name` tag.
     */
    readonly name: string;
    /**
     * File system performance mode.
     */
    readonly performanceMode: string;
    readonly protections: outputs.efs.GetFileSystemProtection[];
    /**
     * The throughput, measured in MiB/s, that you want to provision for the file system.
     */
    readonly provisionedThroughputInMibps: number;
    readonly region: string;
    /**
     * Current byte count used by the file system.
     */
    readonly sizeInBytes: number;
    /**
     * A map of tags to assign to the file system.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * Throughput mode for the file system.
     */
    readonly throughputMode: string;
}
/**
 * Provides information about an Elastic File System (EFS) File System.
 *
 * ## Example Usage
 *
 * ```typescript
 * 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",
 *     },
 * });
 * ```
 */
export declare function getFileSystemOutput(args?: GetFileSystemOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFileSystemResult>;
/**
 * A collection of arguments for invoking getFileSystem.
 */
export interface GetFileSystemOutputArgs {
    /**
     * Restricts the list to the file system with this creation token.
     */
    creationToken?: pulumi.Input<string>;
    /**
     * ID that identifies the file system (e.g., fs-ccfc0d65).
     */
    fileSystemId?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Restricts the list to the file system with these tags.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}