String backupId
The ID of the backup.
String lifecycle
The lifecycle status of the backup.
BackupFailureDetails failureDetails
Details explaining any failures that occur when creating a backup.
String type
The type of the backup.
Integer progressPercent
Date creationTime
The time when a particular backup was created.
String kmsKeyId
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.
String resourceARN
The Amazon Resource Name (ARN) for the backup resource.
List<E> tags
Tags associated with a particular file system.
FileSystem fileSystem
Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
ActiveDirectoryBackupAttributes directoryInformation
The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
String message
A message describing the backup creation failure.
String fileSystemId
The ID of a file system being restored from the backup.
String fileSystemId
The ID of the file system to back up.
String clientRequestToken
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
List<E> tags
The tags to apply to the backup at backup creation. The key value of the Name tag appears in the
console as the backup name.
Backup backup
A description of the backup.
String backupId
String clientRequestToken
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
List<E> subnetIds
A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also launched in that subnet's Availability Zone.
List<E> securityGroupIds
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later describe requests.
List<E> tags
The tags to be applied to the file system at file system creation. The key value of the Name tag
appears in the console as the file system name.
CreateFileSystemWindowsConfiguration windowsConfiguration
The configuration for this Microsoft Windows file system.
FileSystem fileSystem
A description of the file system.
String weeklyMaintenanceStartTime
The preferred time to perform weekly maintenance, in the UTC time zone.
String importPath
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data
repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped
to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If
you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file
system.
String exportPath
(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the
same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed
data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not
provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp].
The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.
The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you
only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects
to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a
custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx
exports the contents of your file system to that export prefix in the Amazon S3 bucket.
Integer importedFileChunkSize
(Optional) 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 chunk size default 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.
String clientRequestToken
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
String fileSystemType
The type of Amazon FSx file system to create.
Integer storageCapacity
The storage capacity of the file system being created.
For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB.
For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB.
List<E> subnetIds
The IDs of the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also launched in that subnet's Availability Zone.
List<E> securityGroupIds
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
List<E> tags
The tags to apply to the file system being created. The key value of the Name tag appears in the
console as the file system name.
String kmsKeyId
CreateFileSystemWindowsConfiguration windowsConfiguration
The Microsoft Windows configuration for the file system being created. This value is required if
FileSystemType is set to WINDOWS.
CreateFileSystemLustreConfiguration lustreConfiguration
FileSystem fileSystem
The configuration of the file system that was created.
String activeDirectoryId
The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
SelfManagedActiveDirectoryConfiguration selfManagedActiveDirectoryConfiguration
Integer throughputCapacity
The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
String weeklyMaintenanceStartTime
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone.
String dailyAutomaticBackupStartTime
The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
Integer automaticBackupRetentionDays
The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 days.
Boolean copyTagsToBackups
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.
String importPath
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.
String exportPath
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.
Integer importedFileChunkSize
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.
String fileSystemId
The ID of the file system you want to delete.
String clientRequestToken
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.
DeleteFileSystemWindowsConfiguration windowsConfiguration
String fileSystemId
The ID of the file system being deleted.
String lifecycle
The file system lifecycle for the deletion request. Should be DELETING.
DeleteFileSystemWindowsResponse windowsResponse
Boolean skipFinalBackup
By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem
operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final
backup. If you want to skip this backup, use this flag to do so.
List<E> finalBackupTags
A set of tags for your final backup.
List<E> backupIds
(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.
List<E> filters
(Optional) Filters structure. Supported names are file-system-id and backup-type.
Integer maxResults
(Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater
than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter
specified in the request and the service's internal maximum number of items per page.
String nextToken
(Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a
token present, the action continues the list from where the returning call left off.
List<E> fileSystemIds
(Optional) IDs of the file systems whose descriptions you want to retrieve (String).
Integer maxResults
(Optional) Maximum number of file systems to return in the response (integer). This parameter value must be
greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults
parameter specified in the request and the service's internal maximum number of items per page.
String nextToken
(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String).
If a token present, the action continues the list from where the returning call left off.
String ownerId
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.
Date creationTime
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
String fileSystemId
The system-generated, unique 17-digit ID of the file system.
String fileSystemType
The type of Amazon FSx file system, either LUSTRE or WINDOWS.
String lifecycle
The lifecycle status of the file system:
AVAILABLE indicates that the file system is reachable and available for use.
CREATING indicates that Amazon FSx is in the process of creating the new file system.
DELETING indicates that Amazon FSx is in the process of deleting the file system.
FAILED indicates that Amazon FSx was not able 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.
FileSystemFailureDetails failureDetails
Integer storageCapacity
The storage capacity of the file system in gigabytes (GB).
String vpcId
The ID of the primary VPC for the file system.
List<E> subnetIds
The ID of the subnet to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.
List<E> networkInterfaceIds
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 dNSName
The DNS name for the file system.
String kmsKeyId
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.
String resourceARN
The Amazon Resource Name (ARN) for the file system resource.
List<E> tags
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
WindowsFileSystemConfiguration windowsConfiguration
The configuration for this Microsoft Windows file system.
LustreFileSystemConfiguration lustreConfiguration
String message
A message describing any failures that occurred during file system creation.
String parameter
A parameter that is incompatible with the earlier request.
String resourceARN
The ARN of the Amazon FSx resource that will have its tags listed.
Integer maxResults
(Optional) Maximum number of tags to return in the response (integer). This parameter value must be greater than
0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified
in the request and the service's internal maximum number of items per page.
String nextToken
(Optional) Opaque pagination token returned from a previous ListTagsForResource operation (String).
If a token present, the action continues the list from where the returning call left off.
String weeklyMaintenanceStartTime
The UTC time that you want to begin your weekly maintenance window.
DataRepositoryConfiguration dataRepositoryConfiguration
String resourceARN
The Amazon Resource Name (ARN) of the non-Amazon FSx resource.
String resourceARN
The Amazon Resource Name (ARN) of the resource that doesn't support tagging.
String resourceARN
The resource ARN of the resource that can't be found.
String domainName
The fully qualified domain name of the self-managed AD directory.
String organizationalUnitDistinguishedName
The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.
String fileSystemAdministratorsGroup
The name of the domain group whose members have administrative privileges for the FSx file system.
String userName
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
List<E> dnsIps
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
String domainName
The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
String organizationalUnitDistinguishedName
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD
directory that the Windows File Server instance will join. Amazon FSx only accepts OU as the direct parent of the
file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in
the default location of your self-managed AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
String fileSystemAdministratorsGroup
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
String userName
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
domain. This account must have the permission to join computers to the domain in the organizational unit provided
in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.
String password
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
List<E> dnsIps
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (Iv4) address ranges, as specified in RFC 1918:
10.0.0.0 - 10.255.255.255 (10/8 prefix)
172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
String userName
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
domain. This account must have the permission to join computers to the domain in the organizational unit provided
in OrganizationalUnitDistinguishedName.
String password
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
List<E> dnsIps
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
String limit
Enumeration of the service limit that was exceeded.
String key
A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to
which they are attached.
String value
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.
String weeklyMaintenanceStartTime
The preferred time to perform weekly maintenance, in the UTC time zone.
String fileSystemId
String clientRequestToken
(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
UpdateFileSystemWindowsConfiguration windowsConfiguration
The configuration update for this Microsoft Windows file system. The only supported options are for backup and maintenance and for self-managed Active Directory configuration.
UpdateFileSystemLustreConfiguration lustreConfiguration
FileSystem fileSystem
A description of the file system that was updated.
String weeklyMaintenanceStartTime
The preferred time to perform weekly maintenance, in the UTC time zone.
String dailyAutomaticBackupStartTime
The preferred time to take daily automatic backups, in the UTC time zone.
Integer automaticBackupRetentionDays
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.
SelfManagedActiveDirectoryConfigurationUpdates selfManagedActiveDirectoryConfiguration
The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory.
String activeDirectoryId
The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.
SelfManagedActiveDirectoryAttributes selfManagedActiveDirectoryConfiguration
Integer throughputCapacity
The throughput of an Amazon FSx file system, measured in megabytes per second.
List<E> maintenanceOperationsInProgress
The list of maintenance operations in progress for this file system.
String weeklyMaintenanceStartTime
The preferred time to perform weekly maintenance, in the UTC time zone.
String dailyAutomaticBackupStartTime
The preferred time to take daily automatic backups, in the UTC time zone.
Integer automaticBackupRetentionDays
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.
Boolean copyTagsToBackups
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.
Copyright © 2019. All rights reserved.