Class CfnFileSystem
A CloudFormation AWS::EFS::FileSystem
.
Inherited Members
Namespace: Amazon.CDK.AWS.EFS
Assembly: Amazon.CDK.AWS.EFS.dll
Syntax (csharp)
public class CfnFileSystem : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFileSystem
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::EFS::FileSystem
resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ). 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.
CloudformationResource: AWS::EFS::FileSystem
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html
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,
FileSystemTags = new [] { new ElasticFileSystemTagProperty {
Key = "key",
Value = "value"
} },
KmsKeyId = "kmsKeyId",
LifecyclePolicies = new [] { new LifecyclePolicyProperty {
TransitionToIa = "transitionToIa",
TransitionToPrimaryStorageClass = "transitionToPrimaryStorageClass"
} },
PerformanceMode = "performanceMode",
ProvisionedThroughputInMibps = 123,
ThroughputMode = "throughputMode"
});
Synopsis
Constructors
CfnFileSystem(Construct, String, ICfnFileSystemProps) | Create a new |
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 |
Properties
AttrArn | The Amazon Resource Name (ARN) of the EFS file system. |
AttrFileSystemId | The ID of the EFS file system. |
AvailabilityZoneName | Used to create a file system that uses One Zone storage classes. |
BackupPolicy | Use the |
BypassPolicyLockoutSafetyCheck | (Optional) A boolean that specifies whether or not to bypass the |
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 |
KmsKeyId | The ID of the AWS KMS key to be used to protect the encrypted file system. |
LifecyclePolicies | An array of |
PerformanceMode | The performance mode of the file system. |
ProvisionedThroughputInMibps | The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. |
Tags | Use to create one or more tags associated with the file system. |
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(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 System.String
- scoped id of the resource.
- props ICfnFileSystemProps
- resource properties.
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
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
Used to create a file system that uses One Zone storage classes.
public virtual string AvailabilityZoneName { get; set; }
Property Value
System.String
Remarks
It specifies the AWS Availability Zone in which to create the file system. Use the format us-east-1a
to specify the Availability Zone. For more information about One Zone storage classes, see Using EFS storage classes in the Amazon EFS User Guide .
One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.
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
Remarks
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
Remarks
The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy
requests on this file system. Set BypassPolicyLockoutSafetyCheck
to True
only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy
requests on this file system. The default value is False
.
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
Remarks
When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem
, is used to protect the encrypted file system.
FileSystemPolicy
The FileSystemPolicy
for the EFS file system.
public virtual object FileSystemPolicy { get; set; }
Property Value
System.Object
Remarks
A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using IAM to control NFS access to Amazon EFS in the Amazon EFS User Guide .
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
Remarks
This parameter is only required if you want to use a nondefault KMS key . If this parameter is not specified, the default KMS key for Amazon EFS is used. This ID can be in one of the following formats:
If KmsKeyId
is specified, the Encrypted
parameter must be set to true.
LifecyclePolicies
An array of LifecyclePolicy
objects that define the file system's LifecycleConfiguration
object.
public virtual object LifecyclePolicies { get; set; }
Property Value
System.Object
Remarks
A LifecycleConfiguration
object informs EFS lifecycle management and intelligent tiering of the following:
Amazon EFS requires that each <code>LifecyclePolicy</code> object have only a single transition. This means that in a request body, <code>LifecyclePolicies</code> needs to be structured as an array of <code>LifecyclePolicy</code> objects, one object for each transition, <code>TransitionToIA</code> , <code>TransitionToPrimaryStorageClass</code> . See the example requests in the following section for more information.
PerformanceMode
The performance mode of the file system.
public virtual string PerformanceMode { get; set; }
Property Value
System.String
Remarks
We recommend generalPurpose
performance mode for most file systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.
The maxIO
mode is not supported on file systems using One Zone storage classes.
ProvisionedThroughputInMibps
The throughput, measured in MiB/s, 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>
Remarks
Valid values are 1-1024. Required if ThroughputMode
is set to provisioned
. The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .
Tags
Use to create one or more tags associated with the file system.
public virtual TagManager Tags { get; }
Property Value
Remarks
Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}"
key-value pair. Each key must be unique. For more information, see Tagging AWS resources in the AWS General Reference Guide .
ThroughputMode
Specifies the throughput mode for the file system.
public virtual string ThroughputMode { get; set; }
Property Value
System.String
Remarks
The mode can be bursting
, provisioned
, or elastic
. If you set ThroughputMode
to provisioned
, you must also set a value for ProvisionedThroughputInMibps
. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .
Default is bursting
.
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>