AWS CLI Command Reference

[ aws . fsx ]

describe-backups

Description

Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you’re calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken .

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-backups is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Backups

Synopsis

  describe-backups
[--backup-ids <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--backup-ids (list)

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

(string)

The ID of the backup. Specifies the backup to use if you’re creating a file system from an existing backup.

Syntax:

"string" "string" ...

--filters (list)

Filters structure. Supported names are file-system-id and backup-type.

(structure)

A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

Name -> (string)

The name for this filter.

Values -> (list)

The values of the filter. These are all the values for any of the applied filters.

(string)

The value for a filter.

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "file-system-id"|"backup-type"|"file-system-type",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Backups -> (list)

Any array of backups.

(structure)

A backup of an Amazon FSx for file system.

BackupId -> (string)

The ID of the backup.

Lifecycle -> (string)

The lifecycle status of the backup.

FailureDetails -> (structure)

Details explaining any failures that occur when creating a backup.

Message -> (string)

A message describing the backup creation failure.

Type -> (string)

The type of the backup.

ProgressPercent -> (integer)

The current percent of progress of an asynchronous task.

CreationTime -> (timestamp)

The time when a particular backup was created.

KmsKeyId -> (string)

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup of the Amazon FSx for Windows file system’s data at rest. Amazon FSx for Lustre does not support KMS encryption.

ResourceARN -> (string)

The Amazon Resource Name (ARN) for the backup resource.

Tags -> (list)

Tags associated with a particular file system.

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .

FileSystem -> (structure)

Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

OwnerId -> (string)

The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.

CreationTime -> (timestamp)

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The system-generated, unique 17-digit ID of the file system.

FileSystemType -> (string)

The type of Amazon FSx file system, either LUSTRE or WINDOWS .

Lifecycle -> (string)

The lifecycle status of the file system, following are the possible values and what they mean:

  • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

  • CREATING - Amazon FSx is creating the new file system.

  • DELETING - Amazon FSx is deleting an existing file system.

  • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

  • MISCONFIGURED indicates that the file system is in a failed but recoverable state.

  • UPDATING indicates that the file system is undergoing a customer initiated update.

FailureDetails -> (structure)

A structure providing details of any failures that occur when creating the file system has failed.

Message -> (string)

A message describing any failures that occurred during file system creation.

StorageCapacity -> (integer)

The storage capacity of the file system in gigabytes (GB).

StorageType -> (string)

The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.

VpcId -> (string)

The ID of the primary VPC for the file system.

SubnetIds -> (list)

Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID .

(string)

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

NetworkInterfaceIds -> (list)

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

(string)

An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .

DNSName -> (string)

The DNS name for the file system.

KmsKeyId -> (string)

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system’s data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference .

ResourceARN -> (string)

The Amazon Resource Name (ARN) for the file system resource.

Tags -> (list)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .

WindowsConfiguration -> (structure)

The configuration for this Microsoft Windows file system.

ActiveDirectoryId -> (string)

The ID for an existing Microsoft Active Directory instance that the file system should join when it’s created.

SelfManagedActiveDirectoryConfiguration -> (structure)

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

DomainName -> (string)

The fully qualified domain name of the self-managed AD directory.

OrganizationalUnitDistinguishedName -> (string)

The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.

FileSystemAdministratorsGroup -> (string)

The name of the domain group whose members have administrative privileges for the FSx file system.

UserName -> (string)

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

DnsIps -> (list)

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.

(string)

DeploymentType -> (string)

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

  • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

For more information, see Single-AZ and Multi-AZ File Systems .

RemoteAdministrationEndpoint -> (string)

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

PreferredSubnetId -> (string)

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems

PreferredFileServerIp -> (string)

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system’s DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .

ThroughputCapacity -> (integer)

The throughput of an Amazon FSx file system, measured in megabytes per second.

MaintenanceOperationsInProgress -> (list)

The list of maintenance operations in progress for this file system.

(string)

An enumeration specifying the currently ongoing maintenance operation.

WeeklyMaintenanceStartTime -> (string)

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

DailyAutomaticBackupStartTime -> (string)

The preferred time to take daily automatic backups, in the UTC time zone.

AutomaticBackupRetentionDays -> (integer)

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

CopyTagsToBackups -> (boolean)

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it’s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn’t specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

LustreConfiguration -> (structure)

The configuration for the Amazon FSx for Lustre file system.

WeeklyMaintenanceStartTime -> (string)

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

DataRepositoryConfiguration -> (structure)

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

Lifecycle -> (string)

Describes the state of the file system’s S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

  • CREATING - Amazon FSx is creating the new data repository.

  • AVAILABLE - The data repository is available for use.

  • MISCONFIGURED - The data repository is in a failed but recoverable state.

  • UPDATING - The data repository is undergoing a customer initiated update.

ImportPath -> (string)

The import path to the Amazon S3 bucket (and optional prefix) that you’re using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ExportPath -> (string)

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

ImportedFileChunkSize -> (integer)

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

AutoImportPolicy -> (string)

Describes the data repository’s AutoImportPolicy . AutoImport enables your FSx for Lustre file system to automatically update its contents with changes that have been made to its linked Amazon S3 data repository. The policy can have the following values:

  • NONE - (Default) Autoimport is turned off, Changes to your S3 repository will not be reflected on the FSx file system.

  • NEW - Autoimport is turned on; only new files in the linked S3 repository will be imported to the FSx file system. Updates to existing files and deleted files will not be imported to the FSx file system.

  • NEW_CHANGED - Autoimport is turned on; new files and changes to existing files in the linked S3 repository will be imported to the FSx file system. Files deleted in S3 are not deleted in the FSx file system.

  • NEW_CHANGED_DELETED - Autoimport is turned on; new files, changes to existing files, and deleted files in the linked S3 repository will be imported to the FSx file system.

FailureDetails -> (structure)

Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .

Message -> (string)

A detailed error message.

DeploymentType -> (string)

The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1 .

The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )

PerUnitStorageThroughput -> (integer)

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types. Valid values are 50, 100, 200.

MountName -> (string)

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always “fsx “. For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS Region.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

AutomaticBackupRetentionDays -> (integer)

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days. The default is 0.

CopyTagsToBackups -> (boolean)

A boolean flag indicating whether tags on the file system should be copied to backups. If it’s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn’t specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

AdministrativeActions -> (list)

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

(structure)

Describes a specific Amazon FSx Administrative Action for the current Windows file system.

AdministrativeActionType -> (string)

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system). A

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system’s storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts. Storage optimization is the process of migrating the file system data to the new, larger disks. You can track the storage migration progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing Storage Capacity .

ProgressPercent -> (integer)

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.

RequestTime -> (timestamp)

Time that the administrative action request was received.

Status -> (string)

Describes the status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.

  • IN_PROGRESS - Amazon FSx is processing the administrative action.

  • PENDING - Amazon FSx is waiting to process the administrative action.

  • COMPLETED - Amazon FSx has finished processing the administrative task.

  • UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. For more information, see Managing Storage Capacity .

TargetFileSystemValues -> (structure)

Describes the target StorageCapacity or ThroughputCapacity value provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

OwnerId -> (string)

The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.

CreationTime -> (timestamp)

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The system-generated, unique 17-digit ID of the file system.

FileSystemType -> (string)

The type of Amazon FSx file system, either LUSTRE or WINDOWS .

Lifecycle -> (string)

The lifecycle status of the file system, following are the possible values and what they mean:

  • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

  • CREATING - Amazon FSx is creating the new file system.

  • DELETING - Amazon FSx is deleting an existing file system.

  • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

  • MISCONFIGURED indicates that the file system is in a failed but recoverable state.

  • UPDATING indicates that the file system is undergoing a customer initiated update.

FailureDetails -> (structure)

A structure providing details of any failures that occur when creating the file system has failed.

Message -> (string)

A message describing any failures that occurred during file system creation.

StorageCapacity -> (integer)

The storage capacity of the file system in gigabytes (GB).

StorageType -> (string)

The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.

VpcId -> (string)

The ID of the primary VPC for the file system.

SubnetIds -> (list)

Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID .

(string)

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

NetworkInterfaceIds -> (list)

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

(string)

An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .

DNSName -> (string)

The DNS name for the file system.

KmsKeyId -> (string)

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system’s data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference .

ResourceARN -> (string)

The Amazon Resource Name (ARN) for the file system resource.

Tags -> (list)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .

WindowsConfiguration -> (structure)

The configuration for this Microsoft Windows file system.

ActiveDirectoryId -> (string)

The ID for an existing Microsoft Active Directory instance that the file system should join when it’s created.

SelfManagedActiveDirectoryConfiguration -> (structure)

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

DomainName -> (string)

The fully qualified domain name of the self-managed AD directory.

OrganizationalUnitDistinguishedName -> (string)

The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.

FileSystemAdministratorsGroup -> (string)

The name of the domain group whose members have administrative privileges for the FSx file system.

UserName -> (string)

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

DnsIps -> (list)

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.

(string)

DeploymentType -> (string)

Specifies the file system deployment type, valid values are the following:

  • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

  • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

For more information, see Single-AZ and Multi-AZ File Systems .

RemoteAdministrationEndpoint -> (string)

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

PreferredSubnetId -> (string)

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems

PreferredFileServerIp -> (string)

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system’s DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .

ThroughputCapacity -> (integer)

The throughput of an Amazon FSx file system, measured in megabytes per second.

MaintenanceOperationsInProgress -> (list)

The list of maintenance operations in progress for this file system.

(string)

An enumeration specifying the currently ongoing maintenance operation.

WeeklyMaintenanceStartTime -> (string)

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

DailyAutomaticBackupStartTime -> (string)

The preferred time to take daily automatic backups, in the UTC time zone.

AutomaticBackupRetentionDays -> (integer)

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

CopyTagsToBackups -> (boolean)

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it’s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn’t specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

LustreConfiguration -> (structure)

The configuration for the Amazon FSx for Lustre file system.

WeeklyMaintenanceStartTime -> (string)

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

DataRepositoryConfiguration -> (structure)

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

Lifecycle -> (string)

Describes the state of the file system’s S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

  • CREATING - Amazon FSx is creating the new data repository.

  • AVAILABLE - The data repository is available for use.

  • MISCONFIGURED - The data repository is in a failed but recoverable state.

  • UPDATING - The data repository is undergoing a customer initiated update.

ImportPath -> (string)

The import path to the Amazon S3 bucket (and optional prefix) that you’re using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ExportPath -> (string)

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

ImportedFileChunkSize -> (integer)

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

AutoImportPolicy -> (string)

Describes the data repository’s AutoImportPolicy . AutoImport enables your FSx for Lustre file system to automatically update its contents with changes that have been made to its linked Amazon S3 data repository. The policy can have the following values:

  • NONE - (Default) Autoimport is turned off, Changes to your S3 repository will not be reflected on the FSx file system.

  • NEW - Autoimport is turned on; only new files in the linked S3 repository will be imported to the FSx file system. Updates to existing files and deleted files will not be imported to the FSx file system.

  • NEW_CHANGED - Autoimport is turned on; new files and changes to existing files in the linked S3 repository will be imported to the FSx file system. Files deleted in S3 are not deleted in the FSx file system.

  • NEW_CHANGED_DELETED - Autoimport is turned on; new files, changes to existing files, and deleted files in the linked S3 repository will be imported to the FSx file system.

FailureDetails -> (structure)

Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .

Message -> (string)

A detailed error message.

DeploymentType -> (string)

The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1 .

The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )

PerUnitStorageThroughput -> (integer)

Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types. Valid values are 50, 100, 200.

MountName -> (string)

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always “fsx “. For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS Region.

DailyAutomaticBackupStartTime -> (string)

A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

AutomaticBackupRetentionDays -> (integer)

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days. The default is 0.

CopyTagsToBackups -> (boolean)

A boolean flag indicating whether tags on the file system should be copied to backups. If it’s set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn’t specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

AdministrativeActions -> (list)

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.

(structure)

Describes a specific Amazon FSx Administrative Action for the current Windows file system.

AdministrativeActionType -> (string)

Describes the type of administrative action, as follows:

  • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system). A

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system’s storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts. Storage optimization is the process of migrating the file system data to the new, larger disks. You can track the storage migration progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing Storage Capacity .

ProgressPercent -> (integer)

Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.

RequestTime -> (timestamp)

Time that the administrative action request was received.

Status -> (string)

Describes the status of the administrative action, as follows:

  • FAILED - Amazon FSx failed to process the administrative action successfully.

  • IN_PROGRESS - Amazon FSx is processing the administrative action.

  • PENDING - Amazon FSx is waiting to process the administrative action.

  • COMPLETED - Amazon FSx has finished processing the administrative task.

  • UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. For more information, see Managing Storage Capacity .

( … recursive … )FailureDetails -> (structure)

Provides information about a failed administrative action.

Message -> (string)

Error message providing details about the failure.

FailureDetails -> (structure)

Provides information about a failed administrative action.

Message -> (string)

Error message providing details about the failure.

DirectoryInformation -> (structure)

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

DomainName -> (string)

The fully qualified domain name of the self-managed AD directory.

ActiveDirectoryId -> (string)

The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.

NextToken -> (string)

This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups.

© Copyright 2018, Amazon Web Services. Created using Sphinx.