Class FileSystem

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

Example Usage

EFS File System w/ tags

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var foo = new Aws.Efs.FileSystem("foo", new Aws.Efs.FileSystemArgs
    {
        Tags = 
        {
            { "Name", "MyProduct" },
        },
    });
}

}

Using lifecycle policy

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var fooWithLifecylePolicy = new Aws.Efs.FileSystem("fooWithLifecylePolicy", new Aws.Efs.FileSystemArgs
    {
        LifecyclePolicy = new Aws.Efs.Inputs.FileSystemLifecyclePolicyArgs
        {
            TransitionToIa = "AFTER_30_DAYS",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

FileSystem

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Efs

Assembly: Pulumi.Aws.dll

Syntax

public class FileSystem : CustomResource

Constructors

FileSystem(String, FileSystemArgs, CustomResourceOptions)

Create a FileSystem resource with the given unique name, arguments, and options.

Declaration

public FileSystem(string name, FileSystemArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
FileSystemArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name of the file system.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

CreationToken

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] (http://docs.aws.amazon.com/efs/latest/ug/) user guide for more information.

Declaration

public Output<string> CreationToken { get; }

Property Value

Type	Description
Output<System.String>

DnsName

The DNS name for the filesystem per documented convention.

Declaration

public Output<string> DnsName { get; }

Property Value

Type	Description
Output<System.String>

Encrypted

If true, the disk will be encrypted.

Declaration

public Output<bool> Encrypted { get; }

Property Value

Type	Description
Output<System.Boolean>

KmsKeyId

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

Declaration

public Output<string> KmsKeyId { get; }

Property Value

Type	Description
Output<System.String>

LifecyclePolicy

A file system lifecycle policy object (documented below).

Declaration

public Output<FileSystemLifecyclePolicy> LifecyclePolicy { get; }

Property Value

Type	Description
Output<FileSystemLifecyclePolicy>

PerformanceMode

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

Declaration

public Output<string> PerformanceMode { get; }

Property Value

Type	Description
Output<System.String>

ProvisionedThroughputInMibps

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

Declaration

public Output<double?> ProvisionedThroughputInMibps { get; }

Property Value

Type	Description
Output<System.Nullable<System.Double>>

Tags

A map of tags to assign to the file system.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ThroughputMode

Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. When using provisioned, also set provisioned_throughput_in_mibps.

Declaration

public Output<string> ThroughputMode { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, FileSystemState, CustomResourceOptions)

Get an existing FileSystem resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static FileSystem Get(string name, Input<string> id, FileSystemState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
FileSystemState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
FileSystem