diff --git a/clients/client-efs/src/commands/CreateAccessPointCommand.ts b/clients/client-efs/src/commands/CreateAccessPointCommand.ts index e176bcafdae7..9e6cd698d2b3 100644 --- a/clients/client-efs/src/commands/CreateAccessPointCommand.ts +++ b/clients/client-efs/src/commands/CreateAccessPointCommand.ts @@ -37,13 +37,14 @@ export interface CreateAccessPointCommandOutput extends AccessPointDescription, /** * @public - *
Creates an EFS access point. An access point is an application-specific view into an EFS - * file system that applies an operating system user and group, and a file system path, to any - * file system request made through the access point. The operating system user and group - * override any identity information provided by the NFS client. The file system path is exposed - * as the access point's root directory. Applications using the access point can only access data in - * the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access - * points.
+ *Creates an EFS access point. An access point is an application-specific view + * into an EFS file system that applies an operating system user and group, and a file + * system path, to any file system request made through the access point. The operating system + * user and group override any identity information provided by the NFS client. The file system + * path is exposed as the access point's root directory. Applications using the access point can + * only access data in the application's own directory and any subdirectories. To learn more, see + * Mounting a file + * system using EFS access points.
*If multiple requests to create access points on the same file system are sent in quick * succession, and the file system is near the limit of 1,000 access points, you may experience diff --git a/clients/client-efs/src/commands/CreateFileSystemCommand.ts b/clients/client-efs/src/commands/CreateFileSystemCommand.ts index 9aa38016ae2c..0ae400281b56 100644 --- a/clients/client-efs/src/commands/CreateFileSystemCommand.ts +++ b/clients/client-efs/src/commands/CreateFileSystemCommand.ts @@ -57,7 +57,7 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __ *
For basic use cases, you can use a randomly generated UUID for the creation * token.
* The idempotent operation allows you to retry a CreateFileSystem
call without
+ *
The idempotent operation allows you to retry a CreateFileSystem
call without
* risk of creating an extra file system. This can happen when an initial call fails in a way
* that leaves it uncertain whether or not a file system was actually created. An example might
* be that a transport level timeout occurred or your connection was reset. As long as you use
@@ -72,11 +72,15 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __
* calling the DescribeFileSystems operation, which among other things returns the file
* system state.
This operation accepts an optional PerformanceMode
parameter that you
- * choose for your 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
+ *
This operation accepts an optional PerformanceMode
parameter that you choose
+ * for your file system. We recommend generalPurpose
performance mode for all file
+ * systems. File systems using the maxIO
mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies
+ * than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or
+ * file systems that use Elastic throughput.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
+ *The performance mode can't be changed after * the file system has been created. For more information, see Amazon EFS performance * modes.
*You can set the throughput mode for the file system using the ThroughputMode
parameter.
You can create only one mount target for an EFS file system using One Zone storage
- * classes. You must create that mount target in the same Availability Zone in which the file
- * system is located. Use the AvailabilityZoneName
and
- * AvailabiltyZoneId
properties in the DescribeFileSystems
- * response object to get this information. Use the subnetId
associated with the
- * file system's Availability Zone when creating the mount target.
You can create only one mount target for a One Zone file system.
+ * You must create that mount target in the same Availability Zone in which the file system is
+ * located. Use the AvailabilityZoneName
and AvailabiltyZoneId
+ * properties in the DescribeFileSystems response object to get this
+ * information. Use the subnetId
associated with the file system's Availability Zone
+ * when creating the mount target.
For more information, see Amazon EFS: How it Works.
*To create a mount target for a file system, the file system's lifecycle state must be
* available
. For more information, see DescribeFileSystems.
Creates a replication configuration that replicates an existing EFS file system to a new, - * read-only file system. For more information, see Amazon EFS replication in the + *
Creates a replication configuration that replicates an existing EFS file system + * to a new, read-only file system. For more information, see Amazon EFS replication in the * Amazon EFS User Guide. The replication configuration * specifies the following:
** Availability Zone - If you want the destination file system - * to use EFS One Zone availability and durability, you must specify the Availability - * Zone to create the file system in. For more information about EFS storage classes, see - * + * to use EFS One Zone availability, you must specify the Availability Zone to create the + * file system in. For more information about EFS storage classes, see * Amazon EFS storage classes in the Amazon EFS User * Guide.
*- * Lifecycle management - EFS lifecycle management and EFS - * Intelligent-Tiering are not enabled on the destination file system. After the destination - * file system is created, you can enable EFS lifecycle management and EFS - * Intelligent-Tiering.
+ * Lifecycle management – Lifecycle management is not enabled + * on the destination file system. After the destination file system is created, you can + * enable it. *- * Automatic backups - Automatic daily backups are enabled on + * Automatic backups – Automatic daily backups are enabled on * the destination file system. After the file system is created, you can change this * setting.
*Returns the description of a specific Amazon EFS access point if the AccessPointId
is provided.
- * If you provide an EFS FileSystemId
, it returns descriptions of all access points for that file system.
- * You can provide either an AccessPointId
or a FileSystemId
in the request, but not both.
Returns the description of a specific Amazon EFS access point if the
+ * AccessPointId
is provided. If you provide an EFS
+ * FileSystemId
, it returns descriptions of all access points for that file
+ * system. You can provide either an AccessPointId
or a FileSystemId
in
+ * the request, but not both.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
Returns the FileSystemPolicy
for the specified EFS file system.
Returns the FileSystemPolicy
for the specified EFS file
+ * system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy
action.
Returns the current LifecycleConfiguration
object for the specified Amazon
- * EFS file system. EFS lifecycle management uses the LifecycleConfiguration
object
- * to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system
- * without a LifecycleConfiguration
object, the call returns an empty array in the
+ * EFS file system. Llifecycle management uses the LifecycleConfiguration
object to
+ * identify when to move files between storage classes. For a file system without a
+ * LifecycleConfiguration
object, the call returns an empty array in the
* response.
When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass
has
- * a value of AFTER_1_ACCESS
.
This operation requires permissions for the
* elasticfilesystem:DescribeLifecycleConfiguration
operation.
Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.
+ *Lists all tags for a top-level EFS resource. You must provide the ID of the + * resource that you want to retrieve the tags for.
*This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
Use this operation to set the account preference in the current Amazon Web Services Region - * to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for - * new EFS file system and mount target resources. All existing resource IDs are not affected - * by any changes you make. You can set the ID preference during the - * opt-in period as EFS transitions to long resource IDs. For more information, - * see Managing Amazon EFS resource IDs.
+ * to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new + * EFS file system and mount target resources. All existing resource IDs are not + * affected by any changes you make. You can set the ID preference during the opt-in period as + * EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs. *Starting in October, 2021, you will receive an error if you try to set the account preference * to use the short 8 character format resource ID. Contact Amazon Web Services support if you diff --git a/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts b/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts index 997a09ed12b7..8a925eee17ea 100644 --- a/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts +++ b/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts @@ -37,14 +37,14 @@ export interface PutFileSystemPolicyCommandOutput extends FileSystemPolicyDescri /** * @public - *
Applies an Amazon EFS FileSystemPolicy
to an Amazon EFS file system.
- * A file system policy is an IAM resource-based policy and can contain multiple policy statements.
- * A file system always has exactly one file system policy, which can be the default policy or
- * an explicit policy set or updated using this API operation.
- * EFS file system policies have a 20,000 character limit.
- * When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see
- * Default EFS File System Policy.
- *
Applies an Amazon EFS
+ * FileSystemPolicy
to an Amazon EFS file system. A file system policy is an
+ * IAM resource-based policy and can contain multiple policy statements. A file system always has
+ * exactly one file system policy, which can be the default policy or an explicit policy set or
+ * updated using this API operation. EFS file system policies have a 20,000 character
+ * limit. When an explicit policy is set, it overrides the default policy. For more information
+ * about the default file system policy, see Default EFS
+ * File System Policy.
EFS file system policies have a 20,000 character limit.
*Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A + *
Use this action to manage storage of your file system. A
* LifecycleConfiguration
consists of one or more LifecyclePolicy
* objects that define the following:
- * EFS Lifecycle management - When Amazon EFS - * automatically transitions files in a file system into the lower-cost EFS Infrequent Access - * (IA) storage class.
- *To enable EFS Lifecycle management, set the value of TransitionToIA
to one of the available options.
TransitionToIA
+ * –
+ * When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access
+ * (IA) storage.
* - * EFS Intelligent-Tiering - When Amazon EFS - * automatically transitions files from IA back into the file system's primary storage class - * (EFS Standard or EFS One Zone Standard).
- *To enable EFS Intelligent-Tiering, set the value of
- * TransitionToPrimaryStorageClass
to AFTER_1_ACCESS
.
TransitionToArchive
+ * –
+ * When to move files in the file system from their current storage class (either IA or Standard storage) into the
+ * Archive storage.
+ * File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, + * TransitionToArchive must either not be set or must be later than TransitionToIA.
+ *The Archive storage class is available only for file systems that use the Elastic Throughput mode + * and the General Purpose Performance mode.
+ *
+ *
+ * TransitionToPrimaryStorageClass
+ * –
+ * Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA
+ * or Archive storage.
For more information, see EFS Lifecycle Management.
+ *For more information, see + * Managing file system storage.
*Each Amazon EFS file system supports one lifecycle configuration, which applies to
* all files in the file system. If a LifecycleConfiguration
object already exists
* for the specified file system, a PutLifecycleConfiguration
call modifies the
* existing configuration. A PutLifecycleConfiguration
call with an empty
* LifecyclePolicies
array in the request body deletes any existing
- * LifecycleConfiguration
and turns off lifecycle management and EFS
- * Intelligent-Tiering for the file system.
LifecycleConfiguration
for the file system.
* In the request, specify the following:
*The ID for the file system for which you are enabling, disabling, or modifying - * lifecycle management and EFS Intelligent-Tiering.
+ * Lifecycle management. *A LifecyclePolicies
array of LifecyclePolicy
objects that
- * define when files are moved into IA storage, and when they are moved back to Standard storage.
Amazon EFS requires that each LifecyclePolicy
* object have only have a single transition, so the LifecyclePolicies
array needs to be structured with separate
@@ -94,8 +110,9 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu
* FileSystemId: "STRING_VALUE", // required
* LifecyclePolicies: [ // LifecyclePolicies // required
* { // LifecyclePolicy
- * TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY",
+ * TransitionToIA: "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",
* TransitionToPrimaryStorageClass: "AFTER_1_ACCESS",
+ * TransitionToArchive: "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",
* },
* ],
* };
@@ -104,8 +121,9 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu
* // { // LifecycleConfigurationDescription
* // LifecyclePolicies: [ // LifecyclePolicies
* // { // LifecyclePolicy
- * // TransitionToIA: "AFTER_7_DAYS" || "AFTER_14_DAYS" || "AFTER_30_DAYS" || "AFTER_60_DAYS" || "AFTER_90_DAYS" || "AFTER_1_DAY",
+ * // TransitionToIA: "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",
* // TransitionToPrimaryStorageClass: "AFTER_1_ACCESS",
+ * // TransitionToArchive: "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",
* // },
* // ],
* // };
diff --git a/clients/client-efs/src/commands/TagResourceCommand.ts b/clients/client-efs/src/commands/TagResourceCommand.ts
index 87a80c093085..8fa99ab62859 100644
--- a/clients/client-efs/src/commands/TagResourceCommand.ts
+++ b/clients/client-efs/src/commands/TagResourceCommand.ts
@@ -37,7 +37,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {}
/**
* @public
- *
Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.
+ *Creates a tag for an EFS resource. You can create tags for EFS file + * systems and access points using this API operation.
*This operation requires permissions for the elasticfilesystem:TagResource
action.
Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.
+ *Removes tags from an EFS resource. You can remove tags from EFS file + * systems and access points using this API operation.
*This operation requires permissions for the elasticfilesystem:UntagResource
action.
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
.
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
.
(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.
- *
(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.
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
+ *The directory on the EFS file system that the access point exposes as the root + * directory to NFS clients using the access point.
*/ RootDirectory?: RootDirectory; @@ -388,26 +390,29 @@ export interface BackupPolicy { *
*
* 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.
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
.
Specifies the directory on the 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, Amazon 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.
@@ -710,14 +714,15 @@ export interface CreateFileSystemRequest { /** * @public - *The performance mode of the file system. We recommend generalPurpose
- * performance mode for most file systems. File systems using the maxIO
performance
+ *
The Performance mode of the file system. We recommend generalPurpose
+ * performance mode for all 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.
maxIO
mode is
+ * not supported on One Zone file systems.
+ * Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
+ *Default is generalPurpose
.
provisioned
, or elastic
. If you set ThroughputMode
to
* provisioned
, you must also set a value for
* ProvisionedThroughputInMibps
. After you create the file system, you can
- * decrease your file system's throughput in Provisioned Throughput mode or change between
- * the throughput modes, with certain time restrictions. For more information, see Specifying
+ * decrease your file system's Provisioned throughput or change between the
+ * throughput modes, with certain time restrictions. For more information, see Specifying
* throughput with provisioned mode in the Amazon EFS User
* Guide.
* Default is bursting
.
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.
Used to create a One Zone file system. 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 file systems, 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.
+ *One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
*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
+ * Set the value to true
to enable automatic backups. If you are creating a
+ * One Zone file system, 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
.
The latest known metered size (in bytes) of data stored in the Infrequent Access - * storage class.
+ *The latest known metered size (in bytes) of data stored in the Infrequent Access storage + * class.
*/ ValueInIA?: number; /** * @public - *The latest known metered size (in bytes) of data stored in the Standard storage - * class.
+ *The latest known metered size (in bytes) of data stored in the Standard + * storage class.
*/ ValueInStandard?: number; + + /** + * @public + *The latest known metered size (in bytes) of data stored in the Archive + * storage class.
+ */ + ValueInArchive?: number; } /** @@ -935,9 +947,10 @@ export interface FileSystemDescription { /** * @public *The Amazon Resource Name (ARN) for the EFS file system, in the format
- * arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id
+ *
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
+ * Example with sample data:
+ * arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
*
The performance mode of the file system.
+ *The Performance mode of the file system.
*/ PerformanceMode: PerformanceMode | undefined; @@ -1019,17 +1032,18 @@ export interface FileSystemDescription { /** * @public - *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.
+ *Describes the Amazon Web Services 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 in the Amazon EFS User Guide.
*/ AvailabilityZoneName?: string; /** * @public - *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.
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 Amazon Web Services Region, and
+ * it has the same location in every Amazon Web Services account.
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.
+ *The ID of the subnet to add the mount target in. For One Zone file systems, use the + * subnet that is associated with the file system's Availability Zone.
*/ SubnetId: string | undefined; @@ -1585,14 +1599,13 @@ export class SubnetNotFound extends __BaseException { export interface DestinationToCreate { /** * @public - *To create a file system that uses Regional storage, specify the Amazon Web Services Region - * in which to create the destination file system.
+ *To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.
*/ Region?: string; /** * @public - *To create a file system that uses EFS One Zone storage, specify the name of the + *
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.
*/ AvailabilityZoneName?: string; @@ -1667,7 +1680,7 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat export interface Destination { /** * @public - *Describes the status of the destination Amazon EFS file system.
+ *Describes the status of the destination EFS file system.
*The Paused
state occurs as a result of opting out of the source or
@@ -1723,7 +1736,8 @@ export interface ReplicationConfigurationDescription {
/**
* @public
- *
The Amazon Web Services Region in which the source Amazon EFS file system is located.
+ *The Amazon Web Services Region in which the source EFS file system is + * located.
*/ SourceFileSystemRegion: string | undefined; @@ -1736,7 +1750,8 @@ export interface ReplicationConfigurationDescription { /** * @public - *The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
+ *The Amazon Resource Name (ARN) of the original source EFS file system in the + * replication configuration.
*/ OriginalSourceFileSystemArn: string | undefined; @@ -1916,7 +1931,8 @@ export class FileSystemInUse extends __BaseException { export interface DeleteFileSystemPolicyRequest { /** * @public - *Specifies the EFS file system for which to delete the FileSystemPolicy
.
Specifies the EFS file system for which to delete the
+ * FileSystemPolicy
.
(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId
.
(Optional) Specifies an EFS access point to describe in the response; mutually
+ * exclusive with FileSystemId
.
(Optional) If you provide a FileSystemId
, EFS returns all access points for that file system; mutually exclusive with AccessPointId
.
(Optional) If you provide a FileSystemId
, EFS returns all access
+ * points for that file system; mutually exclusive with AccessPointId
.
Identifies the EFS resource ID preference, either LONG_ID
(17 characters) or SHORT_ID
(8 characters).
Identifies the EFS resource ID preference, either LONG_ID
(17
+ * characters) or SHORT_ID
(8 characters).
Specifies which EFS file system to retrieve the BackupPolicy
for.
Specifies which EFS file system for which to retrieve the
+ * BackupPolicy
.
Specifies which EFS file system to retrieve the FileSystemPolicy
for.
Specifies which EFS file system to retrieve the FileSystemPolicy
+ * for.
Specifies the EFS file system to which the FileSystemPolicy
applies.
Specifies the EFS file system to which the FileSystemPolicy
+ * applies.
The JSON formatted FileSystemPolicy
for the EFS file system.
The JSON formatted FileSystemPolicy
for the EFS file
+ * system.
Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that - * specifies when to transition files into and out of the file system's Infrequent Access (IA) - * storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle - * Management.
+ *Describes a policy used by Lifecycle management that specifies when to transition files + * into and out of the Infrequent Access (IA) and Archive storage + * classes. For more information, see Managing file system 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
. For more
+ * LifecyclePolicy
objects, one object for each transition. For more
* information, see the request examples in PutLifecycleConfiguration.
- * 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.
+ *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.
*/ TransitionToIA?: TransitionToIARules; /** * @public - *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.
+ *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.
*/ TransitionToPrimaryStorageClass?: TransitionToPrimaryStorageClassRules; + + /** + * @public + *The number of days after files were last accessed in primary storage (the + * Standard storage class) files 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.
+ */ + TransitionToArchive?: TransitionToArchiveRules; } /** @@ -2684,7 +2738,8 @@ export class InvalidPolicyException extends __BaseException { export interface ListTagsForResourceRequest { /** * @public - *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.
+ *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.
*/ ResourceId: string | undefined; @@ -2743,9 +2798,8 @@ export interface ModifyMountTargetSecurityGroupsRequest { export interface PutAccountPreferencesRequest { /** * @public - *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).
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
@@ -2789,17 +2843,16 @@ export interface PutBackupPolicyRequest {
export interface PutFileSystemPolicyRequest {
/**
* @public
- *
The ID of the EFS file system that you want to create or update the FileSystemPolicy
for.
The ID of the EFS file system that you want to create or update the
+ * FileSystemPolicy
for.
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.
- *
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.
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.
+ *
+ *
+ * TransitionToIA
+ * –
+ * When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access
+ * (IA) storage.
When to move files that are in IA storage to primary storage.
+ *
+ *
+ * TransitionToArchive
+ * –
+ * When to move files in the file system from their current storage class (either IA or Standard storage) into the
+ * Archive storage.
File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, + * TransitionToArchive must either not be set or must be later than TransitionToIA.
+ *The Archive storage class is available only for file systems that use the Elastic Throughput mode + * and the General Purpose Performance mode.
+ *
+ *
+ * TransitionToPrimaryStorageClass
+ * – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA
+ * or Archive storage.
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
+ * LifecyclePolicy
objects, one object for each storage transition. See the example
* requests in the following section for more information.
* The keys of the key-value tag pairs that you want to remove from the specified EFS - * resource.
+ *The keys of the key-value tag pairs that you want to remove from the specified + * EFS resource.
*/ TagKeys: string[] | undefined; } diff --git a/clients/client-efs/src/pagination/DescribeMountTargetsPaginator.ts b/clients/client-efs/src/pagination/DescribeMountTargetsPaginator.ts new file mode 100644 index 000000000000..ac63f7f81b1d --- /dev/null +++ b/clients/client-efs/src/pagination/DescribeMountTargetsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + DescribeMountTargetsCommand, + DescribeMountTargetsCommandInput, + DescribeMountTargetsCommandOutput, +} from "../commands/DescribeMountTargetsCommand"; +import { EFSClient } from "../EFSClient"; +import { EFSPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: EFSClient, + input: DescribeMountTargetsCommandInput, + ...args: any +): PromiseThe directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
" + "smithy.api#documentation": "The directory on the EFS file system that the access point exposes as the root\n directory to NFS clients using the access point.
" } }, "OwnerId": { @@ -234,7 +234,7 @@ "Status": { "target": "com.amazonaws.efs#Status", "traits": { - "smithy.api#documentation": "Describes the status of the file system's backup policy.
\n\n \n ENABLED
\n - EFS is automatically backing up the file system.
\n \n ENABLING
\n - EFS is turning on automatic backups for the file system.
\n \n DISABLED
\n - Automatic back ups are turned off for\n the file system.
\n \n DISABLING
\n - EFS is turning off automatic backups for the file system.
Describes the status of the file system's backup policy.
\n\n \n ENABLED
\n – EFS is automatically\n backing up the file system.
\n \n ENABLING
\n – EFS is turning on\n automatic backups for the file system.
\n \n DISABLED
\n – Automatic back ups are turned\n off for the file system.
\n \n DISABLING
\n – EFS is turning off\n automatic backups for the file system.
Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.
\nIf multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1,000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.
\nThis operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
Access points can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource
action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource
action. For more\n information, see Granting\n permissions to tag resources during creation.
Creates an EFS access point. An access point is an application-specific view\n into an EFS file system that applies an operating system user and group, and a file\n system path, to any file system request made through the access point. The operating system\n user and group override any identity information provided by the NFS client. The file system\n path is exposed as the access point's root directory. Applications using the access point can\n only access data in the application's own directory and any subdirectories. To learn more, see\n Mounting a file\n system using EFS access points.
\nIf multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1,000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.
\nThis operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
Access points can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource
action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource
action. For more\n information, see Granting\n permissions to tag resources during creation.
Specifies the directory on the Amazon EFS file system that the access point\n exposes as the root directory of your file system to NFS clients using the access point. The\n clients using the access point can only access the root directory and below. If the\n RootDirectory
> Path
specified does not exist, EFS creates it\n and applies the CreationInfo
settings when a client connects to an access point.\n When specifying a RootDirectory
, you must provide the Path
, and the\n CreationInfo
.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. \n 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 \n using the access point will fail.
" + "smithy.api#documentation": "Specifies the directory on the EFS file system that the access point exposes as\n the root directory of your file system to NFS clients using the access point. The clients\n using the access point can only access the root directory and below. If the\n RootDirectory
> Path
specified does not exist, Amazon EFS creates it and applies the CreationInfo
settings when a client connects to an\n access point. When specifying a RootDirectory
, you must provide the\n Path
, and the CreationInfo
.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. \n 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 \n using the access point will fail.
" } } }, @@ -402,7 +402,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:
\nCreates a new, empty file system. The file system will have an Amazon EFS assigned\n ID, and an initial lifecycle state creating
.
Returns with the description of the created file system.
\nOtherwise, this operation returns a FileSystemAlreadyExists
error with the\n ID of the existing file system.
For basic use cases, you can use a randomly generated UUID for the creation\n token.
\n The idempotent operation allows you to retry a CreateFileSystem
call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists
error.
For more information, see \n Creating a file system\n in the Amazon EFS User Guide.
\nThe CreateFileSystem
call returns while the file system's lifecycle\n state is still creating
. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.
This operation accepts an optional PerformanceMode
parameter that you\n choose for your file system. We recommend generalPurpose
performance mode for\n most file systems. File systems using the maxIO
performance mode can scale to\n higher levels of aggregate throughput and operations per second with a tradeoff of slightly\n higher latencies for most file operations. The performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.
You can set the throughput mode for the file system using the ThroughputMode
parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to\n available
, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the\n elasticfilesystem:CreateFileSystem
action.
File systems can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource
action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource
action. For more\n information, see Granting permissions to tag resources during creation.
Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:
\nCreates a new, empty file system. The file system will have an Amazon EFS assigned\n ID, and an initial lifecycle state creating
.
Returns with the description of the created file system.
\nOtherwise, this operation returns a FileSystemAlreadyExists
error with the\n ID of the existing file system.
For basic use cases, you can use a randomly generated UUID for the creation\n token.
\nThe idempotent operation allows you to retry a CreateFileSystem
call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists
error.
For more information, see \n Creating a file system\n in the Amazon EFS User Guide.
\nThe CreateFileSystem
call returns while the file system's lifecycle\n state is still creating
. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.
This operation accepts an optional PerformanceMode
parameter that you choose\n for your file system. We recommend generalPurpose
performance mode for all file\n systems. File systems using the maxIO
mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies\n than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or\n file systems that use Elastic throughput.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
\nThe performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.
\nYou can set the throughput mode for the file system using the ThroughputMode
parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to\n available
, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the\n elasticfilesystem:CreateFileSystem
action.
File systems can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource
action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource
action. For more\n information, see Granting permissions to tag resources during creation.
The performance mode of the file system. We recommend generalPurpose
\n performance mode for most file systems. File systems using the maxIO
performance\n mode can scale to higher levels of aggregate throughput and operations per second with a\n tradeoff of slightly higher latencies for most file operations. The performance mode\n 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.
Default is generalPurpose
.
The Performance mode of the file system. We recommend generalPurpose
\n performance mode for all file systems. File systems using the maxIO
performance\n mode can scale to higher levels of aggregate throughput and operations per second with a\n tradeoff of slightly higher latencies for most file operations. The performance mode\n can't be changed after the file system has been created. The maxIO
mode is\n not supported on One Zone file systems.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
\nDefault is generalPurpose
.
Specifies the throughput mode for the file system. The mode can be bursting
,\n provisioned
, or elastic
. If you set ThroughputMode
to\n provisioned
, you must also set a value for\n ProvisionedThroughputInMibps
. After you create the file system, you can\n decrease your file system's throughput in Provisioned Throughput mode or change between\n the throughput modes, with certain time restrictions. For more information, see Specifying\n throughput with provisioned mode in the Amazon EFS User\n Guide.
Default is bursting
.
Specifies the throughput mode for the file system. The mode can be bursting
,\n provisioned
, or elastic
. If you set ThroughputMode
to\n provisioned
, you must also set a value for\n ProvisionedThroughputInMibps
. After you create the file system, you can\n decrease your file system's Provisioned throughput or change between the\n throughput modes, with certain time restrictions. For more information, see Specifying\n throughput with provisioned mode in the Amazon EFS User\n Guide.
Default is bursting
.
Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services\n Availability Zone in which to create the file system. Use the format us-east-1a
\n to specify the Availability Zone. For\n 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\n Amazon EFS is available.
\nUsed to create a One Zone file system. It specifies the Amazon Web Services\n Availability Zone in which to create the file system. Use the format us-east-1a
to\n specify the Availability Zone. For more information about One Zone file systems, see\n Using EFS storage\n classes in the Amazon EFS User Guide.
One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
\nSpecifies whether automatic backups are enabled on the file system that you are creating.\n Set the value to true
to enable automatic backups. If you are creating a file\n system that uses One Zone storage classes, automatic backups are enabled by default. For more\n information, see Automatic backups in the\n Amazon EFS User Guide.
Default is false
. However, if you specify an AvailabilityZoneName
, \n the default is true
.
Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
\nSpecifies whether automatic backups are enabled on the file system that you are creating.\n Set the value to true
to enable automatic backups. If you are creating a\n One Zone file system, automatic backups are enabled by default. For more\n information, see Automatic backups in the\n Amazon EFS User Guide.
Default is false
. However, if you specify an AvailabilityZoneName
, \n the default is true
.
Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
\nCreates a mount target for a file system. You can then mount the file system on EC2\n instances by using the mount target.
\nYou can create one mount target in each Availability Zone in your VPC. All EC2\n instances in a VPC within a given Availability Zone share a single mount target for a given\n file system. If you have multiple subnets in an Availability Zone, you create a mount target\n in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target\n in order to access their file system.
\nYou can create only one mount target for an EFS file system using One Zone storage\n classes. You must create that mount target in the same Availability Zone in which the file\n system is located. Use the AvailabilityZoneName
and\n AvailabiltyZoneId
properties in the DescribeFileSystems\n response object to get this information. Use the subnetId
associated with the\n file system's Availability Zone when creating the mount target.
For more information, see Amazon EFS: How it Works.
\nTo create a mount target for a file system, the file system's lifecycle state must be\n available
. For more information, see DescribeFileSystems.
In the request, provide the following:
\nThe file system ID for which you are creating the mount\n target.
\nA subnet ID, which determines the following:
\nThe VPC in which Amazon EFS creates the mount target
\nThe Availability Zone in which Amazon EFS creates the mount target
\nThe IP address range from which Amazon EFS selects the IP address of the mount target\n (if you don't specify an IP address in the request)
\nAfter creating the mount target, Amazon EFS returns a response that includes, a\n MountTargetId
and an IpAddress
. You use this IP address when\n mounting the file system in an EC2 instance. You can also use the mount target's DNS name\n when mounting the file system. The EC2 instance on which you mount the file system by using\n the mount target can resolve the mount target's DNS name to its IP address. For more\n information, see How it Works:\n Implementation Overview.
Note that you can create mount targets for a file system in only one VPC, and there can\n be only one mount target per Availability Zone. That is, if the file system already has one or\n more mount targets created for it, the subnet specified in the request to add another mount\n target must meet the following requirements:
\nMust belong to the same VPC as the subnets of the existing mount targets
\nMust not be in the same Availability Zone as any of the subnets of the existing\n mount targets
\nIf the request satisfies the requirements, Amazon EFS does the following:
\nCreates a new mount target in the specified subnet.
\nAlso creates a new network interface in the subnet as follows:
\nIf the request provides an IpAddress
, Amazon EFS assigns that IP\n address to the network interface. Otherwise, Amazon EFS assigns a free address in the\n subnet (in the same way that the Amazon EC2 CreateNetworkInterface
call\n does when a request does not specify a primary private IP address).
If the request provides SecurityGroups
, this network interface is\n associated with those security groups. Otherwise, it belongs to the default security\n group for the subnet's VPC.
Assigns the description Mount target fsmt-id for\n file system fs-id\n
where \n fsmt-id\n
is the mount target ID, and \n fs-id\n
is the FileSystemId
.
Sets the requesterManaged
property of the network interface to\n true
, and the requesterId
value to\n EFS
.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network\n interface. After the network interface is created, Amazon EFS sets the\n NetworkInterfaceId
field in the mount target's description to the\n network interface ID, and the IpAddress
field to its address. If network\n interface creation fails, the entire CreateMountTarget
operation\n fails.
The CreateMountTarget
call returns only after creating the network\n interface, but while the mount target state is still creating
, you can check\n the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount\n target state.
We recommend that you create a mount target in each of the Availability Zones. There\n are cost considerations for using a file system in an Availability Zone through a mount target\n created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the\n instance's Availability Zone, you eliminate a partial failure scenario. If the\n Availability Zone in which your mount target is created goes down, then you can't access\n your file system through that mount target.
\nThis operation requires permissions for the following action on the file\n system:
\n\n elasticfilesystem:CreateMountTarget
\n
This operation also requires permissions for the following Amazon EC2\n actions:
\n\n ec2:DescribeSubnets
\n
\n ec2:DescribeNetworkInterfaces
\n
\n ec2:CreateNetworkInterface
\n
Creates a mount target for a file system. You can then mount the file system on EC2\n instances by using the mount target.
\nYou can create one mount target in each Availability Zone in your VPC. All EC2\n instances in a VPC within a given Availability Zone share a single mount target for a given\n file system. If you have multiple subnets in an Availability Zone, you create a mount target\n in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target\n in order to access their file system.
\nYou can create only one mount target for a One Zone file system.\n You must create that mount target in the same Availability Zone in which the file system is\n located. Use the AvailabilityZoneName
and AvailabiltyZoneId
\n properties in the DescribeFileSystems response object to get this\n information. Use the subnetId
associated with the file system's Availability Zone\n when creating the mount target.
For more information, see Amazon EFS: How it Works.
\nTo create a mount target for a file system, the file system's lifecycle state must be\n available
. For more information, see DescribeFileSystems.
In the request, provide the following:
\nThe file system ID for which you are creating the mount\n target.
\nA subnet ID, which determines the following:
\nThe VPC in which Amazon EFS creates the mount target
\nThe Availability Zone in which Amazon EFS creates the mount target
\nThe IP address range from which Amazon EFS selects the IP address of the mount target\n (if you don't specify an IP address in the request)
\nAfter creating the mount target, Amazon EFS returns a response that includes, a\n MountTargetId
and an IpAddress
. You use this IP address when\n mounting the file system in an EC2 instance. You can also use the mount target's DNS name\n when mounting the file system. The EC2 instance on which you mount the file system by using\n the mount target can resolve the mount target's DNS name to its IP address. For more\n information, see How it Works:\n Implementation Overview.
Note that you can create mount targets for a file system in only one VPC, and there can\n be only one mount target per Availability Zone. That is, if the file system already has one or\n more mount targets created for it, the subnet specified in the request to add another mount\n target must meet the following requirements:
\nMust belong to the same VPC as the subnets of the existing mount targets
\nMust not be in the same Availability Zone as any of the subnets of the existing\n mount targets
\nIf the request satisfies the requirements, Amazon EFS does the following:
\nCreates a new mount target in the specified subnet.
\nAlso creates a new network interface in the subnet as follows:
\nIf the request provides an IpAddress
, Amazon EFS assigns that IP\n address to the network interface. Otherwise, Amazon EFS assigns a free address in the\n subnet (in the same way that the Amazon EC2 CreateNetworkInterface
call\n does when a request does not specify a primary private IP address).
If the request provides SecurityGroups
, this network interface is\n associated with those security groups. Otherwise, it belongs to the default security\n group for the subnet's VPC.
Assigns the description Mount target fsmt-id for\n file system fs-id\n
where \n fsmt-id\n
is the mount target ID, and \n fs-id\n
is the FileSystemId
.
Sets the requesterManaged
property of the network interface to\n true
, and the requesterId
value to\n EFS
.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network\n interface. After the network interface is created, Amazon EFS sets the\n NetworkInterfaceId
field in the mount target's description to the\n network interface ID, and the IpAddress
field to its address. If network\n interface creation fails, the entire CreateMountTarget
operation\n fails.
The CreateMountTarget
call returns only after creating the network\n interface, but while the mount target state is still creating
, you can check\n the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount\n target state.
We recommend that you create a mount target in each of the Availability Zones. There\n are cost considerations for using a file system in an Availability Zone through a mount target\n created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the\n instance's Availability Zone, you eliminate a partial failure scenario. If the\n Availability Zone in which your mount target is created goes down, then you can't access\n your file system through that mount target.
\nThis operation requires permissions for the following action on the file\n system:
\n\n elasticfilesystem:CreateMountTarget
\n
This operation also requires permissions for the following Amazon EC2\n actions:
\n\n ec2:DescribeSubnets
\n
\n ec2:DescribeNetworkInterfaces
\n
\n ec2:CreateNetworkInterface
\n
The ID of the subnet to add the mount target in. For file systems that use One Zone storage classes, use the subnet \n that is associated with the file system's Availability Zone.
", + "smithy.api#documentation": "The ID of the subnet to add the mount target in. For One Zone file systems, use the\n subnet that is associated with the file system's Availability Zone.
", "smithy.api#required": {} } }, @@ -627,7 +627,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a replication configuration that replicates an existing EFS file system to a new,\n read-only file system. For more information, see Amazon EFS replication in the\n Amazon EFS User Guide. The replication configuration\n specifies the following:
\n\n Source file system - An existing EFS file system that you\n want replicated. The source file system cannot be a destination file system in an existing\n replication configuration.
\n\n Destination file system configuration - The configuration of\n the destination file system to which the source file system will be replicated. There can\n only be one destination file system in a replication configuration. The destination file\n system configuration consists of the following properties:
\n\n Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is\n available. To use EFS replication in a Region that is disabled by default, you must\n first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference\n Reference Guide\n
\n\n Availability Zone - If you want the destination file system\n to use EFS One Zone availability and durability, you must specify the Availability\n Zone to create the file system in. For more information about EFS storage classes, see\n \n Amazon EFS storage classes in the Amazon EFS User\n Guide.
\n\n Encryption - All destination file systems are created with\n encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't\n specify a KMS key, your service-managed KMS key for\n Amazon EFS is used.
\nAfter the file system is created, you cannot change the KMS key.
\nThe following properties are set by default:
\n\n Performance mode - The destination file system's performance\n mode matches that of the source file system, unless the destination file system uses EFS\n One Zone storage. In that case, the General Purpose performance mode is used. The\n performance mode cannot be changed.
\n\n Throughput mode - The destination file system's throughput\n mode matches that of the source file system. After the file system is created, you can modify the\n throughput mode.
\nThe following properties are turned off by default:
\n\n Lifecycle management - EFS lifecycle management and EFS\n Intelligent-Tiering are not enabled on the destination file system. After the destination\n file system is created, you can enable EFS lifecycle management and EFS\n Intelligent-Tiering.
\n\n Automatic backups - Automatic daily backups are enabled on\n the destination file system. After the file system is created, you can change this\n setting.
\nFor more information, see Amazon EFS replication in the\n Amazon EFS User Guide.
", + "smithy.api#documentation": "Creates a replication configuration that replicates an existing EFS file system\n to a new, read-only file system. For more information, see Amazon EFS replication in the\n Amazon EFS User Guide. The replication configuration\n specifies the following:
\n\n Source file system - An existing EFS file system that you\n want replicated. The source file system cannot be a destination file system in an existing\n replication configuration.
\n\n Destination file system configuration - The configuration of\n the destination file system to which the source file system will be replicated. There can\n only be one destination file system in a replication configuration. The destination file\n system configuration consists of the following properties:
\n\n Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is\n available. To use EFS replication in a Region that is disabled by default, you must\n first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference\n Reference Guide\n
\n\n Availability Zone - If you want the destination file system\n to use EFS One Zone availability, you must specify the Availability Zone to create the\n file system in. For more information about EFS storage classes, see \n Amazon EFS storage classes in the Amazon EFS User\n Guide.
\n\n Encryption - All destination file systems are created with\n encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't\n specify a KMS key, your service-managed KMS key for\n Amazon EFS is used.
\nAfter the file system is created, you cannot change the KMS key.
\nThe following properties are set by default:
\n\n Performance mode - The destination file system's performance\n mode matches that of the source file system, unless the destination file system uses EFS\n One Zone storage. In that case, the General Purpose performance mode is used. The\n performance mode cannot be changed.
\n\n Throughput mode - The destination file system's throughput\n mode matches that of the source file system. After the file system is created, you can modify the\n throughput mode.
\nThe following properties are turned off by default:
\n\n Lifecycle management – Lifecycle management is not enabled\n on the destination file system. After the destination file system is created, you can\n enable it.
\n\n Automatic backups – Automatic daily backups are enabled on\n the destination file system. After the file system is created, you can change this\n setting.
\nFor more information, see Amazon EFS replication in the\n Amazon EFS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration", @@ -888,7 +888,7 @@ "FileSystemId": { "target": "com.amazonaws.efs#FileSystemId", "traits": { - "smithy.api#documentation": "Specifies the EFS file system for which to delete the FileSystemPolicy
.
Specifies the EFS file system for which to delete the\n FileSystemPolicy
.
Returns the description of a specific Amazon EFS access point if the AccessPointId
is provided. \n If you provide an EFS FileSystemId
, it returns descriptions of all access points for that file system. \n You can provide either an AccessPointId
or a FileSystemId
in the request, but not both.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
Returns the description of a specific Amazon EFS access point if the\n AccessPointId
is provided. If you provide an EFS\n FileSystemId
, it returns descriptions of all access points for that file\n system. You can provide either an AccessPointId
or a FileSystemId
in\n the request, but not both.
This operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId
.
(Optional) Specifies an EFS access point to describe in the response; mutually\n exclusive with FileSystemId
.
(Optional) If you provide a FileSystemId
, EFS returns all access points for that file system; mutually exclusive with AccessPointId
.
(Optional) If you provide a FileSystemId
, EFS returns all access\n points for that file system; mutually exclusive with AccessPointId
.
Specifies which EFS file system to retrieve the BackupPolicy
for.
Specifies which EFS file system for which to retrieve the\n BackupPolicy
.
Returns the FileSystemPolicy
for the specified EFS file system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy
action.
Returns the FileSystemPolicy
for the specified EFS file\n system.
This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy
action.
Specifies which EFS file system to retrieve the FileSystemPolicy
for.
Specifies which EFS file system to retrieve the FileSystemPolicy
\n for.
Returns the current LifecycleConfiguration
object for the specified Amazon\n EFS file system. EFS lifecycle management uses the LifecycleConfiguration
object\n to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system\n without a LifecycleConfiguration
object, the call returns an empty array in the\n response.
When EFS Intelligent-Tiering is enabled, TransitionToPrimaryStorageClass
has\n a value of AFTER_1_ACCESS
.
This operation requires permissions for the\n elasticfilesystem:DescribeLifecycleConfiguration
operation.
Returns the current LifecycleConfiguration
object for the specified Amazon\n EFS file system. Llifecycle management uses the LifecycleConfiguration
object to\n identify when to move files between storage classes. For a file system without a\n LifecycleConfiguration
object, the call returns an empty array in the\n response.
This operation requires permissions for the\n elasticfilesystem:DescribeLifecycleConfiguration
operation.
Describes the status of the destination Amazon EFS file system.
\nThe Paused
state occurs as a result of opting out of the source or\n destination Region after the replication configuration was created. To resume replication\n for the file system, you need to again opt in to the Amazon Web Services Region. For more\n information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference\n Guide.
The Error
state occurs when either the source or the destination file\n system (or both) is in a failed state and is unrecoverable. For more information, see\n Monitoring\n replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then\n restore the most recent backup of the failed file system (either the source or the\n destination) to a new file system.
Describes the status of the destination EFS file system.
\nThe Paused
state occurs as a result of opting out of the source or\n destination Region after the replication configuration was created. To resume replication\n for the file system, you need to again opt in to the Amazon Web Services Region. For more\n information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference\n Guide.
The Error
state occurs when either the source or the destination file\n system (or both) is in a failed state and is unrecoverable. For more information, see\n Monitoring\n replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then\n restore the most recent backup of the failed file system (either the source or the\n destination) to a new file system.
To create a file system that uses Regional storage, specify the Amazon Web Services Region\n in which to create the destination file system.
" + "smithy.api#documentation": "To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.
" } }, "AvailabilityZoneName": { "target": "com.amazonaws.efs#AvailabilityZoneName", "traits": { - "smithy.api#documentation": "To create a file system that uses EFS One Zone storage, specify the name of the\n Availability Zone in which to create the destination file system.
" + "smithy.api#documentation": "To create a file system that uses One Zone storage, specify the name of the\n Availability Zone in which to create the destination file system.
" } }, "KmsKeyId": { @@ -2053,7 +2068,7 @@ "FileSystemArn": { "target": "com.amazonaws.efs#FileSystemArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the EFS file system, in the format \n arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id\n
. \n Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
\n
The Amazon Resource Name (ARN) for the EFS file system, in the format\n arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id\n
.\n Example with sample data:\n arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
\n
The performance mode of the file system.
", + "smithy.api#documentation": "The Performance mode of the file system.
", "smithy.api#required": {} } }, @@ -2125,13 +2140,13 @@ "AvailabilityZoneName": { "target": "com.amazonaws.efs#AvailabilityZoneName", "traits": { - "smithy.api#documentation": "Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only\n for file systems using One Zone storage classes. For more information, see Using EFS storage classes \n in the Amazon EFS User Guide.
" + "smithy.api#documentation": "Describes the Amazon Web Services Availability Zone in which the file system is located, and is\n valid only for One Zone file systems. For more information, see Using EFS storage\n classes in the Amazon EFS User Guide.
" } }, "AvailabilityZoneId": { "target": "com.amazonaws.efs#AvailabilityZoneId", "traits": { - "smithy.api#documentation": "The unique and consistent identifier of the Availability Zone in which the file system's\n One Zone storage classes exist. For example, use1-az1
is an Availability Zone ID\n for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.
The unique and consistent identifier of the Availability Zone in which the file system is\n located, and is valid only for One Zone file systems. For example,\n use1-az1
is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and\n it has the same location in every Amazon Web Services account.
Specifies the EFS file system to which the FileSystemPolicy
applies.
Specifies the EFS file system to which the FileSystemPolicy
\n applies.
The JSON formatted FileSystemPolicy
for the EFS file system.
The JSON formatted FileSystemPolicy
for the EFS file\n system.
The latest known metered size (in bytes) of data stored in the Infrequent Access\n storage class.
" + "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the Infrequent Access storage\n class.
" } }, "ValueInStandard": { "target": "com.amazonaws.efs#FileSystemNullableSizeValue", "traits": { - "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the Standard storage\n class.
" + "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the Standard\n storage class.
" + } + }, + "ValueInArchive": { + "target": "com.amazonaws.efs#FileSystemNullableSizeValue", + "traits": { + "smithy.api#documentation": "The latest known metered size (in bytes) of data stored in the Archive\n storage class.
" } } }, @@ -2487,7 +2508,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 2 + "max": 3 } } }, @@ -2497,18 +2518,24 @@ "TransitionToIA": { "target": "com.amazonaws.efs#TransitionToIARules", "traits": { - "smithy.api#documentation": "\n Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata\n operations such as listing the contents of a directory don't count as file access\n events.
" + "smithy.api#documentation": "The number of days after files were last accessed in primary storage (the\n Standard storage class) at which to move them to Infrequent Access\n (IA) storage. Metadata operations such as listing the contents of a directory\n don't count as file access events.
" } }, "TransitionToPrimaryStorageClass": { "target": "com.amazonaws.efs#TransitionToPrimaryStorageClassRules", "traits": { - "smithy.api#documentation": "Describes when to transition a file from IA storage to primary storage. Metadata\n operations such as listing the contents of a directory don't count as file access\n events.
" + "smithy.api#documentation": "Whether to move files back to primary (Standard) storage after they are\n accessed in IA or Archive storage. Metadata operations such as\n listing the contents of a directory don't count as file access events.
" + } + }, + "TransitionToArchive": { + "target": "com.amazonaws.efs#TransitionToArchiveRules", + "traits": { + "smithy.api#documentation": "The number of days after files were last accessed in primary storage (the\n Standard storage class) files at which to move them to Archive\n storage. Metadata operations such as listing the contents of a directory don't count as\n file access events.
" } } }, "traits": { - "smithy.api#documentation": "Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that\n specifies when to transition files into and out of the file system's Infrequent Access (IA)\n storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle\n Management.
\nWhen using the put-lifecycle-configuration
CLI command or the\n PutLifecycleConfiguration
API action, Amazon EFS requires that each\n LifecyclePolicy
object have only a single transition. This means that in a\n request body, LifecyclePolicies
must be structured as an array of\n LifecyclePolicy
objects, one object for each transition,\n TransitionToIA
, TransitionToPrimaryStorageClass
. For more\n information, see the request examples in PutLifecycleConfiguration.
Describes a policy used by Lifecycle management that specifies when to transition files\n into and out of the Infrequent Access (IA) and Archive storage\n classes. For more information, see Managing file system storage.
\nWhen using the put-lifecycle-configuration
CLI command or the\n PutLifecycleConfiguration
API action, Amazon EFS requires that each\n LifecyclePolicy
object have only a single transition. This means that in a\n request body, LifecyclePolicies
must be structured as an array of\n LifecyclePolicy
objects, one object for each transition. For more\n information, see the request examples in PutLifecycleConfiguration.
Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.
\nThis operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
Lists all tags for a top-level EFS resource. You must provide the ID of the\n resource that you want to retrieve the tags for.
\nThis operation requires permissions for the elasticfilesystem:DescribeAccessPoints
action.
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.
", + "smithy.api#documentation": "Specifies the EFS resource you want to retrieve tags for. You can retrieve tags\n for EFS file systems and access points using this API endpoint.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4324,7 +4351,7 @@ "type": "double", "traits": { "smithy.api#range": { - "min": 1 + "min": 1.0 } } }, @@ -4345,7 +4372,7 @@ } ], "traits": { - "smithy.api#documentation": "Use this operation to set the account preference in the current Amazon Web Services Region \n to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for \n new EFS file system and mount target resources. All existing resource IDs are not affected \n by any changes you make. You can set the ID preference during the\n opt-in period as EFS transitions to long resource IDs. For more information, \n see Managing Amazon EFS resource IDs.
\nStarting in October, 2021, you will receive an error if you try to set the account preference\n to use the short 8 character format resource ID. Contact Amazon Web Services support if you\n receive an error and must use short IDs for file system and mount target resources.
\nUse this operation to set the account preference in the current Amazon Web Services Region\n to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new\n EFS file system and mount target resources. All existing resource IDs are not\n affected by any changes you make. You can set the ID preference during the opt-in period as\n EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.
\nStarting in October, 2021, you will receive an error if you try to set the account preference\n to use the short 8 character format resource ID. Contact Amazon Web Services support if you\n receive an error and must use short IDs for file system and mount target resources.
\nSpecifies the EFS resource ID preference to set for the user's Amazon Web Services account, \n in the current Amazon Web Services Region, either LONG_ID
(17 characters), or \n SHORT_ID
(8 characters).
Starting in October, 2021, you will receive an error when setting the account preference to\n SHORT_ID
. Contact Amazon Web Services support if you receive an error and must\n use short IDs for file system and mount target resources.
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
\n (17 characters), or SHORT_ID
(8 characters).
Starting in October, 2021, you will receive an error when setting the account preference to\n SHORT_ID
. Contact Amazon Web Services support if you receive an error and must\n use short IDs for file system and mount target resources.
Applies an Amazon EFS FileSystemPolicy
to an Amazon EFS file system. \n A file system policy is an IAM resource-based policy and can contain multiple policy statements. \n A file system always has exactly one file system policy, which can be the default policy or \n an explicit policy set or updated using this API operation.\n EFS file system policies have a 20,000 character limit.\n When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see \n Default EFS File System Policy.\n
EFS file system policies have a 20,000 character limit.
\nThis operation requires permissions for the elasticfilesystem:PutFileSystemPolicy
action.
Applies an Amazon EFS\n FileSystemPolicy
to an Amazon EFS file system. A file system policy is an\n IAM resource-based policy and can contain multiple policy statements. A file system always has\n exactly one file system policy, which can be the default policy or an explicit policy set or\n updated using this API operation. EFS file system policies have a 20,000 character\n limit. When an explicit policy is set, it overrides the default policy. For more information\n about the default file system policy, see Default EFS\n File System Policy.
EFS file system policies have a 20,000 character limit.
\nThis operation requires permissions for the elasticfilesystem:PutFileSystemPolicy
action.
The ID of the EFS file system that you want to create or update the FileSystemPolicy
for.
The ID of the EFS file system that you want to create or update the\n FileSystemPolicy
for.
The FileSystemPolicy
that you're creating. Accepts a JSON formatted policy definition. \n EFS file system policies have a 20,000 character limit.\n To find out more about the elements that make up a file system policy, see \n EFS Resource-based Policies.\n
The FileSystemPolicy
that you're creating. Accepts a JSON formatted\n policy definition. EFS file system policies have a 20,000 character limit. To find\n out more about the elements that make up a file system policy, see EFS Resource-based Policies.
Use this action to manage EFS lifecycle management and EFS Intelligent-Tiering. A\n LifecycleConfiguration
consists of one or more LifecyclePolicy
\n objects that define the following:
\n EFS Lifecycle management - When Amazon EFS\n automatically transitions files in a file system into the lower-cost EFS Infrequent Access\n (IA) storage class.
\nTo enable EFS Lifecycle management, set the value of TransitionToIA
to one of the available options.
\n EFS Intelligent-Tiering - When Amazon EFS\n automatically transitions files from IA back into the file system's primary storage class\n (EFS Standard or EFS One Zone Standard).
\nTo enable EFS Intelligent-Tiering, set the value of\n TransitionToPrimaryStorageClass
to AFTER_1_ACCESS
.
For more information, see EFS Lifecycle Management.
\nEach Amazon EFS file system supports one lifecycle configuration, which applies to\n all files in the file system. If a LifecycleConfiguration
object already exists\n for the specified file system, a PutLifecycleConfiguration
call modifies the\n existing configuration. A PutLifecycleConfiguration
call with an empty\n LifecyclePolicies
array in the request body deletes any existing\n LifecycleConfiguration
and turns off lifecycle management and EFS\n Intelligent-Tiering for the file system.
In the request, specify the following:
\nThe ID for the file system for which you are enabling, disabling, or modifying\n lifecycle management and EFS Intelligent-Tiering.
\nA LifecyclePolicies
array of LifecyclePolicy
objects that\n define when files are moved into IA storage, and when they are moved back to Standard storage.
Amazon EFS requires that each LifecyclePolicy
\n object have only have a single transition, so the LifecyclePolicies
array needs to be structured with separate \n LifecyclePolicy
objects. See the example requests in the following section for more information.
This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
operation.
To apply a LifecycleConfiguration
object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted file system.
Use this action to manage storage of your file system. A\n LifecycleConfiguration
consists of one or more LifecyclePolicy
\n objects that define the following:
\n \n TransitionToIA
\n –\n When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access \n (IA) storage.
\n \n TransitionToArchive
\n –\n When to move files in the file system from their current storage class (either IA or Standard storage) into the \n Archive storage.
File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, \n TransitionToArchive must either not be set or must be later than TransitionToIA.
\nThe Archive storage class is available only for file systems that use the Elastic Throughput mode \nand the General Purpose Performance mode.
\n\n \n TransitionToPrimaryStorageClass
\n –\n Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA\n or Archive storage.
For more information, see \n Managing file system storage.
\nEach Amazon EFS file system supports one lifecycle configuration, which applies to\n all files in the file system. If a LifecycleConfiguration
object already exists\n for the specified file system, a PutLifecycleConfiguration
call modifies the\n existing configuration. A PutLifecycleConfiguration
call with an empty\n LifecyclePolicies
array in the request body deletes any existing\n LifecycleConfiguration
for the file system.
In the request, specify the following:
\nThe ID for the file system for which you are enabling, disabling, or modifying\n Lifecycle management.
\nA LifecyclePolicies
array of LifecyclePolicy
objects that\n define when to move files to IA storage, to Archive storage,\n and back to primary storage.
Amazon EFS requires that each LifecyclePolicy
\n object have only have a single transition, so the LifecyclePolicies
array needs to be structured with separate \n LifecyclePolicy
objects. See the example requests in the following section for more information.
This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration
operation.
To apply a LifecycleConfiguration
object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted file system.
An array of LifecyclePolicy
objects that define the file system's\n LifecycleConfiguration
object. A LifecycleConfiguration
object\n 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.
\nWhen to move files that are in IA storage to primary storage.
\nWhen using the put-lifecycle-configuration
CLI command or the\n PutLifecycleConfiguration
API action, Amazon EFS requires that each\n LifecyclePolicy
object have only a single transition. This means that in a\n request body, LifecyclePolicies
must be structured as an array of\n LifecyclePolicy
objects, one object for each transition,\n TransitionToIA
, TransitionToPrimaryStorageClass
. See the example\n requests in the following section for more information.
An array of LifecyclePolicy
objects that define the file system's\n LifecycleConfiguration
object. A LifecycleConfiguration
object\n informs EFS Lifecycle management of the following:
\n \n TransitionToIA
\n – \n When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access \n (IA) storage.
\n \n TransitionToArchive
\n –\n When to move files in the file system from their current storage class (either IA or Standard storage) into the \n Archive storage.
File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, \n TransitionToArchive must either not be set or must be later than TransitionToIA.
\nThe Archive storage class is available only for file systems that use the Elastic Throughput mode \nand the General Purpose Performance mode.
\n\n \n TransitionToPrimaryStorageClass
\n – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA\n or Archive storage.
When using the put-lifecycle-configuration
CLI command or the\n PutLifecycleConfiguration
API action, Amazon EFS requires that each\n LifecyclePolicy
object have only a single transition. This means that in a\n request body, LifecyclePolicies
must be structured as an array of\n LifecyclePolicy
objects, one object for each storage transition. See the example\n requests in the following section for more information.
The Amazon Web Services Region in which the source Amazon EFS file system is located.
", + "smithy.api#documentation": "The Amazon Web Services Region in which the source EFS file system is\n located.
", "smithy.api#required": {} } }, @@ -4612,7 +4639,7 @@ "OriginalSourceFileSystemArn": { "target": "com.amazonaws.efs#FileSystemArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the original source EFS file system in the\n replication configuration.
", "smithy.api#required": {} } }, @@ -4737,7 +4764,7 @@ "ResourceIdType": { "target": "com.amazonaws.efs#ResourceIdType", "traits": { - "smithy.api#documentation": "Identifies the EFS resource ID preference, either LONG_ID
(17 characters) or SHORT_ID
(8 characters).
Identifies the EFS resource ID preference, either LONG_ID
(17\n characters) or SHORT_ID
(8 characters).
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.\n A path can have up to four subdirectories. \n If the specified path does not exist, you are required to provide the CreationInfo
.
Specifies the path on the EFS file system to expose as the root directory to\n NFS clients using the access point to access the EFS file system. A path can have\n up to four subdirectories. If the specified path does not exist, you are required to provide\n the CreationInfo
.
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory
. \n If the RootDirectory
> Path
specified does not exist, \n EFS creates the root directory using the CreationInfo
settings when a client connects to an access point.\n When specifying the CreationInfo
, you must provide values for all properties. \n
If you do not provide CreationInfo
and the specified RootDirectory
> Path
does not exist, \n attempts to mount the file system using the access point will fail.
(Optional) Specifies the POSIX IDs and permissions to apply to the access point's\n RootDirectory
. If the RootDirectory
> Path
\n specified does not exist, EFS creates the root directory using the\n CreationInfo
settings when a client connects to an access point. When\n specifying the CreationInfo
, you must provide values for all properties.
If you do not provide CreationInfo
and the specified RootDirectory
> Path
does not exist, \n attempts to mount the file system using the access point will fail.
Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.
\nThis operation requires permissions for the elasticfilesystem:TagResource
action.
Creates a tag for an EFS resource. You can create tags for EFS file\n systems and access points using this API operation.
\nThis operation requires permissions for the elasticfilesystem:TagResource
action.
Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.
\nThis operation requires permissions for the elasticfilesystem:UntagResource
action.
Removes tags from an EFS resource. You can remove tags from EFS file\n systems and access points using this API operation.
\nThis operation requires permissions for the elasticfilesystem:UntagResource
action.
The keys of the key-value tag pairs that you want to remove from the specified EFS\n resource.
", + "smithy.api#documentation": "The keys of the key-value tag pairs that you want to remove from the specified\n EFS resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} }