pulumi-aws-kotlin/com.pulumi.aws.efs.kotlin/FileSystem

FileSystem

class FileSystem : KotlinCustomResource

Provides an Elastic File System (EFS) File System resource.

Example Usage

EFS File System w/ tags

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.efs.FileSystem;
import com.pulumi.aws.efs.FileSystemArgs;
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) {
        var foo = new FileSystem("foo", FileSystemArgs.builder()
            .tags(Map.of("Name", "MyProduct"))
            .build());
    }
}

Using lifecycle policy

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.efs.FileSystem;
import com.pulumi.aws.efs.FileSystemArgs;
import com.pulumi.aws.efs.inputs.FileSystemLifecyclePolicyArgs;
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) {
        var fooWithLifecylePolicy = new FileSystem("fooWithLifecylePolicy", FileSystemArgs.builder()
            .lifecyclePolicies(FileSystemLifecyclePolicyArgs.builder()
                .transitionToIa("AFTER_30_DAYS")
                .build())
            .build());
    }
}

Import

The EFS file systems can be imported using the id, e.g.,

$ pulumi import aws:efs/fileSystem:FileSystem foo fs-6fa144c6

Properties

arn

val arn: Output<String>

Amazon Resource Name of the file system.

availabilityZoneId

val availabilityZoneId: Output<String>

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

availabilityZoneName

val availabilityZoneName: Output<String>

the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.

creationToken

val creationToken: Output<String>

A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See Elastic File System user guide for more information.

dnsName

val dnsName: Output<String>

The DNS name for the filesystem per documented convention.

encrypted

val encrypted: Output<Boolean>

If true, the disk will be encrypted.

val id: Output<String>

kmsKeyId

val kmsKeyId: Output<String>

The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

lifecyclePolicies

val lifecyclePolicies: Output<List<FileSystemLifecyclePolicy>>?

A file system lifecycle policy object (documented below).

numberOfMountTargets

val numberOfMountTargets: Output<Int>

The current number of mount targets that the file system has.

ownerId

val ownerId: Output<String>

The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.

performanceMode

val performanceMode: Output<String>

The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose").

provisionedThroughputInMibps

val provisionedThroughputInMibps: Output<Double>?

The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughput_mode set to provisioned.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

sizeInBytes

val sizeInBytes: Output<List<FileSystemSizeInByte>>

The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.