Class CfnFileSystem

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnFileSystem

Implements

IInspectable

IFileSystemRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.EFS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFileSystem : CfnResource, IInspectable, IFileSystemRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnFileSystem Inherits CfnResource Implements IInspectable, IFileSystemRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnFileSystemProps?)

Create a new AWS::EFS::FileSystem.

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	The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ).
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.
FileSystemRef	A reference to a FileSystem resource.
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

ArnForFileSystem(IFileSystemRef)	The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ).
FromFileSystemArn(Construct, string, string)	Creates a new IFileSystemRef from an ARN.
FromFileSystemId(Construct, string, string)	Creates a new IFileSystemRef from a fileSystemId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnFileSystem(object)	Checks whether the given object is a CfnFileSystem.
RenderProperties(IDictionary<string, object>)	The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ).

Constructors

CfnFileSystem(Construct, string, ICfnFileSystemProps?)

Create a new AWS::EFS::FileSystem.

public CfnFileSystem(Construct scope, string id, ICfnFileSystemProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnFileSystemProps

Resource properties.

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

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

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

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

string

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

BackupPolicy

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

public virtual object? BackupPolicy { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnFileSystem.IBackupPolicyProperty

BypassPolicyLockoutSafetyCheck

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

public virtual object? BypassPolicyLockoutSafetyCheck { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

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

CfnProperties

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

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

Encrypted

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

public virtual object? Encrypted { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

FileSystemPolicy

The FileSystemPolicy for the EFS file system.

public virtual object? FileSystemPolicy { get; set; }

Property Value

object

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

FileSystemProtection

Describes the protection on the file system.

public virtual object? FileSystemProtection { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnFileSystem.IFileSystemProtectionProperty

FileSystemRef

A reference to a FileSystem resource.

public virtual IFileSystemReference FileSystemRef { get; }

Property Value

IFileSystemReference

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

FileSystemTagsRaw

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

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

Property Value

IElasticFileSystemTagProperty[]

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

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

string

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

LifecyclePolicies

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

public virtual object? LifecyclePolicies { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnFileSystem.ILifecyclePolicyProperty)[]

PerformanceMode

The performance mode of the file system.

public virtual string? PerformanceMode { get; set; }

Property Value

string

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

ProvisionedThroughputInMibps

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

public virtual double? ProvisionedThroughputInMibps { get; set; }

Property Value

double?

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

ReplicationConfiguration

Describes the replication configuration for a specific file system.

public virtual object? ReplicationConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnFileSystem.IReplicationConfigurationProperty

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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

ThroughputMode

Specifies the throughput mode for the file system.

public virtual string? ThroughputMode { get; set; }

Property Value

string

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

Methods

ArnForFileSystem(IFileSystemRef)

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

public static string ArnForFileSystem(IFileSystemRef resource)

Parameters

resource IFileSystemRef

Returns

string

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"
             });

FromFileSystemArn(Construct, string, string)

Creates a new IFileSystemRef from an ARN.

public static IFileSystemRef FromFileSystemArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IFileSystemRef

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

FromFileSystemId(Construct, string, string)

Creates a new IFileSystemRef from a fileSystemId.

public static IFileSystemRef FromFileSystemId(Construct scope, string id, string fileSystemId)

Parameters

scope Construct

id string

fileSystemId string

Returns

IFileSystemRef

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

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.

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

IsCfnFileSystem(object)

Checks whether the given object is a CfnFileSystem.

public static bool IsCfnFileSystem(object x)

Parameters

x object

Returns

bool

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

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable

IFileSystemRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable