- * Source file system - An existing EFS file system that you - * want replicated. The source file system cannot be a destination file system in an existing - * replication configuration.
+ * 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. *- * 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. The destination file - * system configuration consists of the following properties:
+ * 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:
*- * 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. To use EFS replication in a Region that is disabled by default, you must - * first opt in to the Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference - * Reference Guide - *
+ * 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 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 + * 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 + * 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.
+ * Amazon EFS is used. *After the file system is created, you cannot change the KMS key.
*The following properties are set by default:
+ *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.
+ * 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.
+ * 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. *The following properties are turned off by default:
** Lifecycle management – Lifecycle management is not enabled * on the destination file system. After the destination file system is created, you can - * enable it.
+ * enable lifecycle management. *@@ -135,6 +144,7 @@ export interface CreateReplicationConfigurationCommandOutput * Region: "STRING_VALUE", * AvailabilityZoneName: "STRING_VALUE", * KmsKeyId: "STRING_VALUE", + * FileSystemId: "STRING_VALUE", * }, * ], * }; @@ -168,6 +178,9 @@ export interface CreateReplicationConfigurationCommandOutput *
Returned if the request is malformed or contains an error such as an invalid * parameter value or a missing required parameter.
* + * @throws {@link ConflictException} (client fault) + *Returned if the source file system in a replication is encrypted but the destination file system is unencrypted.
+ * * @throws {@link FileSystemLimitExceeded} (client fault) *Returned if the Amazon Web Services account has already created the maximum number of file systems * allowed per account.
diff --git a/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts b/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts index 0296ba0426c6..94b0ad3d08cb 100644 --- a/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts +++ b/clients/client-efs/src/commands/DeleteReplicationConfigurationCommand.ts @@ -40,10 +40,12 @@ export interface DeleteReplicationConfigurationCommandOutput extends __MetadataB /** * @public - *Deletes an existing replication configuration. Deleting a replication configuration ends the replication process. After a
- * replication configuration is deleted, the destination file system is no longer read-only. You
- * can write to the destination file system after its status becomes
- * Writeable.
Deletes a replication configuration. Deleting a replication configuration ends the
+ * replication process. After a replication configuration is deleted, the destination file system
+ * becomes Writeable and its replication overwrite protection is re-enabled. For
+ * more information, see Delete a replication configuration.
This operation requires permissions for the
+ * elasticfilesystem:DeleteReplicationConfiguration action.
Returns the current LifecycleConfiguration object for the specified Amazon
- * EFS file system. Llifecycle 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/PutLifecycleConfigurationCommand.ts b/clients/client-efs/src/commands/PutLifecycleConfigurationCommand.ts index 2fece8b43b10..908955c587d5 100644 --- a/clients/client-efs/src/commands/PutLifecycleConfigurationCommand.ts +++ b/clients/client-efs/src/commands/PutLifecycleConfigurationCommand.ts @@ -37,7 +37,7 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu /** * @public - *
Use this action to manage storage of your file system. A + *
Use this action to manage storage for your file system. A
* LifecycleConfiguration consists of one or more LifecyclePolicy
* objects that define the following:
*
* TransitionToPrimaryStorageClass
* –
- * Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA
+ * 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 - * Managing file system storage.
+ *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 for the file system.
In the request, specify the following:
+ *LifecycleConfiguration. In the request, specify the following:
* The ID for the file system for which you are enabling, disabling, or modifying diff --git a/clients/client-efs/src/commands/UpdateFileSystemCommand.ts b/clients/client-efs/src/commands/UpdateFileSystemCommand.ts index c82a9dce446a..be9945047946 100644 --- a/clients/client-efs/src/commands/UpdateFileSystemCommand.ts +++ b/clients/client-efs/src/commands/UpdateFileSystemCommand.ts @@ -81,6 +81,9 @@ export interface UpdateFileSystemCommandOutput extends FileSystemDescription, __ * // Value: "STRING_VALUE", // required * // }, * // ], + * // FileSystemProtection: { // FileSystemProtectionDescription + * // ReplicationOverwriteProtection: "ENABLED" || "DISABLED" || "REPLICATING", + * // }, * // }; * * ``` diff --git a/clients/client-efs/src/commands/UpdateFileSystemProtectionCommand.ts b/clients/client-efs/src/commands/UpdateFileSystemProtectionCommand.ts new file mode 100644 index 000000000000..2be03158da25 --- /dev/null +++ b/clients/client-efs/src/commands/UpdateFileSystemProtectionCommand.ts @@ -0,0 +1,177 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; +import { Command as $Command } from "@smithy/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, + SMITHY_CONTEXT_KEY, +} from "@smithy/types"; + +import { EFSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EFSClient"; +import { FileSystemProtectionDescription, UpdateFileSystemProtectionRequest } from "../models/models_0"; +import { de_UpdateFileSystemProtectionCommand, se_UpdateFileSystemProtectionCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link UpdateFileSystemProtectionCommand}. + */ +export interface UpdateFileSystemProtectionCommandInput extends UpdateFileSystemProtectionRequest {} +/** + * @public + * + * The output of {@link UpdateFileSystemProtectionCommand}. + */ +export interface UpdateFileSystemProtectionCommandOutput extends FileSystemProtectionDescription, __MetadataBearer {} + +/** + * @public + *
Updates protection on the file system.
+ *This operation requires permissions for the
+ * elasticfilesystem:UpdateFileSystemProtection action.
Returned if the request is malformed or contains an error such as an invalid + * parameter value or a missing required parameter.
+ * + * @throws {@link FileSystemNotFound} (client fault) + *Returned if the specified FileSystemId value doesn't exist in the
+ * requester's Amazon Web Services account.
Returned if the file system's lifecycle state is not "available".
+ * + * @throws {@link InsufficientThroughputCapacity} (server fault) + *Returned if there's not enough capacity to provision additional throughput. This value + * might be returned when you try to create a file system in provisioned throughput mode, + * when you attempt to increase the provisioned throughput of an existing file system, or + * when you attempt to change an existing file system from Bursting Throughput to + * Provisioned Throughput mode. Try again later.
+ * + * @throws {@link InternalServerError} (server fault) + *Returned if an error occurred on the server side.
+ * + * @throws {@link ReplicationAlreadyExists} (client fault) + *Returned if the file system is already included in a replication configuration.>
+ * + * @throws {@link ThroughputLimitExceeded} (client fault) + *Returned if the throughput mode or amount of provisioned throughput can't be changed + * because the throughput limit of 1024 MiB/s has been reached.
+ * + * @throws {@link TooManyRequests} (client fault) + *Returned if you don’t wait at least 24 hours before either changing the throughput mode, or + * decreasing the Provisioned Throughput value.
+ * + * @throws {@link EFSServiceException} + *Base exception class for all service exceptions from EFS service.
+ * + */ +export class UpdateFileSystemProtectionCommand extends $Command< + UpdateFileSystemProtectionCommandInput, + UpdateFileSystemProtectionCommandOutput, + EFSClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateFileSystemProtectionCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturned if the source file system in a replication is encrypted but the destination file system is unencrypted.
+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + /** + * @public + *The error code is a string that uniquely identifies an error condition. + * It is meant to be read and understood by programs that detect and handle errors by type.
+ */ + ErrorCode?: string; + + /** + * @public + *The error message contains a generic description of the error + * condition in English. It is intended for a human audience. Simple programs display the message directly + * to the end user if they encounter an error condition they don't know how or don't care to handle. + * Sophisticated programs with more exhaustive error handling and proper internationalization are + * more likely to ignore the error message.
+ */ + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeDescribes the protection on a file system.
+ */ +export interface FileSystemProtectionDescription { + /** + * @public + *The status of the file system's replication overwrite protection.
+ *
+ * ENABLED – The file system cannot be used as the destination file
+ * system in a replication configuration. The file system is writeable. Replication overwrite
+ * protection is ENABLED by default.
+ * DISABLED – The file system can be used as the destination file
+ * system in a replication configuration. The file system is read-only and can only be
+ * modified by EFS replication.
+ * REPLICATING – The file system is being used as the destination
+ * file system in a replication configuration. The file system is read-only and is only
+ * modified only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite + * protection is re-enabled, the file system becomes writeable.
+ */ + ReplicationOverwriteProtection?: ReplicationOverwriteProtection; +} + /** * @public *The latest known metered size (in bytes) of data stored in the file system, in its @@ -1053,6 +1141,12 @@ export interface FileSystemDescription { * objects.
*/ Tags: Tag[] | undefined; + + /** + * @public + *Describes the protection on the file system.
+ */ + FileSystemProtection?: FileSystemProtectionDescription; } /** @@ -1594,7 +1688,8 @@ export class SubnetNotFound extends __BaseException { /** * @public - *Describes the destination file system to create in the replication configuration.
+ *Describes the new or existing destination file system for the replication + * configuration.
*/ export interface DestinationToCreate { /** @@ -1612,7 +1707,7 @@ export interface DestinationToCreate { /** * @public - *Specifies the Key Management Service (KMS) key that you want to use to + *
Specify the Key Management Service (KMS) key that you want to use to
* encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS,
* /aws/elasticfilesystem. This ID can be in one of the following formats:
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.
+ */ + FileSystemId?: string; } /** @@ -2406,8 +2509,8 @@ export type TransitionToPrimaryStorageClassRules = /** * @public *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.
+ * into and out of 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
@@ -3033,3 +3136,80 @@ export interface UpdateFileSystemRequest {
*/
ProvisionedThroughputInMibps?: number;
}
+
+/**
+ * @public
+ *
Returned if the file system is already included in a replication configuration.>
+ */ +export class ReplicationAlreadyExists extends __BaseException { + readonly name: "ReplicationAlreadyExists" = "ReplicationAlreadyExists"; + readonly $fault: "client" = "client"; + /** + * @public + *The error code is a string that uniquely identifies an error condition. + * It is meant to be read and understood by programs that detect and handle errors by type.
+ */ + ErrorCode?: string; + + /** + * @public + *The error message contains a generic description of the error + * condition in English. It is intended for a human audience. Simple programs display the message directly + * to the end user if they encounter an error condition they don't know how or don't care to handle. + * Sophisticated programs with more exhaustive error handling and proper internationalization are + * more likely to ignore the error message.
+ */ + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe ID of the file system to update.
+ */ + FileSystemId: string | undefined; + + /** + * @public + *The status of the file system's replication overwrite protection.
+ *
+ * ENABLED – The file system cannot be used as the destination file
+ * system in a replication configuration. The file system is writeable. Replication overwrite
+ * protection is ENABLED by default.
+ * DISABLED – The file system can be used as the destination file
+ * system in a replication configuration. The file system is read-only and can only be
+ * modified by EFS replication.
+ * REPLICATING – The file system is being used as the destination file
+ * system in a replication configuration. The file system is read-only and is only modified
+ * only by EFS replication.
If the replication configuration is deleted, the file system's replication overwrite + * protection is re-enabled, the file system becomes writeable.
+ */ + ReplicationOverwriteProtection?: ReplicationOverwriteProtection; +} diff --git a/clients/client-efs/src/protocols/Aws_restJson1.ts b/clients/client-efs/src/protocols/Aws_restJson1.ts index c32c3ea23ed7..7bba4642f170 100644 --- a/clients/client-efs/src/protocols/Aws_restJson1.ts +++ b/clients/client-efs/src/protocols/Aws_restJson1.ts @@ -108,6 +108,10 @@ import { import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; import { UpdateFileSystemCommandInput, UpdateFileSystemCommandOutput } from "../commands/UpdateFileSystemCommand"; +import { + UpdateFileSystemProtectionCommandInput, + UpdateFileSystemProtectionCommandOutput, +} from "../commands/UpdateFileSystemProtectionCommand"; import { EFSServiceException as __BaseException } from "../models/EFSServiceException"; import { AccessPointAlreadyExists, @@ -116,6 +120,7 @@ import { AvailabilityZonesMismatch, BackupPolicy, BadRequest, + ConflictException, CreationInfo, DependencyTimeout, Destination, @@ -139,6 +144,7 @@ import { NoFreeAddressesInSubnet, PolicyNotFound, PosixUser, + ReplicationAlreadyExists, ReplicationConfigurationDescription, ReplicationNotFound, RootDirectory, @@ -1163,6 +1169,45 @@ export const se_UpdateFileSystemCommand = async ( }); }; +/** + * serializeAws_restJson1UpdateFileSystemProtectionCommand + */ +export const se_UpdateFileSystemProtectionCommand = async ( + input: UpdateFileSystemProtectionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/2015-02-01/file-systems/{FileSystemId}/protection"; + resolvedPath = __resolvedPath( + resolvedPath, + input, + "FileSystemId", + () => input.FileSystemId!, + "{FileSystemId}", + false + ); + let body: any; + body = JSON.stringify( + take(input, { + ReplicationOverwriteProtection: [], + }) + ); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "PUT", + headers, + path: resolvedPath, + body, + }); +}; + /** * deserializeAws_restJson1CreateAccessPointCommand */ @@ -1259,6 +1304,7 @@ export const de_CreateFileSystemCommand = async ( Encrypted: __expectBoolean, FileSystemArn: __expectString, FileSystemId: __expectString, + FileSystemProtection: _json, KmsKeyId: __expectString, LifeCycleState: __expectString, Name: __expectString, @@ -1452,6 +1498,9 @@ const de_CreateReplicationConfigurationCommandError = async ( case "BadRequest": case "com.amazonaws.efs#BadRequest": throw await de_BadRequestRes(parsedOutput, context); + case "ConflictException": + case "com.amazonaws.efs#ConflictException": + throw await de_ConflictExceptionRes(parsedOutput, context); case "FileSystemLimitExceeded": case "com.amazonaws.efs#FileSystemLimitExceeded": throw await de_FileSystemLimitExceededRes(parsedOutput, context); @@ -2871,6 +2920,7 @@ export const de_UpdateFileSystemCommand = async ( Encrypted: __expectBoolean, FileSystemArn: __expectString, FileSystemId: __expectString, + FileSystemProtection: _json, KmsKeyId: __expectString, LifeCycleState: __expectString, Name: __expectString, @@ -2930,6 +2980,74 @@ const de_UpdateFileSystemCommandError = async ( } }; +/** + * deserializeAws_restJson1UpdateFileSystemProtectionCommand + */ +export const de_UpdateFileSystemProtectionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseReturned if the source file system in a replication is encrypted but the destination file system is unencrypted.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.efs#CreateAccessPoint": { "type": "operation", "input": { @@ -598,6 +614,9 @@ { "target": "com.amazonaws.efs#BadRequest" }, + { + "target": "com.amazonaws.efs#ConflictException" + }, { "target": "com.amazonaws.efs#FileSystemLimitExceeded" }, @@ -627,7 +646,7 @@ } ], "traits": { - "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#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 – 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#http": { "method": "POST", "uri": "/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration", @@ -995,7 +1014,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing replication configuration. Deleting a replication configuration ends the replication process. After a\n replication configuration is deleted, the destination file system is no longer read-only. You\n can write to the destination file system after its status becomes\n Writeable.
Deletes a replication configuration. Deleting a replication configuration ends the\n replication process. After a replication configuration is deleted, the destination file system\n becomes Writeable and its replication overwrite protection is re-enabled. For\n more information, see Delete a replication configuration.
This operation requires permissions for the\n elasticfilesystem:DeleteReplicationConfiguration action.
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.
Returns 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.
Specifies 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 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.
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.
" } } }, "traits": { - "smithy.api#documentation": "Describes the destination file system to create in the replication configuration.
" + "smithy.api#documentation": "Describes the new or existing destination file system for the replication\n configuration.
" } }, "com.amazonaws.efs#Destinations": { @@ -2155,6 +2180,12 @@ "smithy.api#documentation": "The tags associated with the file system, presented as an array of Tag\n objects.
Describes the protection on the file system.
" + } } }, "traits": { @@ -2259,6 +2290,20 @@ } } }, + "com.amazonaws.efs#FileSystemProtectionDescription": { + "type": "structure", + "members": { + "ReplicationOverwriteProtection": { + "target": "com.amazonaws.efs#ReplicationOverwriteProtection", + "traits": { + "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\n file system in a replication configuration. The file system is read-only and is only\n modified 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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the protection on a file system.
" + } + }, "com.amazonaws.efs#FileSystemSize": { "type": "structure", "members": { @@ -2535,7 +2580,7 @@ } }, "traits": { - "smithy.api#documentation": "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.
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.
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.
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.
Returned if the file system is already included in a replication configuration.>
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.efs#ReplicationConfigurationDescription": { "type": "structure", "members": { @@ -4687,6 +4751,29 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.efs#ReplicationOverwriteProtection": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "REPLICATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLICATING" + } + } + } + }, "com.amazonaws.efs#ReplicationStatus": { "type": "enum", "members": { @@ -5414,6 +5501,72 @@ } } }, + "com.amazonaws.efs#UpdateFileSystemProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.efs#UpdateFileSystemProtectionRequest" + }, + "output": { + "target": "com.amazonaws.efs#FileSystemProtectionDescription" + }, + "errors": [ + { + "target": "com.amazonaws.efs#BadRequest" + }, + { + "target": "com.amazonaws.efs#FileSystemNotFound" + }, + { + "target": "com.amazonaws.efs#IncorrectFileSystemLifeCycleState" + }, + { + "target": "com.amazonaws.efs#InsufficientThroughputCapacity" + }, + { + "target": "com.amazonaws.efs#InternalServerError" + }, + { + "target": "com.amazonaws.efs#ReplicationAlreadyExists" + }, + { + "target": "com.amazonaws.efs#ThroughputLimitExceeded" + }, + { + "target": "com.amazonaws.efs#TooManyRequests" + } + ], + "traits": { + "smithy.api#documentation": "Updates protection on the file system.
\nThis operation requires permissions for the\n elasticfilesystem:UpdateFileSystemProtection action.
The ID of the file system to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReplicationOverwriteProtection": { + "target": "com.amazonaws.efs#ReplicationOverwriteProtection", + "traits": { + "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, the file system becomes writeable.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.efs#UpdateFileSystemRequest": { "type": "structure", "members": {