Class CfnFileSystem

The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ).

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnFileSystem
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.EFS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFileSystem : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnFileSystem
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

You must create a mount target ( AWS::EFS::MountTarget ) to mount your EFS file system on an Amazon EC2 or other AWS cloud compute resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html

CloudformationResource: AWS::EFS::FileSystem

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EFS;

var fileSystemPolicy;

var cfnFileSystem = new CfnFileSystem(this, "MyCfnFileSystem", new CfnFileSystemProps {
    AvailabilityZoneName = "availabilityZoneName",
    BackupPolicy = new BackupPolicyProperty {
        Status = "status"
    },
    BypassPolicyLockoutSafetyCheck = false,
    Encrypted = false,
    FileSystemPolicy = fileSystemPolicy,
    FileSystemProtection = new FileSystemProtectionProperty {
        ReplicationOverwriteProtection = "replicationOverwriteProtection"
    },
    FileSystemTags = new [] { new ElasticFileSystemTagProperty {
        Key = "key",
        Value = "value"
    } },
    KmsKeyId = "kmsKeyId",
    LifecyclePolicies = new [] { new LifecyclePolicyProperty {
        TransitionToArchive = "transitionToArchive",
        TransitionToIa = "transitionToIa",
        TransitionToPrimaryStorageClass = "transitionToPrimaryStorageClass"
    } },
    PerformanceMode = "performanceMode",
    ProvisionedThroughputInMibps = 123,
    ReplicationConfiguration = new ReplicationConfigurationProperty {
        Destinations = new [] { new ReplicationDestinationProperty {
            AvailabilityZoneName = "availabilityZoneName",
            FileSystemId = "fileSystemId",
            KmsKeyId = "kmsKeyId",
            Region = "region",
            RoleArn = "roleArn",
            Status = "status",
            StatusMessage = "statusMessage"
        } }
    },
    ThroughputMode = "throughputMode"
});

Synopsis

Constructors

CfnFileSystem(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnFileSystem(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnFileSystem(Construct, String, ICfnFileSystemProps)

Properties

AttrArn

The Amazon Resource Name (ARN) of the EFS file system.
AttrFileSystemId

The ID of the EFS file system.
AvailabilityZoneName

For One Zone file systems, specify the AWS Availability Zone in which to create the file system.
BackupPolicy

Use the BackupPolicy to turn automatic backups on or off for the file system.
BypassPolicyLockoutSafetyCheck

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Encrypted

A Boolean value that, if true, creates an encrypted file system.
FileSystemPolicy

The FileSystemPolicy for the EFS file system.
FileSystemProtection

Describes the protection on the file system.
FileSystemTagsRaw

Use to create one or more tags associated with the file system.
KmsKeyId

The ID of the AWS KMS key to be used to protect the encrypted file system.
LifecyclePolicies

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.
PerformanceMode

The performance mode of the file system.
ProvisionedThroughputInMibps

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.
ReplicationConfiguration

Describes the replication configuration for a specific file system.
Tags

Tag Manager which manages the tags for this resource.
ThroughputMode

Specifies the throughput mode for the file system.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnFileSystem(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnFileSystem(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnFileSystem(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnFileSystem(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnFileSystem(Construct, String, ICfnFileSystemProps)

public CfnFileSystem(Construct scope, string id, ICfnFileSystemProps props = null)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnFileSystemProps

Resource properties.

Properties

AttrArn

The Amazon Resource Name (ARN) of the EFS file system.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

CloudformationAttribute: Arn

AttrFileSystemId

The ID of the EFS file system.

public virtual string AttrFileSystemId { get; }
Property Value

System.String

Remarks

For example: fs-abcdef0123456789a

CloudformationAttribute: FileSystemId

AvailabilityZoneName

For One Zone file systems, specify the AWS Availability Zone in which to create the file system.

public virtual string AvailabilityZoneName { get; set; }
Property Value

System.String

BackupPolicy

Use the BackupPolicy to turn automatic backups on or off for the file system.

public virtual object BackupPolicy { get; set; }
Property Value

System.Object

BypassPolicyLockoutSafetyCheck

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

public virtual object BypassPolicyLockoutSafetyCheck { get; set; }
Property Value

System.Object

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Encrypted

A Boolean value that, if true, creates an encrypted file system.

public virtual object Encrypted { get; set; }
Property Value

System.Object

FileSystemPolicy

The FileSystemPolicy for the EFS file system.

public virtual object FileSystemPolicy { get; set; }
Property Value

System.Object

FileSystemProtection

Describes the protection on the file system.

public virtual object FileSystemProtection { get; set; }
Property Value

System.Object

FileSystemTagsRaw

Use to create one or more tags associated with the file system.

public virtual CfnFileSystem.IElasticFileSystemTagProperty[] FileSystemTagsRaw { get; set; }
Property Value

CfnFileSystem.IElasticFileSystemTagProperty[]

KmsKeyId

The ID of the AWS KMS key to be used to protect the encrypted file system.

public virtual string KmsKeyId { get; set; }
Property Value

System.String

LifecyclePolicies

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

public virtual object LifecyclePolicies { get; set; }
Property Value

System.Object

PerformanceMode

The performance mode of the file system.

public virtual string PerformanceMode { get; set; }
Property Value

System.String

ProvisionedThroughputInMibps

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.

public virtual Nullable<double> ProvisionedThroughputInMibps { get; set; }
Property Value

System.Nullable<System.Double>

ReplicationConfiguration

Describes the replication configuration for a specific file system.

public virtual object ReplicationConfiguration { get; set; }
Property Value

System.Object

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

ThroughputMode

Specifies the throughput mode for the file system.

public virtual string ThroughputMode { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements