# Data Types
<a name="API_Types"></a>

The following data types are supported:
+  [AccessPointDescription](API_AccessPointDescription.md) 
+  [BackupPolicy](API_BackupPolicy.md) 
+  [CreationInfo](API_CreationInfo.md) 
+  [Destination](API_Destination.md) 
+  [DestinationToCreate](API_DestinationToCreate.md) 
+  [FileSystemDescription](API_FileSystemDescription.md) 
+  [FileSystemProtectionDescription](API_FileSystemProtectionDescription.md) 
+  [FileSystemSize](API_FileSystemSize.md) 
+  [LifecyclePolicy](API_LifecyclePolicy.md) 
+  [MountTargetDescription](API_MountTargetDescription.md) 
+  [PosixUser](API_PosixUser.md) 
+  [ReplicationConfigurationDescription](API_ReplicationConfigurationDescription.md) 
+  [ResourceIdPreference](API_ResourceIdPreference.md) 
+  [RootDirectory](API_RootDirectory.md) 
+  [Tag](API_Tag.md) 

# AccessPointDescription
<a name="API_AccessPointDescription"></a>

Provides a description of an EFS file system access point.

## Contents
<a name="API_AccessPointDescription_Contents"></a>

 ** AccessPointArn **   <a name="efs-Type-AccessPointDescription-AccessPointArn"></a>
The unique Amazon Resource Name (ARN) associated with the access point.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$`   
Required: No

 ** AccessPointId **   <a name="efs-Type-AccessPointDescription-AccessPointId"></a>
The ID of the access point, assigned by Amazon EFS.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$`   
Required: No

 ** ClientToken **   <a name="efs-Type-AccessPointDescription-ClientToken"></a>
The opaque string specified in the request to ensure idempotent creation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.+`   
Required: No

 ** FileSystemId **   <a name="efs-Type-AccessPointDescription-FileSystemId"></a>
The ID of the EFS file system that the access point applies to.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`   
Required: No

 ** LifeCycleState **   <a name="efs-Type-AccessPointDescription-LifeCycleState"></a>
Identifies the lifecycle phase of the access point.  
Type: String  
Valid Values: `creating | available | updating | deleting | deleted | error`   
Required: No

 ** Name **   <a name="efs-Type-AccessPointDescription-Name"></a>
The name of the access point. This is the value of the `Name` tag.  
Type: String  
Required: No

 ** OwnerId **   <a name="efs-Type-AccessPointDescription-OwnerId"></a>
Identifies the AWS account that owns the access point resource.  
Type: String  
Length Constraints: Maximum length of 14.  
Pattern: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`   
Required: No

 ** PosixUser **   <a name="efs-Type-AccessPointDescription-PosixUser"></a>
The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.  
Type: [PosixUser](API_PosixUser.md) object  
Required: No

 ** RootDirectory **   <a name="efs-Type-AccessPointDescription-RootDirectory"></a>
The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.  
Type: [RootDirectory](API_RootDirectory.md) object  
Required: No

 ** Tags **   <a name="efs-Type-AccessPointDescription-Tags"></a>
The tags associated with the access point, presented as an array of Tag objects.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_AccessPointDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/AccessPointDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/AccessPointDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/AccessPointDescription) 

# BackupPolicy
<a name="API_BackupPolicy"></a>

The backup policy for the file system used to create automatic daily backups. If status has a value of `ENABLED`, the file system is being automatically backed up. For more information, see [Automatic backups](https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups).

## Contents
<a name="API_BackupPolicy_Contents"></a>

 ** Status **   <a name="efs-Type-BackupPolicy-Status"></a>
Describes the status of the file system's backup policy.  
+  ** `ENABLED` ** – EFS is automatically backing up the file system.
+  ** `ENABLING` ** – EFS is turning on automatic backups for the file system.
+  ** `DISABLED` ** – Automatic back ups are turned off for the file system.
+  ** `DISABLING` ** – EFS is turning off automatic backups for the file system.
Type: String  
Valid Values: `ENABLED | ENABLING | DISABLED | DISABLING`   
Required: Yes

## See Also
<a name="API_BackupPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/BackupPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/BackupPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/BackupPolicy) 

# CreationInfo
<a name="API_CreationInfo"></a>

Required if the `RootDirectory` > `Path` specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's `RootDirectory` > `Path`. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying `CreationInfo`, you must include values for all properties. 

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

**Important**  
If you do not provide `CreationInfo` and the specified `RootDirectory` does not exist, attempts to mount the file system using the access point will fail.

## Contents
<a name="API_CreationInfo_Contents"></a>

 ** OwnerGid **   <a name="efs-Type-CreationInfo-OwnerGid"></a>
Specifies the POSIX group ID to apply to the `RootDirectory`. Accepts values from 0 to 2^32 (4294967295).  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** OwnerUid **   <a name="efs-Type-CreationInfo-OwnerUid"></a>
Specifies the POSIX user ID to apply to the `RootDirectory`. Accepts values from 0 to 2^32 (4294967295).  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** Permissions **   <a name="efs-Type-CreationInfo-Permissions"></a>
Specifies the POSIX permissions to apply to the `RootDirectory`, in the format of an octal number representing the file's mode bits.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 4.  
Pattern: `^[0-7]{3,4}$`   
Required: Yes

## See Also
<a name="API_CreationInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/CreationInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/CreationInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/CreationInfo) 

# Destination
<a name="API_Destination"></a>

Describes the destination file system in the replication configuration.

## Contents
<a name="API_Destination_Contents"></a>

 ** FileSystemId **   <a name="efs-Type-Destination-FileSystemId"></a>
The ID of the destination Amazon EFS file system.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`   
Required: Yes

 ** Region **   <a name="efs-Type-Destination-Region"></a>
The AWS Region in which the destination file system is located.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`   
Required: Yes

 ** Status **   <a name="efs-Type-Destination-Status"></a>
Describes the status of the replication configuration. For more information about replication status, see [Viewing replication details](https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS User Guide*.   
Type: String  
Valid Values: `ENABLED | ENABLING | DELETING | ERROR | PAUSED | PAUSING`   
Required: Yes

 ** LastReplicatedTimestamp **   <a name="efs-Type-Destination-LastReplicatedTimestamp"></a>
The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.  
Type: Timestamp  
Required: No

 ** OwnerId **   <a name="efs-Type-Destination-OwnerId"></a>
ID of the AWS account in which the destination file system resides.  
Type: String  
Length Constraints: Maximum length of 14.  
Pattern: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`   
Required: No

 ** RoleArn **   <a name="efs-Type-Destination-RoleArn"></a>
Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS to perform replication on its behalf. This is optional for same-account replication and required for cross-account replication.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

 ** StatusMessage **   <a name="efs-Type-Destination-StatusMessage"></a>
Message that provides details about the `PAUSED` or `ERRROR` state of the replication destination configuration. For more information about replication status messages, see [Viewing replication details](https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html) in the *Amazon EFS User Guide*.   
Type: String  
Required: No

## See Also
<a name="API_Destination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/Destination) 

# DestinationToCreate
<a name="API_DestinationToCreate"></a>

Describes the new or existing destination file system for the replication configuration.
+ If you want to replicate to a new file system, do not specify the File System ID for the destination file system. Amazon EFS creates a new, empty file system. For One Zone storage, specify the Availability Zone to create the file system in. To use an AWS Key Management Service key other than the default KMS key, then specify it. For more information, see [Configuring replication to new Amazon EFS file system](https://docs.aws.amazon.com/efs/latest/ug/create-replication.html) in the *Amazon EFS User Guide*.
**Note**  
After the file system is created, you cannot change the KMS key or the performance mode.
+ If you want to replicate to an existing file system that's in the same account as the source file system, then you need to provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system's replication overwrite protection must be disabled. For more information, see [Replicating to an existing file system](https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination) in the *Amazon EFS User Guide*.
+ If you are replicating the file system to a file system that's in a different account than the source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform replication on the destination account. The file system's replication overwrite protection must be disabled. For more information, see [Replicating across AWS accounts](https://docs.aws.amazon.com/efs/latest/ug/cross-account-replication.html) in the *Amazon EFS User Guide*.

## Contents
<a name="API_DestinationToCreate_Contents"></a>

 ** AvailabilityZoneName **   <a name="efs-Type-DestinationToCreate-AvailabilityZoneName"></a>
To create a file system that uses One Zone storage, specify the name of the Availability Zone in which to create the destination file system.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.+`   
Required: No

 ** FileSystemId **   <a name="efs-Type-DestinationToCreate-FileSystemId"></a>
The ID or ARN of the file system to use for the destination. For cross-account replication, this must be an ARN. The file system's replication overwrite replication must be disabled. If no ID or ARN is specified, then a new file system is created.   
When you initially configure replication to an existing file system, Amazon EFS writes data to or removes existing data from the destination file system to match data in the source file system. If you don't want to change data in the destination file system, then you should replicate to a new file system instead. For more information, see [https://docs.aws.amazon.com/efs/latest/ug/create-replication.html](https://docs.aws.amazon.com/efs/latest/ug/create-replication.html).
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`   
Required: No

 ** KmsKeyId **   <a name="efs-Type-DestinationToCreate-KmsKeyId"></a>
Specify the AWS Key Management Service (AWS KMS) key that you want to use to encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS, `/aws/elasticfilesystem`. This ID can be in one of the following formats:  
+ Key ID - The unique identifier of the key, for example `1234abcd-12ab-34cd-56ef-1234567890ab`.
+ ARN - The ARN for the key, for example `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
+ Key alias - A previously created display name for a key, for example `alias/projectKey1`.
+ Key alias ARN - The ARN for a key alias, for example `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`.
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$`   
Required: No

 ** Region **   <a name="efs-Type-DestinationToCreate-Region"></a>
To create a file system that uses Regional storage, specify the AWS Region in which to create the destination file system. The Region must be enabled for the AWS account that owns the source file system. For more information, see [Managing AWS Regions](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable) in the * AWS General Reference Reference Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`   
Required: No

 ** RoleArn **   <a name="efs-Type-DestinationToCreate-RoleArn"></a>
Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS to perform replication on its behalf. This is optional for same-account replication and required for cross-account replication.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: No

## See Also
<a name="API_DestinationToCreate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DestinationToCreate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DestinationToCreate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DestinationToCreate) 

# FileSystemDescription
<a name="API_FileSystemDescription"></a>

A description of the file system.

## Contents
<a name="API_FileSystemDescription_Contents"></a>

 ** CreationTime **   <a name="efs-Type-FileSystemDescription-CreationTime"></a>
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).  
Type: Timestamp  
Required: Yes

 ** CreationToken **   <a name="efs-Type-FileSystemDescription-CreationToken"></a>
The opaque string specified in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.+`   
Required: Yes

 ** FileSystemId **   <a name="efs-Type-FileSystemDescription-FileSystemId"></a>
The ID of the file system, assigned by Amazon EFS.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`   
Required: Yes

 ** LifeCycleState **   <a name="efs-Type-FileSystemDescription-LifeCycleState"></a>
The lifecycle phase of the file system.  
Type: String  
Valid Values: `creating | available | updating | deleting | deleted | error`   
Required: Yes

 ** NumberOfMountTargets **   <a name="efs-Type-FileSystemDescription-NumberOfMountTargets"></a>
The current number of mount targets that the file system has. For more information, see [CreateMountTarget](API_CreateMountTarget.md).  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** OwnerId **   <a name="efs-Type-FileSystemDescription-OwnerId"></a>
The AWS account that created the file system.  
Type: String  
Length Constraints: Maximum length of 14.  
Pattern: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`   
Required: Yes

 ** PerformanceMode **   <a name="efs-Type-FileSystemDescription-PerformanceMode"></a>
The performance mode of the file system.  
Type: String  
Valid Values: `generalPurpose | maxIO`   
Required: Yes

 ** SizeInBytes **   <a name="efs-Type-FileSystemDescription-SizeInBytes"></a>
The latest known metered size (in bytes) of data stored in the file system, in its `Value` field, and the time at which that size was determined in its `Timestamp` field. The `Timestamp` value is the integer number of seconds since 1970-01-01T00:00:00Z. The `SizeInBytes` value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, `SizeInBytes` represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.   
Type: [FileSystemSize](API_FileSystemSize.md) object  
Required: Yes

 ** Tags **   <a name="efs-Type-FileSystemDescription-Tags"></a>
The tags associated with the file system, presented as an array of `Tag` objects.  
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

 ** AvailabilityZoneId **   <a name="efs-Type-FileSystemDescription-AvailabilityZoneId"></a>
The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, `use1-az1` is an Availability Zone ID for the us-east-1 AWS Region, and it has the same location in every AWS account.  
Type: String  
Required: No

 ** AvailabilityZoneName **   <a name="efs-Type-FileSystemDescription-AvailabilityZoneName"></a>
Describes the AWS Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see [Using EFS storage classes](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.+`   
Required: No

 ** Encrypted **   <a name="efs-Type-FileSystemDescription-Encrypted"></a>
A Boolean value that, if true, indicates that the file system is encrypted.  
Type: Boolean  
Required: No

 ** FileSystemArn **   <a name="efs-Type-FileSystemDescription-FileSystemArn"></a>
The Amazon Resource Name (ARN) for the EFS file system, in the format `arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id `. Example with sample data: `arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567`   
Type: String  
Required: No

 ** FileSystemProtection **   <a name="efs-Type-FileSystemDescription-FileSystemProtection"></a>
Describes the protection on the file system.   
Type: [FileSystemProtectionDescription](API_FileSystemProtectionDescription.md) object  
Required: No

 ** KmsKeyId **   <a name="efs-Type-FileSystemDescription-KmsKeyId"></a>
The ID of an AWS KMS key used to protect the encrypted file system.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$`   
Required: No

 ** Name **   <a name="efs-Type-FileSystemDescription-Name"></a>
You can add tags to a file system, including a `Name` tag. For more information, see [CreateFileSystem](API_CreateFileSystem.md). If the file system has a `Name` tag, Amazon EFS returns the value in this field.   
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

 ** ProvisionedThroughputInMibps **   <a name="efs-Type-FileSystemDescription-ProvisionedThroughputInMibps"></a>
The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using `ThroughputMode` set to `provisioned`.  
Type: Double  
Valid Range: Minimum value of 1.0.  
Required: No

 ** ThroughputMode **   <a name="efs-Type-FileSystemDescription-ThroughputMode"></a>
Displays the file system's throughput mode. For more information, see [Throughput modes](https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes) in the *Amazon EFS User Guide*.   
Type: String  
Valid Values: `bursting | provisioned | elastic`   
Required: No

## See Also
<a name="API_FileSystemDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/FileSystemDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/FileSystemDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/FileSystemDescription) 

# FileSystemProtectionDescription
<a name="API_FileSystemProtectionDescription"></a>

Describes the protection on a file system. 

## Contents
<a name="API_FileSystemProtectionDescription_Contents"></a>

 ** ReplicationOverwriteProtection **   <a name="efs-Type-FileSystemProtectionDescription-ReplicationOverwriteProtection"></a>
The status of the file system's replication overwrite protection.  
+  `ENABLED` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is `ENABLED` by default. 
+  `DISABLED` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
+  `REPLICATING` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is modified only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.  
Type: String  
Valid Values: `ENABLED | DISABLED | REPLICATING`   
Required: No

## See Also
<a name="API_FileSystemProtectionDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/FileSystemProtectionDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/FileSystemProtectionDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/FileSystemProtectionDescription) 

# FileSystemSize
<a name="API_FileSystemSize"></a>

The latest known metered size (in bytes) of data stored in the file system, in its `Value` field, and the time at which that size was determined in its `Timestamp` field. The value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

## Contents
<a name="API_FileSystemSize_Contents"></a>

 ** Value **   <a name="efs-Type-FileSystemSize-Value"></a>
The latest known metered size (in bytes) of data stored in the file system.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: Yes

 ** Timestamp **   <a name="efs-Type-FileSystemSize-Timestamp"></a>
The time at which the size of data, returned in the `Value` field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.  
Type: Timestamp  
Required: No

 ** ValueInArchive **   <a name="efs-Type-FileSystemSize-ValueInArchive"></a>
The latest known metered size (in bytes) of data stored in the Archive storage class.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ValueInIA **   <a name="efs-Type-FileSystemSize-ValueInIA"></a>
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ValueInStandard **   <a name="efs-Type-FileSystemSize-ValueInStandard"></a>
The latest known metered size (in bytes) of data stored in the Standard storage class.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_FileSystemSize_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/FileSystemSize) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/FileSystemSize) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/FileSystemSize) 

# LifecyclePolicy
<a name="API_LifecyclePolicy"></a>

Describes a policy used by lifecycle management that specifies when to transition files into and out of storage classes. For more information, see [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).

**Note**  
When using the `put-lifecycle-configuration` CLI command or the `PutLifecycleConfiguration` API action, Amazon EFS requires that each `LifecyclePolicy` object have only a single transition. This means that in a request body, `LifecyclePolicies` must be structured as an array of `LifecyclePolicy` objects, one object for each transition. For more information, see the request examples in [PutLifecycleConfiguration](API_PutLifecycleConfiguration.md).

## Contents
<a name="API_LifecyclePolicy_Contents"></a>

 ** TransitionToArchive **   <a name="efs-Type-LifecyclePolicy-TransitionToArchive"></a>
The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.  
Type: String  
Valid Values: `AFTER_1_DAY | AFTER_7_DAYS | AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_90_DAYS | AFTER_180_DAYS | AFTER_270_DAYS | AFTER_365_DAYS`   
Required: No

 ** TransitionToIA **   <a name="efs-Type-LifecyclePolicy-TransitionToIA"></a>
The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.  
Type: String  
Valid Values: `AFTER_7_DAYS | AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_90_DAYS | AFTER_1_DAY | AFTER_180_DAYS | AFTER_270_DAYS | AFTER_365_DAYS`   
Required: No

 ** TransitionToPrimaryStorageClass **   <a name="efs-Type-LifecyclePolicy-TransitionToPrimaryStorageClass"></a>
Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.  
Type: String  
Valid Values: `AFTER_1_ACCESS`   
Required: No

## See Also
<a name="API_LifecyclePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/LifecyclePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/LifecyclePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/LifecyclePolicy) 

# MountTargetDescription
<a name="API_MountTargetDescription"></a>

Provides a description of a mount target.

## Contents
<a name="API_MountTargetDescription_Contents"></a>

 ** FileSystemId **   <a name="efs-Type-MountTargetDescription-FileSystemId"></a>
The ID of the file system for which the mount target is intended.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`   
Required: Yes

 ** LifeCycleState **   <a name="efs-Type-MountTargetDescription-LifeCycleState"></a>
Lifecycle state of the mount target.  
Type: String  
Valid Values: `creating | available | updating | deleting | deleted | error`   
Required: Yes

 ** MountTargetId **   <a name="efs-Type-MountTargetDescription-MountTargetId"></a>
System-assigned mount target ID.  
Type: String  
Length Constraints: Minimum length of 13. Maximum length of 45.  
Pattern: `^fsmt-[0-9a-f]{8,40}$`   
Required: Yes

 ** SubnetId **   <a name="efs-Type-MountTargetDescription-SubnetId"></a>
The ID of the mount target's subnet.  
Type: String  
Length Constraints: Minimum length of 15. Maximum length of 47.  
Pattern: `^subnet-[0-9a-f]{8,40}$`   
Required: Yes

 ** AvailabilityZoneId **   <a name="efs-Type-MountTargetDescription-AvailabilityZoneId"></a>
The unique and consistent identifier of the Availability Zone that the mount target resides in. For example, `use1-az1` is an AZ ID for the us-east-1 Region and it has the same location in every AWS account.  
Type: String  
Required: No

 ** AvailabilityZoneName **   <a name="efs-Type-MountTargetDescription-AvailabilityZoneName"></a>
The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each AWS account. For example, the Availability Zone `us-east-1a` for your AWS account might not be the same location as `us-east-1a` for another AWS account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.+`   
Required: No

 ** IpAddress **   <a name="efs-Type-MountTargetDescription-IpAddress"></a>
The IPv4 address for the mount target.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 15.  
Pattern: `^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$`   
Required: No

 ** Ipv6Address **   <a name="efs-Type-MountTargetDescription-Ipv6Address"></a>
The IPv6 address for the mount target.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 39.  
Required: No

 ** NetworkInterfaceId **   <a name="efs-Type-MountTargetDescription-NetworkInterfaceId"></a>
The ID of the network interface that Amazon EFS created when it created the mount target.  
Type: String  
Required: No

 ** OwnerId **   <a name="efs-Type-MountTargetDescription-OwnerId"></a>
 AWS account ID that owns the resource.  
Type: String  
Length Constraints: Maximum length of 14.  
Pattern: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`   
Required: No

 ** VpcId **   <a name="efs-Type-MountTargetDescription-VpcId"></a>
The virtual private cloud (VPC) ID that the mount target is configured in.  
Type: String  
Required: No

## See Also
<a name="API_MountTargetDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/MountTargetDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/MountTargetDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/MountTargetDescription) 

# PosixUser
<a name="API_PosixUser"></a>

The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.

## Contents
<a name="API_PosixUser_Contents"></a>

 ** Gid **   <a name="efs-Type-PosixUser-Gid"></a>
The POSIX group ID used for all file system operations using this access point.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** Uid **   <a name="efs-Type-PosixUser-Uid"></a>
The POSIX user ID used for all file system operations using this access point.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** SecondaryGids **   <a name="efs-Type-PosixUser-SecondaryGids"></a>
Secondary POSIX group IDs used for all file system operations using this access point.  
Type: Array of longs  
Array Members: Minimum number of 0 items. Maximum number of 16 items.  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: No

## See Also
<a name="API_PosixUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/PosixUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/PosixUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/PosixUser) 

# ReplicationConfigurationDescription
<a name="API_ReplicationConfigurationDescription"></a>

Describes the replication configuration for a specific file system.

## Contents
<a name="API_ReplicationConfigurationDescription_Contents"></a>

 ** CreationTime **   <a name="efs-Type-ReplicationConfigurationDescription-CreationTime"></a>
Describes when the replication configuration was created.  
Type: Timestamp  
Required: Yes

 ** Destinations **   <a name="efs-Type-ReplicationConfigurationDescription-Destinations"></a>
An array of destination objects. Only one destination object is supported.  
Type: Array of [Destination](API_Destination.md) objects  
Required: Yes

 ** OriginalSourceFileSystemArn **   <a name="efs-Type-ReplicationConfigurationDescription-OriginalSourceFileSystemArn"></a>
The Amazon Resource Name (ARN) of the original source EFS file system in the replication configuration.  
Type: String  
Required: Yes

 ** SourceFileSystemArn **   <a name="efs-Type-ReplicationConfigurationDescription-SourceFileSystemArn"></a>
The Amazon Resource Name (ARN) of the current source file system in the replication configuration.  
Type: String  
Required: Yes

 ** SourceFileSystemId **   <a name="efs-Type-ReplicationConfigurationDescription-SourceFileSystemId"></a>
The ID of the source Amazon EFS file system that is being replicated.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`   
Required: Yes

 ** SourceFileSystemRegion **   <a name="efs-Type-ReplicationConfigurationDescription-SourceFileSystemRegion"></a>
The AWS Region in which the source EFS file system is located.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`   
Required: Yes

 ** SourceFileSystemOwnerId **   <a name="efs-Type-ReplicationConfigurationDescription-SourceFileSystemOwnerId"></a>
ID of the AWS account in which the source file system resides.  
Type: String  
Length Constraints: Maximum length of 14.  
Pattern: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`   
Required: No

## See Also
<a name="API_ReplicationConfigurationDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/ReplicationConfigurationDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/ReplicationConfigurationDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/ReplicationConfigurationDescription) 

# ResourceIdPreference
<a name="API_ResourceIdPreference"></a>

Describes the resource type and its ID preference for the user's AWS account, in the current AWS Region.

## Contents
<a name="API_ResourceIdPreference_Contents"></a>

 ** ResourceIdType **   <a name="efs-Type-ResourceIdPreference-ResourceIdType"></a>
Identifies the EFS resource ID preference, either `LONG_ID` (17 characters) or `SHORT_ID` (8 characters).  
Type: String  
Valid Values: `LONG_ID | SHORT_ID`   
Required: No

 ** Resources **   <a name="efs-Type-ResourceIdPreference-Resources"></a>
Identifies the Amazon EFS resources to which the ID preference setting applies, `FILE_SYSTEM` and `MOUNT_TARGET`.  
Type: Array of strings  
Valid Values: `FILE_SYSTEM | MOUNT_TARGET`   
Required: No

## See Also
<a name="API_ResourceIdPreference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/ResourceIdPreference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/ResourceIdPreference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/ResourceIdPreference) 

# RootDirectory
<a name="API_RootDirectory"></a>

Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's `RootDirectory` and its subdirectories.

## Contents
<a name="API_RootDirectory_Contents"></a>

 ** CreationInfo **   <a name="efs-Type-RootDirectory-CreationInfo"></a>
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's `RootDirectory`. If the `RootDirectory` > `Path` specified does not exist, EFS creates the root directory using the `CreationInfo` settings when a client connects to an access point. When specifying the `CreationInfo`, you must provide values for all properties.   
If you do not provide `CreationInfo` and the specified `RootDirectory` > `Path` does not exist, attempts to mount the file system using the access point will fail.
Type: [CreationInfo](API_CreationInfo.md) object  
Required: No

 ** Path **   <a name="efs-Type-RootDirectory-Path"></a>
Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the `CreationInfo`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^(\/|(\/(?!\.)+[^$#<>;`|&?{}^*/\n]+){1,4})$`   
Required: No

## See Also
<a name="API_RootDirectory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/RootDirectory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/RootDirectory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/RootDirectory) 

# Tag
<a name="API_Tag"></a>

A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters:` + - = . _ : /`.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="efs-Type-Tag-Key"></a>
The tag key (String). The key can't start with `aws:`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`   
Required: Yes

 ** Value **   <a name="efs-Type-Tag-Value"></a>
The value of the tag key.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/Tag)