String clientToken
The opaque string specified in the request to ensure idempotent creation.
String name
The name of the access point. This is the value of the Name tag.
SdkInternalList<T> tags
The tags associated with the access point, presented as an array of Tag objects.
String accessPointId
The ID of the access point, assigned by Amazon EFS.
String accessPointArn
The unique Amazon Resource Name (ARN) associated with the access point.
String fileSystemId
The ID of the EFS file system that the access point applies to.
PosixUser posixUser
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.
RootDirectory rootDirectory
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
String ownerId
Identified the Amazon Web Services account that owns the access point resource.
String lifeCycleState
Identifies the lifecycle phase of the access point.
String errorCode
String errorCode
String errorCode
String status
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.
String errorCode
String clientToken
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
SdkInternalList<T> tags
Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
String fileSystemId
The ID of the EFS file system that the access point provides access to.
PosixUser posixUser
The operating system user and group applied to all file system requests made using the access point.
RootDirectory rootDirectory
Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your
file system to NFS clients using the access point. The clients using the access point can only access the root
directory and below. If the RootDirectory > Path specified does not exist, EFS
creates it and applies the CreationInfo settings when a client connects to an access point. When
specifying a RootDirectory, you must provide the Path, and the
CreationInfo.
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.
String clientToken
The opaque string specified in the request to ensure idempotent creation.
String name
The name of the access point. This is the value of the Name tag.
SdkInternalList<T> tags
The tags associated with the access point, presented as an array of Tag objects.
String accessPointId
The ID of the access point, assigned by Amazon EFS.
String accessPointArn
The unique Amazon Resource Name (ARN) associated with the access point.
String fileSystemId
The ID of the EFS file system that the access point applies to.
PosixUser posixUser
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.
RootDirectory rootDirectory
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
String ownerId
Identified the Amazon Web Services account that owns the access point resource.
String lifeCycleState
Identifies the lifecycle phase of the access point.
String creationToken
A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
String performanceMode
The performance mode of the file system. 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.
Boolean encrypted
A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have
the option of specifying an existing Key Management Service key (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.
String kmsKeyId
The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using the following formats:
Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.
ARN - An Amazon Resource Name (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 - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
If you use KmsKeyId, you must set the CreateFileSystemRequest$Encrypted parameter to true.
EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.
String throughputMode
Specifies the throughput mode for the file system, either bursting or provisioned. 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, as long as it’s been more than
24 hours since the last decrease or throughput mode change. For more information, see Specifying throughput
with provisioned mode in the Amazon EFS User Guide.
Default is bursting.
Double provisionedThroughputInMibps
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. 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 Amazon Web Services Support. For more information,
see Amazon EFS quotas that you can
increase in the Amazon EFS User Guide.
String availabilityZoneName
Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services
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 Amazon Web Services Regions where Amazon EFS is available.
Boolean backup
Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to
true to enable automatic backups. If you are creating a file system that uses One Zone storage
classes, automatic backups are enabled by default. For more information, see Automatic backups in the
Amazon EFS User Guide.
Default is false. However, if you specify an AvailabilityZoneName, the default is
true.
Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
SdkInternalList<T> tags
Use to create one or more tags associated with the file system. 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 Amazon Web Services resources
in the Amazon Web Services General Reference Guide.
String ownerId
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
String creationToken
The opaque string specified in the request.
String fileSystemId
The ID of the file system, assigned by Amazon EFS.
String fileSystemArn
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
Date creationTime
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
String lifeCycleState
The lifecycle phase of the file system.
String name
You can add tags to a file system, including a Name tag. For more information, see
CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this
field.
Integer numberOfMountTargets
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
FileSystemSize sizeInBytes
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.
String performanceMode
The performance mode of the file system.
Boolean encrypted
A Boolean value that, if true, indicates that the file system is encrypted.
String kmsKeyId
The ID of an KMS key used to protect the encrypted file system.
String throughputMode
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
Double provisionedThroughputInMibps
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using
ThroughputMode set to provisioned.
String availabilityZoneName
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
String availabilityZoneId
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes
exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services
Region, and it has the same location in every Amazon Web Services account.
SdkInternalList<T> tags
The tags associated with the file system, presented as an array of Tag objects.
String fileSystemId
The ID of the file system for which to create the mount target.
String subnetId
The ID of the subnet to add the mount target in. For file systems that use One Zone storage classes, use the subnet that is associated with the file system's Availability Zone.
String ipAddress
Valid IPv4 address within the address range of the specified subnet.
SdkInternalList<T> securityGroups
Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet
specified.
String ownerId
Amazon Web Services account ID that owns the resource.
String mountTargetId
System-assigned mount target ID.
String fileSystemId
The ID of the file system for which the mount target is intended.
String subnetId
The ID of the mount target's subnet.
String lifeCycleState
Lifecycle state of the mount target.
String ipAddress
Address at which the file system can be mounted by using the mount target.
String networkInterfaceId
The ID of the network interface that Amazon EFS created when it created the mount target.
String availabilityZoneId
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 Amazon Web
Services account.
String availabilityZoneName
The name of the Availability Zone in which the mount target is located. Availability Zones are independently
mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a
for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon
Web Services account.
String vpcId
The virtual private cloud (VPC) ID that the mount target is configured in.
String sourceFileSystemId
Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.
SdkInternalList<T> destinations
An array of destination configuration objects. Only one destination configuration object is supported.
String sourceFileSystemId
The ID of the source Amazon EFS file system that is being replicated.
String sourceFileSystemRegion
The Amazon Web Services Region in which the source Amazon EFS file system is located.
String sourceFileSystemArn
The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
String originalSourceFileSystemArn
The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
Date creationTime
Describes when the replication configuration was created.
SdkInternalList<T> destinations
An array of destination objects. Only one destination object is supported.
String fileSystemId
The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.
SdkInternalList<T> tags
An array of Tag objects to add. Each Tag object is a key-value pair.
Long ownerUid
Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
(4294967295).
Long ownerGid
Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
(4294967295).
String permissions
Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number
representing the file's mode bits.
String accessPointId
The ID of the access point that you want to delete.
String fileSystemId
Specifies the EFS file system for which to delete the FileSystemPolicy.
String fileSystemId
The ID of the file system you want to delete.
String mountTargetId
The ID of the mount target to delete (String).
String sourceFileSystemId
The ID of the source file system in the replication configuration.
String fileSystemId
The ID of the file system whose tags you want to delete (String).
SdkInternalList<T> tagKeys
A list of tag keys to delete.
String errorCode
Integer maxResults
(Optional) When retrieving all access points for a file system, you can optionally specify the
MaxItems parameter to limit the number of objects returned in a response. The default value is 100.
String nextToken
NextToken is present if the response is paginated. You can use NextMarker in the
subsequent request to fetch the next page of access point descriptions.
String accessPointId
(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with
FileSystemId.
String fileSystemId
(Optional) If you provide a FileSystemId, EFS returns all access points for that file system;
mutually exclusive with AccessPointId.
SdkInternalList<T> accessPoints
An array of access point descriptions.
String nextToken
Present if there are more access points than returned in the response. You can use the NextMarker in the subsequent request to fetch the additional descriptions.
String nextToken
(Optional) You can use NextToken in a subsequent request to fetch the next page of Amazon Web
Services account preferences if the response payload was paginated.
Integer maxResults
(Optional) When retrieving account preferences, you can optionally specify the MaxItems parameter to
limit the number of objects returned in a response. The default value is 100.
ResourceIdPreference resourceIdPreference
Describes the resource ID preference setting for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.
String nextToken
Present if there are more records than returned in the response. You can use the NextToken in the
subsequent request to fetch the additional descriptions.
String fileSystemId
Specifies which EFS file system to retrieve the BackupPolicy for.
BackupPolicy backupPolicy
Describes the file system's backup policy, indicating whether automatic backups are turned on or off.
String fileSystemId
Specifies which EFS file system to retrieve the FileSystemPolicy for.
Integer maxItems
(Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.
String marker
(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String).
If present, specifies to continue the list from where the returning call had left off.
String creationToken
(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.
String fileSystemId
(Optional) ID of the file system whose description you want to retrieve (String).
String marker
Present if provided by caller in the request (String).
SdkInternalList<T> fileSystems
An array of file system descriptions.
String nextMarker
Present if there are more file systems than returned in the response (String). You can use the
NextMarker in the subsequent request to fetch the descriptions.
String fileSystemId
The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).
SdkInternalList<T> lifecyclePolicies
An array of lifecycle management policies. EFS supports a maximum of one policy per file system.
String mountTargetId
The ID of the mount target whose security groups you want to retrieve.
SdkInternalList<T> securityGroups
An array of security groups.
Integer maxItems
(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.
String marker
(Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String).
If present, it specifies to continue the list from where the previous returning call left off.
String fileSystemId
(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your
request if an AccessPointId or MountTargetId is not included. Accepts either a file
system ID or ARN as input.
String mountTargetId
(Optional) ID of the mount target that you want to have described (String). It must be included in your request
if FileSystemId is not included. Accepts either a mount target ID or ARN as input.
String accessPointId
(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your
request if a FileSystemId or MountTargetId is not included in your request. Accepts
either an access point ID or ARN as input.
String marker
If the request included the Marker, the response returns that value in this field.
SdkInternalList<T> mountTargets
Returns the file system's mount targets as an array of MountTargetDescription objects.
String nextMarker
If a value is present, there are more mount targets to return. In a subsequent request, you can provide
Marker in your request with this value to retrieve the next set of mount targets.
String fileSystemId
You can retrieve the replication configuration for a specific file system by providing its file system ID.
String nextToken
NextToken is present if the response is paginated. You can use NextToken in a
subsequent request to fetch the next page of output.
Integer maxResults
(Optional) To limit the number of objects returned in a response, you can specify the MaxItems
parameter. The default value is 100.
SdkInternalList<T> replications
The collection of replication configurations that is returned.
String nextToken
You can use the NextToken from the previous response in a subsequent request to fetch the additional
descriptions.
Integer maxItems
(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.
String marker
(Optional) An opaque pagination token returned from a previous DescribeTags operation (String). If
present, it specifies to continue the list from where the previous call left off.
String fileSystemId
The ID of the file system whose tag set you want to retrieve.
String marker
If the request included a Marker, the response returns that value in this field.
SdkInternalList<T> tags
Returns tags associated with the file system as an array of Tag objects.
String nextMarker
If a value is present, there are more tags to return. In a subsequent request, you can provide the value of
NextMarker as the value of the Marker parameter in your next request to retrieve the
next set of tags.
String status
Describes the status of the destination Amazon EFS file system. If the status is ERROR, the
destination file system in the replication configuration is in a failed state and is unrecoverable. To access the
file system data, restore a backup of the failed file system to a new file system.
String fileSystemId
The ID of the destination Amazon EFS file system.
String region
The Amazon Web Services Region in which the destination file system is located.
Date lastReplicatedTimestamp
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.
String region
To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.
String availabilityZoneName
To create a file system that uses EFS One Zone storage, specify the name of the Availability Zone in which to create the destination file system.
String kmsKeyId
Specifies the Key Management Service (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 Amazon Resource Name (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.
String ownerId
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
String creationToken
The opaque string specified in the request.
String fileSystemId
The ID of the file system, assigned by Amazon EFS.
String fileSystemArn
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
Date creationTime
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
String lifeCycleState
The lifecycle phase of the file system.
String name
You can add tags to a file system, including a Name tag. For more information, see
CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this
field.
Integer numberOfMountTargets
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
FileSystemSize sizeInBytes
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.
String performanceMode
The performance mode of the file system.
Boolean encrypted
A Boolean value that, if true, indicates that the file system is encrypted.
String kmsKeyId
The ID of an KMS key used to protect the encrypted file system.
String throughputMode
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
Double provisionedThroughputInMibps
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using
ThroughputMode set to provisioned.
String availabilityZoneName
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
String availabilityZoneId
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes
exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services
Region, and it has the same location in every Amazon Web Services account.
SdkInternalList<T> tags
The tags associated with the file system, presented as an array of Tag objects.
String errorCode
String errorCode
String errorCode
Long value
The latest known metered size (in bytes) of data stored in the file system.
Date timestamp
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.
Long valueInIA
The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
Long valueInStandard
The latest known metered size (in bytes) of data stored in the Standard storage class.
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String transitionToIA
Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.
String transitionToPrimaryStorageClass
Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.
String resourceId
Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.
Integer maxResults
(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.
String nextToken
(Optional) You can use NextToken in a subsequent request to fetch the next page of access point
descriptions if the response payload was paginated.
SdkInternalList<T> tags
An array of the tags for the specified EFS resource.
String nextToken
NextToken is present if the response payload is paginated. You can use NextToken in a
subsequent request to fetch the next page of access point descriptions.
String mountTargetId
The ID of the mount target whose security groups you want to modify.
SdkInternalList<T> securityGroups
An array of up to five VPC security group IDs.
String errorCode
String ownerId
Amazon Web Services account ID that owns the resource.
String mountTargetId
System-assigned mount target ID.
String fileSystemId
The ID of the file system for which the mount target is intended.
String subnetId
The ID of the mount target's subnet.
String lifeCycleState
Lifecycle state of the mount target.
String ipAddress
Address at which the file system can be mounted by using the mount target.
String networkInterfaceId
The ID of the network interface that Amazon EFS created when it created the mount target.
String availabilityZoneId
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 Amazon Web
Services account.
String availabilityZoneName
The name of the Availability Zone in which the mount target is located. Availability Zones are independently
mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a
for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon
Web Services account.
String vpcId
The virtual private cloud (VPC) ID that the mount target is configured in.
String errorCode
String errorCode
String errorCode
String errorCode
Long uid
The POSIX user ID used for all file system operations using this access point.
Long gid
The POSIX group ID used for all file system operations using this access point.
SdkInternalList<T> secondaryGids
Secondary POSIX group IDs used for all file system operations using this access point.
String resourceIdType
Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon
Web Services Region, either LONG_ID (17 characters), or SHORT_ID (8 characters).
Starting in October, 2021, you will receive an error when setting the account preference to SHORT_ID
. Contact Amazon Web Services support if you receive an error and must use short IDs for file system and mount
target resources.
ResourceIdPreference resourceIdPreference
String fileSystemId
Specifies which EFS file system to update the backup policy for.
BackupPolicy backupPolicy
The backup policy included in the PutBackupPolicy request.
BackupPolicy backupPolicy
Describes the file system's backup policy, indicating whether automatic backups are turned on or off.
String fileSystemId
The ID of the EFS file system that you want to create or update the FileSystemPolicy for.
String policy
The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. EFS file
system policies have a 20,000 character limit. To find out more about the elements that make up a file system
policy, see EFS Resource-based Policies.
Boolean bypassPolicyLockoutSafetyCheck
(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety
check. 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.
String fileSystemId
The ID of the file system for which you are creating the LifecycleConfiguration object (String).
SdkInternalList<T> lifecyclePolicies
An array of LifecyclePolicy objects that define the file system's
LifecycleConfiguration object. A LifecycleConfiguration object informs EFS lifecycle
management and EFS Intelligent-Tiering of the following:
When to move files in the file system from primary storage to the IA storage class.
When to move files that are in IA storage to primary storage.
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, TransitionToIA,
TransitionToPrimaryStorageClass. See the example requests in the following section for more
information.
SdkInternalList<T> lifecyclePolicies
An array of lifecycle management policies. EFS supports a maximum of one policy per file system.
String sourceFileSystemId
The ID of the source Amazon EFS file system that is being replicated.
String sourceFileSystemRegion
The Amazon Web Services Region in which the source Amazon EFS file system is located.
String sourceFileSystemArn
The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
String originalSourceFileSystemArn
The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
Date creationTime
Describes when the replication configuration was created.
SdkInternalList<T> destinations
An array of destination objects. Only one destination object is supported.
String errorCode
ReplicationNotFound
String resourceIdType
Identifies the EFS resource ID preference, either LONG_ID (17 characters) or SHORT_ID
(8 characters).
SdkInternalList<T> resources
Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and
MOUNT_TARGET.
String path
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.
CreationInfo creationInfo
(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.
String errorCode
String errorCode
String errorCode
String resourceId
The ID specifying the EFS resource that you want to create a tag for.
SdkInternalList<T> tags
An array of Tag objects to add. Each Tag object is a key-value pair.
String errorCode
String errorCode
String errorCode
String errorCode
String resourceId
Specifies the EFS resource that you want to remove tags from.
SdkInternalList<T> tagKeys
The keys of the key-value tag pairs that you want to remove from the specified EFS resource.
String fileSystemId
The ID of the file system that you want to update.
String throughputMode
(Optional) Updates the file system's throughput mode. If you're not updating your throughput mode, you don't need
to provide this value in your request. If you are changing the ThroughputMode to
provisioned, you must also set a value for ProvisionedThroughputInMibps.
Double provisionedThroughputInMibps
(Optional) Sets the amount of provisioned throughput, in MiB/s, for the file system. Valid values are 1-1024. If
you are changing the throughput mode to provisioned, you must also provide the amount of provisioned throughput.
Required if ThroughputMode is changed to provisioned on update.
String ownerId
The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
String creationToken
The opaque string specified in the request.
String fileSystemId
The ID of the file system, assigned by Amazon EFS.
String fileSystemArn
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
Date creationTime
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
String lifeCycleState
The lifecycle phase of the file system.
String name
You can add tags to a file system, including a Name tag. For more information, see
CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this
field.
Integer numberOfMountTargets
The current number of mount targets that the file system has. For more information, see CreateMountTarget.
FileSystemSize sizeInBytes
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.
String performanceMode
The performance mode of the file system.
Boolean encrypted
A Boolean value that, if true, indicates that the file system is encrypted.
String kmsKeyId
The ID of an KMS key used to protect the encrypted file system.
String throughputMode
Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.
Double provisionedThroughputInMibps
The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using
ThroughputMode set to provisioned.
String availabilityZoneName
Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.
String availabilityZoneId
The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes
exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services
Region, and it has the same location in every Amazon Web Services account.
SdkInternalList<T> tags
The tags associated with the file system, presented as an array of Tag objects.
String errorCode
Copyright © 2022. All rights reserved.