String errorCode
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.
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 CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS
KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS,
/aws/elasticfilesystem, is used to protect the encrypted file system.
String kmsKeyId
The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of 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 KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to
true.
String throughputMode
The throughput mode for the file system to be created. There are two throughput modes to choose from for your
file system: bursting and provisioned. If you set ThroughputMode to
provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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, see Specifying Throughput
with Provisioned Mode in the Amazon EFS User Guide.
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. You can get this limit increased by contacting AWS Support. For more information,
see Amazon EFS Limits That You Can
Increase in the Amazon EFS User Guide.
SdkInternalList<T> tags
A value that specifies 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.
String ownerId
The AWS 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.
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 AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
String throughputMode
The throughput mode for a file system. There are two throughput modes to choose from for your file system:
bursting and provisioned. If you set ThroughputMode to
provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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.
Double provisionedThroughputInMibps
The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024.
Required if ThroughputMode is set to provisioned. The limit on throughput is 1024
MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can
Increase in the Amazon EFS User Guide.
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.
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
AWS 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 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.
String fileSystemId
The ID of the file system you want to delete.
String mountTargetId
The ID of the mount target to delete (String).
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 maxItems
(Optional) Specifies the maximum number of file systems to return in the response (integer). Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 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. Currently, 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 10 per page if you have more than 10 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 MountTargetId is not included.
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.
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.
Integer maxItems
(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 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 ownerId
The AWS 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.
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 AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
String throughputMode
The throughput mode for a file system. There are two throughput modes to choose from for your file system:
bursting and provisioned. If you set ThroughputMode to
provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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.
Double provisionedThroughputInMibps
The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024.
Required if ThroughputMode is set to provisioned. The limit on throughput is 1024
MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can
Increase in the Amazon EFS User Guide.
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 transitionToIA
A value that describes the period of time that a file is not accessed, after which it transitions to the IA storage class. Metadata operations such as listing the contents of a directory don't count as file access events.
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
AWS 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 errorCode
String errorCode
String errorCode
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 tells lifecycle
management when to transition files from the Standard storage class to the Infrequent Access storage class.
SdkInternalList<T> lifecyclePolicies
An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system.
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String errorCode
String fileSystemId
The ID of the file system that you want to update.
String throughputMode
(Optional) The throughput mode that you want your file system to use. 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) The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are
1-1024. Required if ThroughputMode is changed to provisioned on update. If you're not
updating the amount of provisioned throughput for your file system, you don't need to provide this value in your
request.
String ownerId
The AWS 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.
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 AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
String throughputMode
The throughput mode for a file system. There are two throughput modes to choose from for your file system:
bursting and provisioned. If you set ThroughputMode to
provisioned, you must also set a value for ProvisionedThroughPutInMibps. 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.
Double provisionedThroughputInMibps
The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024.
Required if ThroughputMode is set to provisioned. The limit on throughput is 1024
MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can
Increase in the Amazon EFS User Guide.
SdkInternalList<T> tags
The tags associated with the file system, presented as an array of Tag objects.
Copyright © 2019. All rights reserved.