From 1f778937ab8e58907ec400190456ab8d1ae72c04 Mon Sep 17 00:00:00 2001
From: awstools
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
+ * for your file system. We recommend generalPurpose
+ * PerformanceMode
for all file
+ * systems. The maxIO
mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies
+ * than the generalPurpose
mode. MaxIO
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
+ * The You can set the throughput mode for the file system using the You can set the throughput mode for the file system using the After the file system is fully created, Amazon EFS sets its lifecycle state to
* 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: Creates a replication configuration to either a new or existing EFS file system.
+ * For more information, see Amazon EFS replication in the Amazon EFS User
+ * Guide. The replication configuration specifies the following:
- * Source file system – The EFS file system that
- * you want replicated. The source file system cannot be a destination file system in an
- * existing replication configuration.PerformanceMode
can't be changed after the file system has been
+ * created. For more information, see Amazon EFS performance
* modes.ThroughputMode
parameter.ThroughputMode
+ * parameter.available
, at which point you can create one or more mount targets for the file
* system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in
diff --git a/clients/client-efs/src/commands/CreateReplicationConfigurationCommand.ts b/clients/client-efs/src/commands/CreateReplicationConfigurationCommand.ts
index 2971a287a969..a77b00e3c0ff 100644
--- a/clients/client-efs/src/commands/CreateReplicationConfigurationCommand.ts
+++ b/clients/client-efs/src/commands/CreateReplicationConfigurationCommand.ts
@@ -33,95 +33,33 @@ export interface CreateReplicationConfigurationCommandOutput
__MetadataBearer {}
/**
- *
*
- * 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 available. The - * Region must be enabled. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference - * Reference Guide.
- *- * Destination file system configuration – The - * configuration of the destination file system to which the source file system will be - * replicated. There can only be one destination file system in a replication configuration.
- *Parameters for the replication configuration include:
- *- * File system ID – The ID of the destination - * file system for the replication. If no ID is provided, then EFS creates a new file - * system with the default settings. For existing file systems, the file system's - * replication overwrite protection must be disabled. For more information, see Replicating to - * an existing file system.
- *- * Availability Zone – If you want the destination file - * system to use One Zone storage, you must specify the Availability Zone to create the - * file system in. For more information, see - * EFS file system types in the Amazon EFS User - * Guide.
- *- * Encryption – All destination file systems are created - * with 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 - * specify a KMS key, your service-managed KMS key for - * Amazon EFS is used.
- *After the file system is created, you cannot change the KMS key.
- *After the file system is created, you cannot change the KMS key.
- *For new destination file systems, the following properties are set by default:
- *- * Performance mode - The destination file system's - * performance mode matches that of the source file system, unless the destination file - * system uses EFS One Zone storage. In that case, the General Purpose performance mode is - * used. The performance mode cannot be changed.
- *- * Throughput mode - The destination file system's - * throughput mode matches that of the source file system. After the file system is created, - * you can modify the throughput mode.
- *- * Lifecycle management – Lifecycle management is not enabled - * on the destination file system. After the destination file system is created, you can - * enable lifecycle management.
- *- * Automatic backups – Automatic daily backups are enabled on - * the destination file system. After the file system is created, you can change this - * setting.
+ * Destination file system – The destination file + * system to which the source file system is replicated. There can only be one destination + * file system in a replication configuration. + *A file system can be part of only one replication configuration.
+ *The destination parameters for the replication configuration depend on + * whether you are replicating to a new file system or to an existing file system, and if you + * are replicating across Amazon Web Services accounts. See DestinationToCreate for more information.
*For more information, see Amazon EFS replication in the - * Amazon EFS User Guide.
+ *This operation requires permissions for the elasticfilesystem:CreateReplicationConfiguration
+ * action. Additionally, other permissions are required depending on how you are replicating file systems.
+ * For more information, see Required permissions for replication
+ * in the Amazon EFS User
+ * Guide.
You cannot delete a file system that is part of an EFS Replication configuration. + *
You cannot delete a file system that is part of an EFS replication configuration. * You need to delete the replication configuration first.
*You can't delete a file system that is in use. That is, if the file system has diff --git a/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts b/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts index f334623bd7b0..5073acbd8cab 100644 --- a/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts +++ b/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts @@ -45,6 +45,7 @@ export interface DeleteReplicationConfigurationCommandOutput extends __MetadataB * const client = new EFSClient(config); * const input = { // DeleteReplicationConfigurationRequest * SourceFileSystemId: "STRING_VALUE", // required + * DeletionMode: "ALL_CONFIGURATIONS" || "LOCAL_CONFIGURATION_ONLY", * }; * const command = new DeleteReplicationConfigurationCommand(input); * const response = await client.send(command); diff --git a/clients/client-efs/src/commands/DescribeLifecycleConfigurationCommand.ts b/clients/client-efs/src/commands/DescribeLifecycleConfigurationCommand.ts index a22aa8550bd8..ae9d3d239325 100644 --- a/clients/client-efs/src/commands/DescribeLifecycleConfigurationCommand.ts +++ b/clients/client-efs/src/commands/DescribeLifecycleConfigurationCommand.ts @@ -34,8 +34,8 @@ export interface DescribeLifecycleConfigurationCommandOutput /** *
Returns the current LifecycleConfiguration
object for the specified Amazon
- * EFS file system. Lifecycle management uses the LifecycleConfiguration
object
- * to identify when to move files between storage classes. For a file system without a
+ * EFS file system. Lifecycle 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.
This operation requires permissions for the diff --git a/clients/client-efs/src/commands/DescribeReplicationConfigurationsCommand.ts b/clients/client-efs/src/commands/DescribeReplicationConfigurationsCommand.ts index f569ce587ec9..f2913394e1f5 100644 --- a/clients/client-efs/src/commands/DescribeReplicationConfigurationsCommand.ts +++ b/clients/client-efs/src/commands/DescribeReplicationConfigurationsCommand.ts @@ -66,8 +66,12 @@ export interface DescribeReplicationConfigurationsCommandOutput * // FileSystemId: "STRING_VALUE", // required * // Region: "STRING_VALUE", // required * // LastReplicatedTimestamp: new Date("TIMESTAMP"), + * // OwnerId: "STRING_VALUE", + * // StatusMessage: "STRING_VALUE", + * // RoleArn: "STRING_VALUE", * // }, * // ], + * // SourceFileSystemOwnerId: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", diff --git a/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts b/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts index 5cac6184539f..0f63754c78ac 100644 --- a/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts +++ b/clients/client-efs/src/commands/PutFileSystemPolicyCommand.ts @@ -34,8 +34,8 @@ export interface PutFileSystemPolicyCommandOutput extends FileSystemPolicyDescri * 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.
+ * about the default file system policy, see + * Default EFS file system policy. *EFS file system policies have a 20,000 character limit.
*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.
+ *The Archive storage class is available only for file systems that use the Elastic throughput mode + * and the General Purpose performance mode.
*The ID for the file system for which you are enabling, disabling, or modifying - * Lifecycle management.
+ * lifecycle management. *A LifecyclePolicies
array of LifecyclePolicy
objects that
diff --git a/clients/client-efs/src/models/models_0.ts b/clients/client-efs/src/models/models_0.ts
index ce18d6a678e2..6dccbdaaed22 100644
--- a/clients/client-efs/src/models/models_0.ts
+++ b/clients/client-efs/src/models/models_0.ts
@@ -124,10 +124,11 @@ export interface CreationInfo {
}
/**
- *
Specifies the directory on the Amazon EFS file system that the access point provides access to.
- * The access point exposes the specified file system path as
- * the root directory of your file system to applications using the access point.
- * NFS clients using the access point can only access data in the access point's RootDirectory
and it's subdirectories.
Specifies the directory on the Amazon EFS file system that the access point
+ * provides access to. The access point exposes the specified file system path as the root
+ * directory of your file system to applications using the access point. NFS clients using the
+ * access point can only access data in the access point's RootDirectory
and its
+ * subdirectories.
The Performance mode of the file system. We recommend generalPurpose
+ *
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
@@ -833,11 +834,10 @@ export interface CreateFileSystemRequest {
ProvisionedThroughputInMibps?: number | undefined;
/**
- *
Used to create a One Zone file system. It specifies the Amazon Web Services + *
For One Zone file systems, specify 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 file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
*The Performance mode of the file system.
+ *The performance mode of the file system.
* @public */ PerformanceMode: PerformanceMode | undefined; @@ -1689,11 +1689,42 @@ export class SubnetNotFound extends __BaseException { /** *Describes the new or existing destination file system for the replication * configuration.
+ *If you want to replicate to a new file system, do not specify the File System ID + * for the destination file system. Amazon EFS creates a new, empty file system. + * For One Zone storage, specify the Availability Zone to create the file system in. To + * use an Key Management Service key other than the default KMS key, then + * specify it. For more information, see Configuring replication to new Amazon EFS file system in the Amazon EFS User + * Guide.
+ *After the file system is created, you cannot change the KMS key or the performance mode.
+ *If you want to replicate to an existing file system that's in the same account + * as the source file system, then you need to + * provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system's replication + * overwrite protection must be disabled. For more information, see Replicating to + * an existing file system in the Amazon EFS User + * Guide.
+ *If you are replicating the file system to a file system that's in a different account than the + * source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform + * replication on the destination account. The file system's replication overwrite protection + * must be disabled. For more information, see Replicating across Amazon Web Services accounts in the Amazon EFS User + * Guide.
+ *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. The Region must be enabled + * for the Amazon Web Services account that owns the source file system. For more information, see + * Managing Amazon Web Services Regions in the Amazon Web Services General + * Reference Reference Guide.
* @public */ Region?: string | undefined; @@ -1715,7 +1746,7 @@ export interface DestinationToCreate { *1234abcd-12ab-34cd-56ef-1234567890ab
.
* ARN - The Amazon Resource Name (ARN) for the key, for example + *
ARN - The ARN for the key, for example
* arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
The ID of the file system to use for the destination. The file system's replication - * overwrite replication must be disabled. If you do not provide an ID, then EFS creates a new - * file system for the replication destination.
+ *The ID or ARN of the file system to use for the destination. + * For cross-account replication, this must be an ARN. The file system's + * replication overwrite replication must be disabled. If no ID or ARN is + * specified, then a new file system is created.
* @public */ FileSystemId?: string | undefined; + + /** + *Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS + * to perform replication on its behalf. This is optional for same-account + * replication and required for cross-account replication.
+ * @public + */ + RoleArn?: string | undefined; } /** @@ -1782,24 +1822,10 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat */ export interface Destination { /** - *Describes the status of the destination EFS file system.
- *The Paused
state occurs as a result of opting out of the source or
- * destination Region after the replication configuration was created. To resume replication
- * for the file system, you need to again opt in to the Amazon Web Services Region. For more
- * information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference
- * Guide.
The Error
state occurs when either the source or the destination file
- * system (or both) is in a failed state and is unrecoverable. For more information, see
- * Monitoring
- * replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then
- * restore the most recent backup of the failed file system (either the source or the
- * destination) to a new file system.
Describes the status of the replication configuration. For more information + * about replication status, see Viewing + * replication details in the Amazon EFS User Guide. + *
* @public */ Status: ReplicationStatus | undefined; @@ -1824,6 +1850,30 @@ export interface Destination { * @public */ LastReplicatedTimestamp?: Date | undefined; + + /** + *ID of the Amazon Web Services account in which the destination file system resides.
+ * @public + */ + OwnerId?: string | undefined; + + /** + *Message that provides details about the PAUSED
or ERRROR
state
+ * of the replication destination configuration. For more information
+ * about replication status messages, see Viewing
+ * replication details in the Amazon EFS User Guide.
+ *
Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS + * to perform replication on its behalf. This is optional for same-account + * replication and required for cross-account replication.
+ * @public + */ + RoleArn?: string | undefined; } /** @@ -1869,6 +1919,12 @@ export interface ReplicationConfigurationDescription { * @public */ Destinations: Destination[] | undefined; + + /** + *ID of the Amazon Web Services account in which the source file system resides.
+ * @public + */ + SourceFileSystemOwnerId?: string | undefined; } /** @@ -2130,6 +2186,20 @@ export class MountTargetNotFound extends __BaseException { } } +/** + * @public + * @enum + */ +export const DeletionMode = { + ALL_CONFIGURATIONS: "ALL_CONFIGURATIONS", + LOCAL_CONFIGURATION_ONLY: "LOCAL_CONFIGURATION_ONLY", +} as const; + +/** + * @public + */ +export type DeletionMode = (typeof DeletionMode)[keyof typeof DeletionMode]; + /** * @public */ @@ -2139,6 +2209,26 @@ export interface DeleteReplicationConfigurationRequest { * @public */ SourceFileSystemId: string | undefined; + + /** + *When replicating across Amazon Web Services accounts or across Amazon Web Services Regions,
+ * Amazon EFS deletes the replication configuration from both the source
+ * and destination account or Region (ALL_CONFIGURATIONS
) by default.
+ * If there's a configuration or permissions issue that prevents Amazon EFS from deleting the
+ * replication configuration from both sides, you can use the LOCAL_CONFIGURATION_ONLY
mode
+ * to delete the replication configuration from only the local side (the account
+ * or Region from which the delete is performed).
Only use the LOCAL_CONFIGURATION_ONLY
mode in the case that Amazon EFS is unable
+ * to delete the replication configuration in both the source and destination account or Region.
+ * Deleting the local configuration
+ * leaves the configuration in the other account or Region unrecoverable.
Additionally, do not use this mode for same-account, same-region replication as doing so results in a + * BadRequest exception error.
+ *Describes a policy used by Lifecycle management that specifies when to transition files + *
Describes a policy used by lifecycle management that specifies when to transition files * into and out of storage classes. For more information, see Managing file system * storage.
*The number of days after files were last accessed in primary storage (the - * Standard storage class) files at which to move them to Archive + * Standard storage class) at which to move them to Archive * storage. Metadata operations such as listing the contents of a directory don't count as * file access events.
* @public @@ -2699,7 +2789,8 @@ export class IncorrectMountTargetState extends __BaseException { export interface DescribeReplicationConfigurationsRequest { /** *You can retrieve the replication configuration for a specific file system by providing its - * file system ID.
+ * file system ID. For cross-account,cross-region replication, an account can only describe the replication + * configuration for a file system in its own Region. * @public */ FileSystemId?: string | undefined; @@ -2954,7 +3045,7 @@ export interface PutFileSystemPolicyRequest { /** *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 of the following:
@@ -3005,8 +3096,8 @@ export interface PutLifecycleConfigurationRequest { *
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.
+ *The Archive storage class is available only for file systems that use the Elastic throughput mode + * and the General Purpose performance mode.
*If the replication configuration is deleted, the file system's replication overwrite - * protection is re-enabled, the file system becomes writeable.
+ * protection is re-enabled and the file system becomes writeable. * @public */ ReplicationOverwriteProtection?: ReplicationOverwriteProtection | undefined; diff --git a/clients/client-efs/src/protocols/Aws_restJson1.ts b/clients/client-efs/src/protocols/Aws_restJson1.ts index a6a79dc2af7a..65fcd04bf48e 100644 --- a/clients/client-efs/src/protocols/Aws_restJson1.ts +++ b/clients/client-efs/src/protocols/Aws_restJson1.ts @@ -363,8 +363,11 @@ export const se_DeleteReplicationConfigurationCommand = async ( const headers: any = {}; b.bp("/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration"); b.p("SourceFileSystemId", () => input.SourceFileSystemId!, "{SourceFileSystemId}", false); + const query: any = map({ + [_dM]: [, input[_DM]!], + }); let body: any; - b.m("DELETE").h(headers).b(body); + b.m("DELETE").h(headers).q(query).b(body); return b.build(); }; @@ -924,6 +927,7 @@ export const de_CreateReplicationConfigurationCommand = async ( OriginalSourceFileSystemArn: __expectString, SourceFileSystemArn: __expectString, SourceFileSystemId: __expectString, + SourceFileSystemOwnerId: __expectString, SourceFileSystemRegion: __expectString, }); Object.assign(contents, doc); @@ -2270,8 +2274,11 @@ const de_Destination = (output: any, context: __SerdeContext): Destination => { return take(output, { FileSystemId: __expectString, LastReplicatedTimestamp: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + OwnerId: __expectString, Region: __expectString, + RoleArn: __expectString, Status: __expectString, + StatusMessage: __expectString, }) as any; }; @@ -2363,6 +2370,7 @@ const de_ReplicationConfigurationDescription = ( OriginalSourceFileSystemArn: __expectString, SourceFileSystemArn: __expectString, SourceFileSystemId: __expectString, + SourceFileSystemOwnerId: __expectString, SourceFileSystemRegion: __expectString, }) as any; }; @@ -2410,6 +2418,7 @@ const collectBodyString = (streamBody: any, context: __SerdeContext): PromiseCreates 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.
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
\n PerformanceMode
for all file\n systems. The maxIO
mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies\n than the generalPurpose
mode. MaxIO
mode is not supported for One Zone file systems or\n file systems that use Elastic throughput.
The PerformanceMode
can't be changed after the file system has been\n created. For more information, see Amazon EFS performance\n modes.
You can set the throughput mode for the file system using the ThroughputMode
\n 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 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
.
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
.
Used 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.
\nFor One Zone file systems, specify 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 EFS file system types 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.
\nCreates 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 – The EFS file system that\n you want replicated. The source file system cannot be a destination file system in an\n existing replication configuration.
\n\n Amazon Web Services Region – The Amazon Web Services Region in which the destination file system is created. Amazon EFS\n replication is available in all Amazon Web Services Regions in which EFS is available. The\n Region must be enabled. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference\n Reference Guide.
\n\n Destination file system configuration – The\n configuration of the destination file system to which the source file system will be\n replicated. There can only be one destination file system in a replication configuration.
\nParameters for the replication configuration include:
\n\n File system ID – The ID of the destination\n file system for the replication. If no ID is provided, then EFS creates a new file\n system with the default settings. For existing file systems, the file system's\n replication overwrite protection must be disabled. For more information, see Replicating to\n an existing file system.
\n\n Availability Zone – If you want the destination file\n system to use One Zone storage, you must specify the Availability Zone to create the\n file system in. For more information, see \n EFS file system types in the Amazon EFS User\n Guide.
\n\n Encryption – All destination file systems are created\n with 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.
\nAfter the file system is created, you cannot change the KMS key.
\nFor new destination file systems, the following properties are set by default:
\n\n Performance mode - The destination file system's\n performance mode matches that of the source file system, unless the destination file\n system uses EFS One Zone storage. In that case, the General Purpose performance mode is\n used. The performance mode cannot be changed.
\n\n Throughput mode - The destination file system's\n throughput mode matches that of the source file system. After the file system is created,\n you can modify the throughput mode.
\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 lifecycle management.
\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 to either a new or existing EFS file system.\n For more information, see Amazon EFS replication in the Amazon EFS User\n Guide. The replication configuration specifies the following:
\n\n Source file system – The EFS file\n system that you want to replicate.
\n\n Destination file system – The destination file\n system to which the source file system is replicated. There can only be one destination\n file system in a replication configuration.
\nA file system can be part of only one replication configuration.
\nThe destination parameters for the replication configuration depend on\n whether you are replicating to a new file system or to an existing file system, and if you\n are replicating across Amazon Web Services accounts. See DestinationToCreate for more information.
\nThis operation requires permissions for the elasticfilesystem:CreateReplicationConfiguration
\n action. Additionally, other permissions are required depending on how you are replicating file systems.\n For more information, see Required permissions for replication\n in the Amazon EFS User\n Guide.
Deletes a file system, permanently severing access to its contents. Upon return, the\n file system no longer exists and you can't access any contents of the deleted file\n system.
\nYou need to manually delete mount targets attached to a file system before you can delete\n an EFS file system. This step is performed for you when you use the Amazon Web Services console \n to delete a file system.
\nYou cannot delete a file system that is part of an EFS Replication configuration. \n You need to delete the replication configuration first.
\nYou can't delete a file system that is in use. That is, if the file system has\n any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
\nThe DeleteFileSystem
call returns while the file system state is still\n deleting
. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound
\n error.
This operation requires permissions for the\n elasticfilesystem:DeleteFileSystem
action.
Deletes a file system, permanently severing access to its contents. Upon return, the\n file system no longer exists and you can't access any contents of the deleted file\n system.
\nYou need to manually delete mount targets attached to a file system before you can delete\n an EFS file system. This step is performed for you when you use the Amazon Web Services console \n to delete a file system.
\nYou cannot delete a file system that is part of an EFS replication configuration. \n You need to delete the replication configuration first.
\nYou can't delete a file system that is in use. That is, if the file system has\n any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.
\nThe DeleteFileSystem
call returns while the file system state is still\n deleting
. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound
\n error.
This operation requires permissions for the\n elasticfilesystem:DeleteFileSystem
action.
When replicating across Amazon Web Services accounts or across Amazon Web Services Regions, \n Amazon EFS deletes the replication configuration from both the source \n and destination account or Region (ALL_CONFIGURATIONS
) by default. \n If there's a configuration or permissions issue that prevents Amazon EFS from deleting the \n replication configuration from both sides, you can use the LOCAL_CONFIGURATION_ONLY
mode\n to delete the replication configuration from only the local side (the account\n or Region from which the delete is performed).
Only use the LOCAL_CONFIGURATION_ONLY
mode in the case that Amazon EFS is unable\n to delete the replication configuration in both the source and destination account or Region. \n Deleting the local configuration \n leaves the configuration in the other account or Region unrecoverable.
Additionally, do not use this mode for same-account, same-region replication as doing so results in a \n BadRequest exception error.
\nReturns the current LifecycleConfiguration
object for the specified Amazon\n EFS file system. Lifecycle management uses the LifecycleConfiguration
object\n to 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.
Returns the current LifecycleConfiguration
object for the specified Amazon\n EFS file system. Lifecycle 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.
You can retrieve the replication configuration for a specific file system by providing its\n file system ID.
", + "smithy.api#documentation": "You can retrieve the replication configuration for a specific file system by providing its\n file system ID. For cross-account,cross-region replication, an account can only describe the replication\n configuration for a file system in its own Region.
", "smithy.api#httpQuery": "FileSystemId" } }, @@ -1960,7 +1984,7 @@ "Status": { "target": "com.amazonaws.efs#ReplicationStatus", "traits": { - "smithy.api#documentation": "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.
Describes the status of the replication configuration. For more information \n about replication status, see Viewing\n replication details in the Amazon EFS User Guide. \n
", "smithy.api#required": {} } }, @@ -1983,6 +2007,24 @@ "traits": { "smithy.api#documentation": "The time when the most recent sync was successfully completed on the destination file\n system. Any changes to data on the source file system that occurred before this time have been\n successfully replicated to the destination file system. Any changes that occurred after this\n time might not be fully replicated.
" } + }, + "OwnerId": { + "target": "com.amazonaws.efs#AwsAccountId", + "traits": { + "smithy.api#documentation": "ID of the Amazon Web Services account in which the destination file system resides.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.efs#StatusMessage", + "traits": { + "smithy.api#documentation": "Message that provides details about the PAUSED
or ERRROR
state \n of the replication destination configuration. For more information \n about replication status messages, see Viewing\n replication details in the Amazon EFS User Guide. \n
Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS\n to perform replication on its behalf. This is optional for same-account \n replication and required for cross-account replication.
" + } } }, "traits": { @@ -1995,7 +2037,7 @@ "Region": { "target": "com.amazonaws.efs#RegionName", "traits": { - "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.
" + "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. The Region must be enabled\n for the Amazon Web Services account that owns the source file system. For more information, see\n Managing Amazon Web Services Regions in the Amazon Web Services General\n Reference Reference Guide.
" } }, "AvailabilityZoneName": { @@ -2007,18 +2049,24 @@ "KmsKeyId": { "target": "com.amazonaws.efs#KmsKeyId", "traits": { - "smithy.api#documentation": "Specify the Key Management Service (KMS) key that you want to use to\n encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,\n /aws/elasticfilesystem
. This ID can be in one of the following formats:
Key ID - The unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - The Amazon Resource Name (ARN) for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example\n alias/projectKey1
.
Key alias ARN - The ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
Specify the Key Management Service (KMS) key that you want to use to\n encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,\n /aws/elasticfilesystem
. This ID can be in one of the following formats:
Key ID - The unique identifier of the key, for example\n 1234abcd-12ab-34cd-56ef-1234567890ab
.
ARN - The ARN for the key, for example\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
Key alias - A previously created display name for a key, for example\n alias/projectKey1
.
Key alias ARN - The ARN for a key alias, for example\n arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.
The ID of the file system to use for the destination. The file system's replication\n overwrite replication must be disabled. If you do not provide an ID, then EFS creates a new\n file system for the replication destination.
" + "smithy.api#documentation": "The ID or ARN of the file system to use for the destination. \n For cross-account replication, this must be an ARN. The file system's \n replication overwrite replication must be disabled. If no ID or ARN is \n specified, then a new file system is created.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.efs#RoleArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS\n to perform replication on its behalf. This is optional for same-account \n replication and required for cross-account replication.
" } } }, "traits": { - "smithy.api#documentation": "Describes the new or existing destination file system for the replication\n configuration.
" + "smithy.api#documentation": "Describes the new or existing destination file system for the replication\n configuration.
\nIf you want to replicate to a new file system, do not specify the File System ID\n for the destination file system. Amazon EFS creates a new, empty file system.\n For One Zone storage, specify the Availability Zone to create the file system in. To\n use an Key Management Service key other than the default KMS key, then\n specify it. For more information, see Configuring replication to new Amazon EFS file system in the Amazon EFS User\n Guide.
\nAfter the file system is created, you cannot change the KMS key or the performance mode.
\nIf you want to replicate to an existing file system that's in the same account\n as the source file system, then you need to \n provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system's replication\n overwrite protection must be disabled. For more information, see Replicating to\n an existing file system in the Amazon EFS User\n Guide.
\nIf you are replicating the file system to a file system that's in a different account than the\n source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform\n replication on the destination account. The file system's replication overwrite protection\n must be disabled. For more information, see Replicating across Amazon Web Services accounts in the Amazon EFS User\n Guide.
\nThe Performance mode of the file system.
", + "smithy.api#documentation": "The performance mode of the file system.
", "smithy.api#required": {} } }, @@ -2588,12 +2636,12 @@ "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.
" + "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 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 Lifecycle management that specifies when to transition files\n into and out of storage classes. For more information, see Managing file system\n 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.
Describes a policy used by lifecycle management that specifies when to transition files\n into and out of storage classes. For more information, see Managing file system\n 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.
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.
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 \n Default EFS file system policy.
EFS file system policies have a 20,000 character limit.
\nThis operation requires permissions for the elasticfilesystem:PutFileSystemPolicy
action.
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.
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 Resource-based policies within Amazon EFS.
Use this action to manage storage for 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 Managing file system\n 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
. In the request, specify the following:
The 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.
Use this action to manage storage for 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 Managing file system\n 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
. In the request, specify the following:
The 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 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.
An array of LifecyclePolicy
objects that define the file system's\n LifecycleConfiguration
object. A LifecycleConfiguration
object\n informs 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.
An array of destination objects. Only one destination object is supported.
", "smithy.api#required": {} } + }, + "SourceFileSystemOwnerId": { + "target": "com.amazonaws.efs#AwsAccountId", + "traits": { + "smithy.api#documentation": "ID of the Amazon Web Services account in which the source file system resides.
" + } } }, "traits": { @@ -4907,6 +4961,16 @@ "smithy.api#documentation": "EFS resources to which a preference applies to." } }, + "com.amazonaws.efs#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, "com.amazonaws.efs#RootDirectory": { "type": "structure", "members": { @@ -4924,7 +4988,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the directory on the Amazon EFS file system that the access point provides access to. \n The access point exposes the specified file system path as\n the root directory of your file system to applications using the access point. \n NFS clients using the access point can only access data in the access point's RootDirectory
and it's subdirectories.
Specifies the directory on the Amazon EFS file system that the access point\n provides access to. The access point exposes the specified file system path as the root\n directory of your file system to applications using the access point. NFS clients using the\n access point can only access data in the access point's RootDirectory
and its\n subdirectories.
The status of the file system's replication overwrite protection.
\n\n ENABLED
– The file system cannot be used as the destination file\n system in a replication configuration. The file system is writeable. Replication overwrite\n protection is ENABLED
by default.
\n DISABLED
– The file system can be used as the destination file\n system in a replication configuration. The file system is read-only and can only be\n modified by EFS replication.
\n REPLICATING
– The file system is being used as the destination file\n system in a replication configuration. The file system is read-only and is only modified\n only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite\n protection is re-enabled, the file system becomes writeable.
" + "smithy.api#documentation": "The status of the file system's replication overwrite protection.
\n\n ENABLED
– The file system cannot be used as the destination file\n system in a replication configuration. The file system is writeable. Replication overwrite\n protection is ENABLED
by default.
\n DISABLED
– The file system can be used as the destination file\n system in a replication configuration. The file system is read-only and can only be\n modified by EFS replication.
\n REPLICATING
– The file system is being used as the destination file\n system in a replication configuration. The file system is read-only and is only modified\n only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite\n protection is re-enabled and the file system becomes writeable.
" } } },