# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::FSx module Types # The Microsoft Active Directory attributes of the Amazon FSx for # Windows File Server file system. # # @!attribute [rw] domain_name # The fully qualified domain name of the self-managed Active Directory # directory. # @return [String] # # @!attribute [rw] active_directory_id # The ID of the Amazon Web Services Managed Microsoft Active Directory # instance to which the file system is joined. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ActiveDirectoryBackupAttributes AWS API Documentation # class ActiveDirectoryBackupAttributes < Struct.new( :domain_name, :active_directory_id, :resource_arn) SENSITIVE = [] include Aws::Structure end # An Active Directory error. # # @!attribute [rw] active_directory_id # The directory ID of the directory that an error pertains to. # @return [String] # # @!attribute [rw] type # The type of Active Directory error. # @return [String] # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ActiveDirectoryError AWS API Documentation # class ActiveDirectoryError < Struct.new( :active_directory_id, :type, :message) SENSITIVE = [] include Aws::Structure end # Describes a specific Amazon FSx administrative action for the current # Windows, Lustre, OpenZFS, or ONTAP file system or volume. # # @!attribute [rw] administrative_action_type # Describes the type of administrative action, as follows: # # * `FILE_SYSTEM_UPDATE` - A file system update administrative action # initiated from the Amazon FSx console, API (`UpdateFileSystem`), # or CLI (`update-file-system`). # # * `THROUGHPUT_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task to # increase a file system's throughput capacity has been completed # successfully, a `THROUGHPUT_OPTIMIZATION` task starts. # # You can track the storage-optimization progress using the # `ProgressPercent` property. When `THROUGHPUT_OPTIMIZATION` has # been completed successfully, the parent `FILE_SYSTEM_UPDATE` # action status changes to `COMPLETED`. For more information, see # [Managing throughput capacity][1] in the *Amazon FSx for Windows # File Server User Guide*. # # * `STORAGE_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task to # increase a file system's storage capacity has completed # successfully, a `STORAGE_OPTIMIZATION` task starts. # # * For Windows and ONTAP, storage optimization is the process of # migrating the file system data to newer larger disks. # # * For Lustre, storage optimization consists of rebalancing the # data across the existing and newly added file servers. # # You can track the storage-optimization progress using the # `ProgressPercent` property. When `STORAGE_OPTIMIZATION` has been # completed successfully, the parent `FILE_SYSTEM_UPDATE` action # status changes to `COMPLETED`. For more information, see [Managing # storage capacity][2] in the *Amazon FSx for Windows File Server # User Guide*, [Managing storage capacity][3] in the *Amazon FSx for # Lustre User Guide*, and [Managing storage capacity and provisioned # IOPS][4] in the *Amazon FSx for NetApp ONTAP User Guide*. # # * `FILE_SYSTEM_ALIAS_ASSOCIATION` - A file system update to # associate a new Domain Name System (DNS) alias with the file # system. For more information, see [ # AssociateFileSystemAliases][5]. # # * `FILE_SYSTEM_ALIAS_DISASSOCIATION` - A file system update to # disassociate a DNS alias from the file system. For more # information, see [DisassociateFileSystemAliases][6]. # # * `IOPS_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task to # increase a file system's throughput capacity has been completed # successfully, a `IOPS_OPTIMIZATION` task starts. # # You can track the storage-optimization progress using the # `ProgressPercent` property. When `IOPS_OPTIMIZATION` has been # completed successfully, the parent `FILE_SYSTEM_UPDATE` action # status changes to `COMPLETED`. For more information, see [Managing # provisioned SSD IOPS][7] in the Amazon FSx for Windows File Server # User Guide. # # * `STORAGE_TYPE_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task # to increase a file system's throughput capacity has been # completed successfully, a `STORAGE_TYPE_OPTIMIZATION` task starts. # # You can track the storage-optimization progress using the # `ProgressPercent` property. When `STORAGE_TYPE_OPTIMIZATION` has # been completed successfully, the parent `FILE_SYSTEM_UPDATE` # action status changes to `COMPLETED`. # # * `VOLUME_UPDATE` - A volume update to an Amazon FSx for OpenZFS # volume initiated from the Amazon FSx console, API # (`UpdateVolume`), or CLI (`update-volume`). # # * `VOLUME_RESTORE` - An Amazon FSx for OpenZFS volume is returned to # the state saved by the specified snapshot, initiated from an API # (`RestoreVolumeFromSnapshot`) or CLI # (`restore-volume-from-snapshot`). # # * `SNAPSHOT_UPDATE` - A snapshot update to an Amazon FSx for OpenZFS # volume initiated from the Amazon FSx console, API # (`UpdateSnapshot`), or CLI (`update-snapshot`). # # * `RELEASE_NFS_V3_LOCKS` - Tracks the release of Network File System # (NFS) V3 locks on an Amazon FSx for OpenZFS file system. # # * `DOWNLOAD_DATA_FROM_BACKUP` - An FSx for ONTAP backup is being # restored to a new volume on a second-generation file system. Once # the all the file metadata is loaded onto the volume, you can mount # the volume with read-only access. during this process. # # * `VOLUME_INITIALIZE_WITH_SNAPSHOT` - A volume is being created from # a snapshot on a different FSx for OpenZFS file system. You can # initiate this from the Amazon FSx console, API (`CreateVolume`), # or CLI (`create-volume`) when using the using the `FULL_COPY` # strategy. # # * `VOLUME_UPDATE_WITH_SNAPSHOT` - A volume is being updated from a # snapshot on a different FSx for OpenZFS file system. You can # initiate this from the Amazon FSx console, API # (`CopySnapshotAndUpdateVolume`), or CLI # (`copy-snapshot-and-update-volume`). # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html # [2]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html # [3]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html # [4]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html # [5]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html # [6]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html # [7]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-provisioned-ssd-iops.html # @return [String] # # @!attribute [rw] progress_percent # The percentage-complete status of a `STORAGE_OPTIMIZATION` or # `DOWNLOAD_DATA_FROM_BACKUP` administrative action. Does not apply to # any other administrative action type. # @return [Integer] # # @!attribute [rw] request_time # The time that the administrative action request was received. # @return [Time] # # @!attribute [rw] status # 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. # # For a backup restore to a second-generation FSx for ONTAP file # system, indicates that all data has been downloaded to the volume, # and clients now have read-write access to volume. # # * `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. # # * `PENDING` - For a backup restore to a second-generation FSx for # ONTAP file system, indicates that the file metadata is being # downloaded onto the volume. The volume's Lifecycle state is # CREATING. # # * `IN_PROGRESS` - For a backup restore to a second-generation FSx # for ONTAP file system, indicates that all metadata has been # downloaded to the new volume and client can access data with # read-only access while Amazon FSx downloads the file data to the # volume. Track the progress of this process with the # `ProgressPercent` element. # @return [String] # # @!attribute [rw] target_file_system_values # The target value for the administration action, provided in the # `UpdateFileSystem` operation. Returned for `FILE_SYSTEM_UPDATE` # administrative actions. # @return [Types::FileSystem] # # @!attribute [rw] failure_details # Provides information about a failed administrative action. # @return [Types::AdministrativeActionFailureDetails] # # @!attribute [rw] target_volume_values # Describes an Amazon FSx volume. # @return [Types::Volume] # # @!attribute [rw] target_snapshot_values # A snapshot of an Amazon FSx for OpenZFS volume. # @return [Types::Snapshot] # # @!attribute [rw] total_transfer_bytes # The number of bytes that have transferred for the FSx for OpenZFS # snapshot that you're copying. # @return [Integer] # # @!attribute [rw] remaining_transfer_bytes # The remaining bytes to transfer for the FSx for OpenZFS snapshot # that you're copying. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AdministrativeAction AWS API Documentation # class AdministrativeAction < Struct.new( :administrative_action_type, :progress_percent, :request_time, :status, :target_file_system_values, :failure_details, :target_volume_values, :target_snapshot_values, :total_transfer_bytes, :remaining_transfer_bytes) SENSITIVE = [] include Aws::Structure end # Provides information about a failed administrative action. # # @!attribute [rw] message # Error message providing details about the failed administrative # action. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AdministrativeActionFailureDetails AWS API Documentation # class AdministrativeActionFailureDetails < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Used to specify configuration options for a volume’s storage aggregate # or aggregates. # # @!attribute [rw] aggregates # The list of aggregates that this volume resides on. Aggregates are # storage pools which make up your primary storage tier. Each # high-availability (HA) pair has one aggregate. The names of the # aggregates map to the names of the aggregates in the ONTAP CLI and # REST API. For FlexVols, there will always be a single entry. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The strings in the value of `Aggregates` are not are not formatted # as `aggrX`, where X is a number between 1 and 12. # # * The value of `Aggregates` contains aggregates that are not # present. # # * One or more of the aggregates supplied are too close to the volume # limit to support adding more volumes. # @return [Array] # # @!attribute [rw] total_constituents # The total number of constituents this FlexGroup volume has. Not # applicable for FlexVols. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AggregateConfiguration AWS API Documentation # class AggregateConfiguration < Struct.new( :aggregates, :total_constituents) SENSITIVE = [] include Aws::Structure end # A DNS alias that is associated with the file system. You can use a DNS # alias to access a file system using user-defined DNS names, in # addition to the default DNS name that Amazon FSx assigns to the file # system. For more information, see [DNS aliases][1] in the *FSx for # Windows File Server User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html # # @!attribute [rw] name # The name of the DNS alias. The alias name has to meet the following # requirements: # # * Formatted as a fully-qualified domain name (FQDN), # `hostname.domain`, for example, `accounting.example.com`. # # * Can contain alphanumeric characters, the underscore (\_), and the # hyphen (-). # # * Cannot start or end with a hyphen. # # * Can start with a numeric. # # For DNS names, Amazon FSx stores alphabetic characters as lowercase # letters (a-z), regardless of how you specify them: as uppercase # letters, lowercase letters, or the corresponding letters in escape # codes. # @return [String] # # @!attribute [rw] lifecycle # Describes the state of the DNS alias. # # * AVAILABLE - The DNS alias is associated with an Amazon FSx file # system. # # * CREATING - Amazon FSx is creating the DNS alias and associating it # with the file system. # # * CREATE\_FAILED - Amazon FSx was unable to associate the DNS alias # with the file system. # # * DELETING - Amazon FSx is disassociating the DNS alias from the # file system and deleting it. # # * DELETE\_FAILED - Amazon FSx was unable to disassociate the DNS # alias from the file system. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Alias AWS API Documentation # class Alias < Struct.new( :name, :lifecycle) SENSITIVE = [] include Aws::Structure end # The request object specifying one or more DNS alias names to associate # with an Amazon FSx for Windows File Server file system. # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] file_system_id # Specifies the file system with which you want to associate one or # more DNS aliases. # @return [String] # # @!attribute [rw] aliases # An array of one or more DNS alias names to associate with the file # system. The alias name has to comply with the following formatting # requirements: # # * Formatted as a fully-qualified domain name (FQDN), # hostname.domain , for example, # `accounting.corp.example.com`. # # * Can contain alphanumeric characters and the hyphen (-). # # * Cannot start or end with a hyphen. # # * Can start with a numeric. # # For DNS alias names, Amazon FSx stores alphabetic characters as # lowercase letters (a-z), regardless of how you specify them: as # uppercase letters, lowercase letters, or the corresponding letters # in escape codes. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AssociateFileSystemAliasesRequest AWS API Documentation # class AssociateFileSystemAliasesRequest < Struct.new( :client_request_token, :file_system_id, :aliases) SENSITIVE = [] include Aws::Structure end # The system generated response showing the DNS aliases that Amazon FSx # is attempting to associate with the file system. Use the API operation # to monitor the status of the aliases Amazon FSx is associating with # the file system. It can take up to 2.5 minutes for the alias status to # change from `CREATING` to `AVAILABLE`. # # @!attribute [rw] aliases # An array of the DNS aliases that Amazon FSx is associating with the # file system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AssociateFileSystemAliasesResponse AWS API Documentation # class AssociateFileSystemAliasesResponse < Struct.new( :aliases) SENSITIVE = [] include Aws::Structure end # Describes a data repository association's automatic export policy. # The `AutoExportPolicy` defines the types of updated objects on the # file system that will be automatically exported to the data # repository. As you create, modify, or delete files, Amazon FSx for # Lustre automatically exports the defined changes asynchronously once # your application finishes modifying the file. # # The `AutoExportPolicy` is only supported on Amazon FSx for Lustre file # systems with a data repository association. # # @!attribute [rw] events # The `AutoExportPolicy` can have the following event values: # # * `NEW` - New files and directories are automatically exported to # the data repository as they are added to the file system. # # * `CHANGED` - Changes to files and directories on the file system # are automatically exported to the data repository. # # * `DELETED` - Files and directories are automatically deleted on the # data repository when they are deleted on the file system. # # You can define any combination of event types for your # `AutoExportPolicy`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AutoExportPolicy AWS API Documentation # class AutoExportPolicy < Struct.new( :events) SENSITIVE = [] include Aws::Structure end # Describes the data repository association's automatic import policy. # The AutoImportPolicy defines how Amazon FSx keeps your file metadata # and directory listings up to date by importing changes to your Amazon # FSx for Lustre file system as you modify objects in a linked S3 # bucket. # # The `AutoImportPolicy` is only supported on Amazon FSx for Lustre file # systems with a data repository association. # # @!attribute [rw] events # The `AutoImportPolicy` can have the following event values: # # * `NEW` - Amazon FSx automatically imports metadata of files added # to the linked S3 bucket that do not currently exist in the FSx # file system. # # * `CHANGED` - Amazon FSx automatically updates file metadata and # invalidates existing file content on the file system as files # change in the data repository. # # * `DELETED` - Amazon FSx automatically deletes files on the file # system as corresponding files are deleted in the data repository. # # You can define any combination of event types for your # `AutoImportPolicy`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AutoImportPolicy AWS API Documentation # class AutoImportPolicy < Struct.new( :events) SENSITIVE = [] include Aws::Structure end # Sets the autocommit period of files in an FSx for ONTAP SnapLock # volume, which determines how long the files must remain unmodified # before they're automatically transitioned to the write once, read # many (WORM) state. # # For more information, see [Autocommit][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-autocommit # # @!attribute [rw] type # Defines the type of time for the autocommit period of a file in an # FSx for ONTAP SnapLock volume. Setting this value to `NONE` disables # autocommit. The default value is `NONE`. # @return [String] # # @!attribute [rw] value # Defines the amount of time for the autocommit period of a file in an # FSx for ONTAP SnapLock volume. The following ranges are valid: # # * `Minutes`: 5 - 65,535 # # * `Hours`: 1 - 65,535 # # * `Days`: 1 - 3,650 # # * `Months`: 1 - 120 # # * `Years`: 1 - 10 # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AutocommitPeriod AWS API Documentation # class AutocommitPeriod < Struct.new( :type, :value) SENSITIVE = [] include Aws::Structure end # A backup of an Amazon FSx for Windows File Server, Amazon FSx for # Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx # for OpenZFS file system. # # @!attribute [rw] backup_id # The ID of the backup. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the backup. # # * `AVAILABLE` - The backup is fully available. # # * `PENDING` - For user-initiated backups on Lustre file systems # only; Amazon FSx hasn't started creating the backup. # # * `CREATING` - Amazon FSx is creating the backup. # # * `TRANSFERRING` - For user-initiated backups on Lustre file systems # only; Amazon FSx is transferring the backup to Amazon S3. # # * `COPYING` - Amazon FSx is copying the backup. # # * `DELETED` - Amazon FSx deleted the backup and it's no longer # available. # # * `FAILED` - Amazon FSx couldn't finish the backup. # @return [String] # # @!attribute [rw] failure_details # Details explaining any failures that occurred when creating a # backup. # @return [Types::BackupFailureDetails] # # @!attribute [rw] type # The type of the file-system backup. # @return [String] # # @!attribute [rw] progress_percent # Displays the current percent of progress of an asynchronous task. # @return [Integer] # # @!attribute [rw] creation_time # The time when a particular backup was created. # @return [Time] # # @!attribute [rw] kms_key_id # The ID of the Key Management Service (KMS) key used to encrypt the # backup of the Amazon FSx file system's data at rest. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for the backup resource. # @return [String] # # @!attribute [rw] tags # The tags associated with a particular file system. # @return [Array] # # @!attribute [rw] file_system # The metadata of the file system associated with the backup. This # metadata is persisted even if the file system is deleted. # @return [Types::FileSystem] # # @!attribute [rw] directory_information # The configuration of the self-managed Microsoft Active Directory # directory to which the Windows File Server instance is joined. # @return [Types::ActiveDirectoryBackupAttributes] # # @!attribute [rw] owner_id # An Amazon Web Services account ID. This ID is a 12-digit number that # you use to construct Amazon Resource Names (ARNs) for resources. # @return [String] # # @!attribute [rw] source_backup_id # The ID of the source backup. Specifies the backup that you are # copying. # @return [String] # # @!attribute [rw] source_backup_region # The source Region of the backup. Specifies the Region from where # this backup is copied. # @return [String] # # @!attribute [rw] resource_type # Specifies the resource type that's backed up. # @return [String] # # @!attribute [rw] volume # Describes an Amazon FSx volume. # @return [Types::Volume] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Backup AWS API Documentation # class Backup < Struct.new( :backup_id, :lifecycle, :failure_details, :type, :progress_percent, :creation_time, :kms_key_id, :resource_arn, :tags, :file_system, :directory_information, :owner_id, :source_backup_id, :source_backup_region, :resource_type, :volume) SENSITIVE = [] include Aws::Structure end # You can't delete a backup while it's being copied. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @!attribute [rw] backup_id # The ID of the source backup. Specifies the backup that you are # copying. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupBeingCopied AWS API Documentation # class BackupBeingCopied < Struct.new( :message, :backup_id) SENSITIVE = [] include Aws::Structure end # If backup creation fails, this structure contains the details of that # failure. # # @!attribute [rw] message # A message describing the backup-creation failure. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupFailureDetails AWS API Documentation # class BackupFailureDetails < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Another backup is already under way. Wait for completion before # initiating additional backups of this file system. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupInProgress AWS API Documentation # class BackupInProgress < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # No Amazon FSx backups were found based upon the supplied parameters. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupNotFound AWS API Documentation # class BackupNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # You can't delete a backup while it's being used to restore a file # system. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @!attribute [rw] file_system_id # The ID of a file system being restored from the backup. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupRestoring AWS API Documentation # class BackupRestoring < Struct.new( :message, :file_system_id) SENSITIVE = [] include Aws::Structure end # A generic error indicating a failure with a client request. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BadRequest AWS API Documentation # class BadRequest < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Cancels a data repository task. # # @!attribute [rw] task_id # Specifies the data repository task to cancel. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CancelDataRepositoryTaskRequest AWS API Documentation # class CancelDataRepositoryTaskRequest < Struct.new( :task_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] lifecycle # The lifecycle status of the data repository task, as follows: # # * `PENDING` - Amazon FSx has not started the task. # # * `EXECUTING` - Amazon FSx is processing the task. # # * `FAILED` - Amazon FSx was not able to complete the task. For # example, there may be files the task failed to process. The # DataRepositoryTaskFailureDetails property provides more # information about task failures. # # * `SUCCEEDED` - FSx completed the task successfully. # # * `CANCELED` - Amazon FSx canceled the task and it did not complete. # # * `CANCELING` - FSx is in process of canceling the task. # @return [String] # # @!attribute [rw] task_id # The ID of the task being canceled. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CancelDataRepositoryTaskResponse AWS API Documentation # class CancelDataRepositoryTaskResponse < Struct.new( :lifecycle, :task_id) SENSITIVE = [] include Aws::Structure end # Provides a report detailing the data repository task results of the # files processed that match the criteria specified in the report # `Scope` parameter. FSx delivers the report to the file system's # linked data repository in Amazon S3, using the path specified in the # report `Path` parameter. You can specify whether or not a report gets # generated for a task using the `Enabled` parameter. # # @!attribute [rw] enabled # Set `Enabled` to `True` to generate a `CompletionReport` when the # task completes. If set to `true`, then you need to provide a report # `Scope`, `Path`, and `Format`. Set `Enabled` to `False` if you do # not want a `CompletionReport` generated when the task completes. # @return [Boolean] # # @!attribute [rw] path # Required if `Enabled` is set to `true`. Specifies the location of # the report on the file system's linked S3 data repository. An # absolute path that defines where the completion report will be # stored in the destination location. The `Path` you provide must be # located within the file system’s ExportPath. An example `Path` value # is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix". The # report provides the following information for each file in the # report: FilePath, FileStatus, and ErrorCode. # @return [String] # # @!attribute [rw] format # Required if `Enabled` is set to `true`. Specifies the format of the # `CompletionReport`. `REPORT_CSV_20191124` is the only format # currently supported. When `Format` is set to `REPORT_CSV_20191124`, # the `CompletionReport` is provided in CSV format, and is delivered # to `\{path\}/task-\{id\}/failures.csv`. # @return [String] # # @!attribute [rw] scope # Required if `Enabled` is set to `true`. Specifies the scope of the # `CompletionReport`; `FAILED_FILES_ONLY` is the only scope currently # supported. When `Scope` is set to `FAILED_FILES_ONLY`, the # `CompletionReport` only contains information about files that the # data repository task failed to process. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CompletionReport AWS API Documentation # class CompletionReport < Struct.new( :enabled, :path, :format, :scope) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] source_backup_id # The ID of the source backup. Specifies the ID of the backup that's # being copied. # @return [String] # # @!attribute [rw] source_region # The source Amazon Web Services Region of the backup. Specifies the # Amazon Web Services Region from which the backup is being copied. # The source and destination Regions must be in the same Amazon Web # Services partition. If you don't specify a Region, `SourceRegion` # defaults to the Region where the request is sent from (in-Region # copy). # @return [String] # # @!attribute [rw] kms_key_id # Specifies the ID of the Key Management Service (KMS) key to use for # encrypting data on Amazon FSx file systems, as follows: # # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment # types only. # # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon # FSx service KMS key for your account. # # * Amazon FSx for NetApp ONTAP # # * Amazon FSx for OpenZFS # # * Amazon FSx for Windows File Server # # If a `KmsKeyId` isn't specified, the Amazon FSx-managed KMS key for # your account is used. For more information, see [Encrypt][1] in the # *Key Management Service API Reference*. # # # # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html # @return [String] # # @!attribute [rw] copy_tags # A Boolean flag indicating whether tags from the source backup should # be copied to the backup copy. This value defaults to `false`. # # If you set `CopyTags` to `true` and the source backup has existing # tags, you can use the `Tags` parameter to create new tags, provided # that the sum of the source backup tags and the new tags doesn't # exceed 50. Both sets of tags are merged. If there are tag conflicts # (for example, two tags with the same key but different values), the # tags created with the `Tags` parameter take precedence. # @return [Boolean] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopyBackupRequest AWS API Documentation # class CopyBackupRequest < Struct.new( :client_request_token, :source_backup_id, :source_region, :kms_key_id, :copy_tags, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] backup # A backup of an Amazon FSx for Windows File Server, Amazon FSx for # Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon # FSx for OpenZFS file system. # @return [Types::Backup] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopyBackupResponse AWS API Documentation # class CopyBackupResponse < Struct.new( :backup) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] volume_id # Specifies the ID of the volume that you are copying the snapshot to. # @return [String] # # @!attribute [rw] source_snapshot_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] copy_strategy # Specifies the strategy to use when copying data from a snapshot to # the volume. # # * `FULL_COPY` - Copies all data from the snapshot to the volume. # # * `INCREMENTAL_COPY` - Copies only the snapshot data that's changed # since the previous replication. # # `CLONE` isn't a valid copy strategy option for the # `CopySnapshotAndUpdateVolume` operation. # # # @return [String] # # @!attribute [rw] options # Confirms that you want to delete data on the destination volume that # wasn’t there during the previous snapshot replication. # # Your replication will fail if you don’t include an option for a # specific type of data and that data is on your destination. For # example, if you don’t include `DELETE_INTERMEDIATE_SNAPSHOTS` and # there are intermediate snapshots on the destination, you can’t copy # the snapshot. # # * `DELETE_INTERMEDIATE_SNAPSHOTS` - Deletes snapshots on the # destination volume that aren’t on the source volume. # # * `DELETE_CLONED_VOLUMES` - Deletes snapshot clones on the # destination volume that aren't on the source volume. # # * `DELETE_INTERMEDIATE_DATA` - Overwrites snapshots on the # destination volume that don’t match the source snapshot that # you’re copying. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopySnapshotAndUpdateVolumeRequest AWS API Documentation # class CopySnapshotAndUpdateVolumeRequest < Struct.new( :client_request_token, :volume_id, :source_snapshot_arn, :copy_strategy, :options) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volume_id # The ID of the volume that you copied the snapshot to. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle state of the destination volume. # @return [String] # # @!attribute [rw] administrative_actions # A list of administrative actions for the file system that are in # process or waiting to be processed. Administrative actions describe # changes to the Amazon FSx system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopySnapshotAndUpdateVolumeResponse AWS API Documentation # class CopySnapshotAndUpdateVolumeResponse < Struct.new( :volume_id, :lifecycle, :administrative_actions) SENSITIVE = [] include Aws::Structure end # Used to specify the configuration options for an FSx for ONTAP # volume's storage aggregate or aggregates. # # @!attribute [rw] aggregates # Used to specify the names of aggregates on which the volume will be # created. # @return [Array] # # @!attribute [rw] constituents_per_aggregate # Used to explicitly set the number of constituents within the # FlexGroup per storage aggregate. This field is optional when # creating a FlexGroup volume. If unspecified, the default value will # be 8. This field cannot be provided when creating a FlexVol volume. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateAggregateConfiguration AWS API Documentation # class CreateAggregateConfiguration < Struct.new( :aggregates, :constituents_per_aggregate) SENSITIVE = [] include Aws::Structure end # The request object for the `CreateBackup` operation. # # @!attribute [rw] file_system_id # The ID of the file system to back up. # @return [String] # # @!attribute [rw] client_request_token # (Optional) A string of up to 63 ASCII characters that Amazon FSx # uses to ensure idempotent creation. This string is automatically # filled on your behalf when you use the Command Line Interface (CLI) # or an Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] tags # (Optional) 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. If you have set `CopyTagsToBackups` to `true`, and you specify # one or more tags using the `CreateBackup` operation, no existing # file system tags are copied from the file system to the backup. # @return [Array] # # @!attribute [rw] volume_id # (Optional) The ID of the FSx for ONTAP volume to back up. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupRequest AWS API Documentation # class CreateBackupRequest < Struct.new( :file_system_id, :client_request_token, :tags, :volume_id) SENSITIVE = [] include Aws::Structure end # The response object for the `CreateBackup` operation. # # @!attribute [rw] backup # A description of the backup. # @return [Types::Backup] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupResponse AWS API Documentation # class CreateBackupResponse < Struct.new( :backup) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @!attribute [rw] file_system_path # A path on the file system that points to a high-level directory # (such as `/ns1/`) or subdirectory (such as `/ns1/subdir/`) that will # be mapped 1-1 with `DataRepositoryPath`. The leading forward slash # in the name is required. Two data repository associations cannot # have overlapping file system paths. For example, if a data # repository is associated with file system path `/ns1/`, then you # cannot link another data repository with file system path # `/ns1/ns2`. # # This path specifies where in your file system files will be exported # from or imported to. This file system directory can be linked to # only one Amazon S3 bucket, and no other S3 bucket can be linked to # the directory. # # If you specify only a forward slash (`/`) as the file system path, # you can link only one data repository to the file system. You can # only specify "/" as the file system path for the first data # repository associated with a file system. # # # @return [String] # # @!attribute [rw] data_repository_path # The path to the Amazon S3 data repository that will be linked to the # file system. The path can be an S3 bucket or prefix in the format # `s3://bucket-name/prefix/` (where `prefix` is optional). This path # specifies where in the S3 data repository files will be imported # from or exported to. # @return [String] # # @!attribute [rw] batch_import_meta_data_on_create # Set to `true` to run an import data repository task to import # metadata from the data repository to the file system after the data # repository association is created. Default is `false`. # @return [Boolean] # # @!attribute [rw] imported_file_chunk_size # 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. # @return [Integer] # # @!attribute [rw] s3 # The configuration for an Amazon S3 data repository linked to an # Amazon FSx Lustre file system with a data repository association. # The configuration defines which file events (new, changed, or # deleted files or directories) are automatically imported from the # linked data repository to the file system or automatically exported # from the file system to the data repository. # @return [Types::S3DataRepositoryConfiguration] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateDataRepositoryAssociationRequest AWS API Documentation # class CreateDataRepositoryAssociationRequest < Struct.new( :file_system_id, :file_system_path, :data_repository_path, :batch_import_meta_data_on_create, :imported_file_chunk_size, :s3, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] association # The response object returned after the data repository association # is created. # @return [Types::DataRepositoryAssociation] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateDataRepositoryAssociationResponse AWS API Documentation # class CreateDataRepositoryAssociationResponse < Struct.new( :association) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] type # Specifies the type of data repository task to create. # # * `EXPORT_TO_REPOSITORY` tasks export from your Amazon FSx for # Lustre file system to a linked data repository. # # * `IMPORT_METADATA_FROM_REPOSITORY` tasks import metadata changes # from a linked S3 bucket to your Amazon FSx for Lustre file system. # # * `RELEASE_DATA_FROM_FILESYSTEM` tasks release files in your Amazon # FSx for Lustre file system that have been exported to a linked S3 # bucket and that meet your specified release criteria. # # * `AUTO_RELEASE_DATA` tasks automatically release files from an # Amazon File Cache resource. # @return [String] # # @!attribute [rw] paths # A list of paths for the data repository task to use when the task is # processed. If a path that you provide isn't valid, the task fails. # If you don't provide paths, the default behavior is to export all # files to S3 (for export tasks), import all files from S3 (for import # tasks), or release all exported files that meet the last accessed # time criteria (for release tasks). # # * For export tasks, the list contains paths on the FSx for Lustre # file system from which the files are exported to the Amazon S3 # bucket. The default path is the file system root directory. The # paths you provide need to be relative to the mount point of the # file system. If the mount point is `/mnt/fsx` and `/mnt/fsx/path1` # is a directory or file on the file system you want to export, then # the path to provide is `path1`. # # * For import tasks, the list contains paths in the Amazon S3 bucket # from which POSIX metadata changes are imported to the FSx for # Lustre file system. The path can be an S3 bucket or prefix in the # format `s3://bucket-name/prefix` (where `prefix` is optional). # # * For release tasks, the list contains directory or file paths on # the FSx for Lustre file system from which to release exported # files. If a directory is specified, files within the directory are # released. If a file path is specified, only that file is released. # To release all exported files in the file system, specify a # forward slash (/) as the path. # # A file must also meet the last accessed time criteria specified in # for the file to be released. # # # @return [Array] # # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @!attribute [rw] report # Defines whether or not Amazon FSx provides a CompletionReport once # the task has completed. A CompletionReport provides a detailed # report on the files that Amazon FSx processed that meet the criteria # specified by the `Scope` parameter. For more information, see # [Working with Task Completion Reports][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html # @return [Types::CompletionReport] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] capacity_to_release # Specifies the amount of data to release, in GiB, by an Amazon File # Cache `AUTO_RELEASE_DATA` task that automatically releases files # from the cache. # @return [Integer] # # @!attribute [rw] release_configuration # The configuration that specifies the last accessed time criteria for # files that will be released from an Amazon FSx for Lustre file # system. # @return [Types::ReleaseConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateDataRepositoryTaskRequest AWS API Documentation # class CreateDataRepositoryTaskRequest < Struct.new( :type, :paths, :file_system_id, :report, :client_request_token, :tags, :capacity_to_release, :release_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_repository_task # The description of the data repository task that you just created. # @return [Types::DataRepositoryTask] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateDataRepositoryTaskResponse AWS API Documentation # class CreateDataRepositoryTaskResponse < Struct.new( :data_repository_task) SENSITIVE = [] include Aws::Structure end # The Amazon File Cache configuration for the cache that you are # creating. # # @!attribute [rw] per_unit_storage_throughput # Provisions the amount of read and write throughput for each 1 # tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only # supported value is `1000`. # @return [Integer] # # @!attribute [rw] deployment_type # Specifies the cache deployment type, which must be `CACHE_1`. # @return [String] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] metadata_configuration # The configuration for a Lustre MDT (Metadata Target) storage volume. # @return [Types::FileCacheLustreMetadataConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileCacheLustreConfiguration AWS API Documentation # class CreateFileCacheLustreConfiguration < Struct.new( :per_unit_storage_throughput, :deployment_type, :weekly_maintenance_start_time, :metadata_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # An idempotency token for resource creation, in a string of up to 63 # ASCII characters. This token is automatically filled on your behalf # when you use the Command Line Interface (CLI) or an Amazon Web # Services SDK. # # By using the idempotent operation, you can retry a `CreateFileCache` # operation without the risk of creating an extra cache. This approach # can be useful when an initial call fails in a way that makes it # unclear whether a cache was created. Examples are if a transport # level timeout occurred, or your connection was reset. If you use the # same client request token and the initial call created a cache, the # client receives success as long as the parameters are the same. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] file_cache_type # The type of cache that you're creating, which must be `LUSTRE`. # @return [String] # # @!attribute [rw] file_cache_type_version # Sets the Lustre version for the cache that you're creating, which # must be `2.12`. # @return [String] # # @!attribute [rw] storage_capacity # The storage capacity of the cache in gibibytes (GiB). Valid values # are 1200 GiB, 2400 GiB, and increments of 2400 GiB. # @return [Integer] # # @!attribute [rw] subnet_ids # A list of subnet IDs that the cache will be accessible from. You can # specify only one subnet ID in a call to the `CreateFileCache` # operation. # @return [Array] # # @!attribute [rw] security_group_ids # A list of IDs specifying the security groups to apply to all network # interfaces created for Amazon File Cache access. This list isn't # returned in later requests to describe the cache. # @return [Array] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] copy_tags_to_data_repository_associations # A boolean flag indicating whether tags for the cache should be # copied to data repository associations. This value defaults to # false. # @return [Boolean] # # @!attribute [rw] kms_key_id # Specifies the ID of the Key Management Service (KMS) key to use for # encrypting data on an Amazon File Cache. If a `KmsKeyId` isn't # specified, the Amazon FSx-managed KMS key for your account is used. # For more information, see [Encrypt][1] in the *Key Management # Service API Reference*. # # # # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html # @return [String] # # @!attribute [rw] lustre_configuration # The configuration for the Amazon File Cache resource being created. # @return [Types::CreateFileCacheLustreConfiguration] # # @!attribute [rw] data_repository_associations # A list of up to 8 configurations for data repository associations # (DRAs) to be created during the cache creation. The DRAs link the # cache to either an Amazon S3 data repository or a Network File # System (NFS) data repository that supports the NFSv3 protocol. # # The DRA configurations must meet the following requirements: # # * All configurations on the list must be of the same data repository # type, either all S3 or all NFS. A cache can't link to different # data repository types at the same time. # # * An NFS DRA must link to an NFS file system that supports the NFSv3 # protocol. # # DRA automatic import and automatic export is not supported. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileCacheRequest AWS API Documentation # class CreateFileCacheRequest < Struct.new( :client_request_token, :file_cache_type, :file_cache_type_version, :storage_capacity, :subnet_ids, :security_group_ids, :tags, :copy_tags_to_data_repository_associations, :kms_key_id, :lustre_configuration, :data_repository_associations) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_cache # A description of the cache that was created. # @return [Types::FileCacheCreating] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileCacheResponse AWS API Documentation # class CreateFileCacheResponse < Struct.new( :file_cache) SENSITIVE = [] include Aws::Structure end # The request object for the `CreateFileSystemFromBackup` operation. # # @!attribute [rw] backup_id # The ID of the source backup. Specifies the backup that you are # copying. # @return [String] # # @!attribute [rw] client_request_token # A string of up to 63 ASCII characters that Amazon FSx uses to ensure # idempotent creation. This string is automatically filled on your # behalf when you use the Command Line Interface (CLI) or an Amazon # Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] subnet_ids # Specifies the IDs of the subnets that the file system will be # accessible from. For Windows `MULTI_AZ_1` file system deployment # types, provide exactly two subnet IDs, one for the preferred file # server and one for the standby file server. You specify one of these # subnets as the preferred subnet using the `WindowsConfiguration > # PreferredSubnetID` property. # # Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment # types, Lustre file systems, and OpenZFS file systems provide exactly # one subnet ID. The file server is launched in that subnet's # Availability Zone. # @return [Array] # # @!attribute [rw] security_group_ids # 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 `DescribeFileSystem` requests. # @return [Array] # # @!attribute [rw] 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. # @return [Array] # # @!attribute [rw] windows_configuration # The configuration for this Microsoft Windows file system. # @return [Types::CreateFileSystemWindowsConfiguration] # # @!attribute [rw] lustre_configuration # The Lustre configuration for the file system being created. # # The following parameters are not supported for file systems with a # data repository association created with . # # * `AutoImportPolicy` # # * `ExportPath` # # * `ImportedFileChunkSize` # # * `ImportPath` # # # @return [Types::CreateFileSystemLustreConfiguration] # # @!attribute [rw] storage_type # Sets the storage type for the Windows or OpenZFS file system that # you're creating from a backup. Valid values are `SSD` and `HDD`. # # * Set to `SSD` to use solid state drive storage. SSD is supported on # all Windows and OpenZFS deployment types. # # * Set to `HDD` to use hard disk drive storage. HDD is supported on # `SINGLE_AZ_2` and `MULTI_AZ_1` FSx for Windows File Server file # system deployment types. # # The default value is `SSD`. # # HDD and SSD storage types have different minimum storage capacity # requirements. A restored file system's storage capacity is tied to # the file system that was backed up. You can create a file system # that uses HDD storage from a backup of a file system that used SSD # storage if the original SSD file system had a storage capacity of at # least 2000 GiB. # # # @return [String] # # @!attribute [rw] kms_key_id # Specifies the ID of the Key Management Service (KMS) key to use for # encrypting data on Amazon FSx file systems, as follows: # # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment # types only. # # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon # FSx service KMS key for your account. # # * Amazon FSx for NetApp ONTAP # # * Amazon FSx for OpenZFS # # * Amazon FSx for Windows File Server # # If a `KmsKeyId` isn't specified, the Amazon FSx-managed KMS key for # your account is used. For more information, see [Encrypt][1] in the # *Key Management Service API Reference*. # # # # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html # @return [String] # # @!attribute [rw] file_system_type_version # Sets the version for the Amazon FSx for Lustre file system that # you're creating from a backup. Valid values are `2.10`, `2.12`, and # `2.15`. # # You don't need to specify `FileSystemTypeVersion` because it will # be applied using the backup's `FileSystemTypeVersion` setting. If # you choose to specify `FileSystemTypeVersion` when creating from # backup, the value must match the backup's `FileSystemTypeVersion` # setting. # @return [String] # # @!attribute [rw] open_zfs_configuration # The OpenZFS configuration for the file system that's being created. # @return [Types::CreateFileSystemOpenZFSConfiguration] # # @!attribute [rw] storage_capacity # Sets the storage capacity of the OpenZFS file system that you're # creating from a backup, in gibibytes (GiB). Valid values are from 64 # GiB up to 524,288 GiB (512 TiB). However, the value that you specify # must be equal to or greater than the backup's storage capacity # value. If you don't use the `StorageCapacity` parameter, the # default is the backup's `StorageCapacity` value. # # If used to create a file system other than OpenZFS, you must provide # a value that matches the backup's `StorageCapacity` value. If you # provide any other value, Amazon FSx responds with with an HTTP # status code 400 Bad Request. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupRequest AWS API Documentation # class CreateFileSystemFromBackupRequest < Struct.new( :backup_id, :client_request_token, :subnet_ids, :security_group_ids, :tags, :windows_configuration, :lustre_configuration, :storage_type, :kms_key_id, :file_system_type_version, :open_zfs_configuration, :storage_capacity) SENSITIVE = [] include Aws::Structure end # The response object for the `CreateFileSystemFromBackup` operation. # # @!attribute [rw] file_system # A description of the file system. # @return [Types::FileSystem] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupResponse AWS API Documentation # class CreateFileSystemFromBackupResponse < Struct.new( :file_system) SENSITIVE = [] include Aws::Structure end # The Lustre configuration for the file system being created. # # The following parameters are not supported for file systems with a # data repository association created with . # # * `AutoImportPolicy` # # * `ExportPath` # # * `ImportedFileChunkSize` # # * `ImportPath` # # # # @!attribute [rw] weekly_maintenance_start_time # (Optional) The preferred start time to perform weekly maintenance, # formatted d:HH:MM in the UTC time zone, where d is the weekday # number, from 1 through 7, beginning with Monday and ending with # Sunday. # @return [String] # # @!attribute [rw] import_path # (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. # # This parameter is not supported for file systems with a data # repository association. # # # @return [String] # # @!attribute [rw] export_path # (Optional) Specifies the path in the Amazon S3 bucket 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 specify only 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. # # This parameter is not supported for file systems with a data # repository association. # # # @return [String] # # @!attribute [rw] imported_file_chunk_size # (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 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. # # This parameter is not supported for file systems with a data # repository association. # # # @return [Integer] # # @!attribute [rw] deployment_type # (Optional) Choose `SCRATCH_1` and `SCRATCH_2` deployment types 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`. # # Choose `PERSISTENT_1` for longer-term storage and for # throughput-focused workloads that aren’t latency-sensitive. # `PERSISTENT_1` supports encryption of data in transit, and is # available in all Amazon Web Services Regions in which FSx for Lustre # is available. # # Choose `PERSISTENT_2` for longer-term storage and for # latency-sensitive workloads that require the highest levels of # IOPS/throughput. `PERSISTENT_2` supports SSD storage, and offers # higher `PerUnitStorageThroughput` (up to 1000 MB/s/TiB). You can # optionally specify a metadata configuration mode for `PERSISTENT_2` # which supports increasing metadata performance. `PERSISTENT_2` is # available in a limited number of Amazon Web Services Regions. For # more information, and an up-to-date list of Amazon Web Services # Regions in which `PERSISTENT_2` is available, see [File system # deployment options for FSx for Lustre][1] in the *Amazon FSx for # Lustre User Guide*. # # If you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to # `2.10`, the `CreateFileSystem` operation fails. # # # # Encryption of data in transit is automatically turned on when you # access `SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2` file systems # from Amazon EC2 instances that support automatic encryption in the # Amazon Web Services Regions where they are available. For more # information about encryption in transit for FSx for Lustre file # systems, see [Encrypting data in transit][2] in the *Amazon FSx for # Lustre User Guide*. # # (Default = `SCRATCH_1`) # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types # [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html # @return [String] # # @!attribute [rw] auto_import_policy # (Optional) When you create your file system, your existing S3 # objects appear as file and directory listings. Use this parameter to # choose how Amazon FSx keeps your file and directory listings up to # date as you add or modify objects in your linked S3 bucket. # `AutoImportPolicy` can have the following values: # # * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file # and directory listings from the linked S3 bucket when the file # system is created. FSx does not update file and directory listings # for any new or changed objects after choosing this option. # # * `NEW` - AutoImport is on. Amazon FSx automatically imports # directory listings of any new objects added to the linked S3 # bucket that do not currently exist in the FSx file system. # # * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports # file and directory listings of any new objects added to the S3 # bucket and any existing objects that are changed in the S3 bucket # after you choose this option. # # * `NEW_CHANGED_DELETED` - AutoImport is on. Amazon FSx automatically # imports file and directory listings of any new objects added to # the S3 bucket, any existing objects that are changed in the S3 # bucket, and any objects that were deleted in the S3 bucket. # # For more information, see [ Automatically import updates from your # S3 bucket][1]. # # This parameter is not supported for file systems with a data # repository association. # # # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3 # @return [String] # # @!attribute [rw] per_unit_storage_throughput # Required with `PERSISTENT_1` and `PERSISTENT_2` deployment types, # provisions the amount of read and write throughput for each 1 # tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File # system throughput capacity is calculated by multiplying file system # storage capacity (TiB) by the `PerUnitStorageThroughput` (MB/s/TiB). # For a 2.4-TiB file system, provisioning 50 MB/s/TiB of # `PerUnitStorageThroughput` yields 120 MB/s of file system throughput. # You pay for the amount of throughput that you provision. # # Valid values: # # * For `PERSISTENT_1` SSD storage: 50, 100, 200 MB/s/TiB. # # * For `PERSISTENT_1` HDD storage: 12, 40 MB/s/TiB. # # * For `PERSISTENT_2` SSD storage: 125, 250, 500, 1000 MB/s/TiB. # @return [Integer] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `0`. # @return [Integer] # # @!attribute [rw] copy_tags_to_backups # (Optional) Not available for use with file systems that are linked # to a data repository. A boolean flag indicating whether tags for the # file system should be copied to backups. The default value is false. # If `CopyTagsToBackups` is set to true, all file system tags are # copied to all automatic and user-initiated backups when the user # doesn't specify any backup-specific tags. If `CopyTagsToBackups` is # set to true and you specify one or more backup 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`) # # For more information, see [ Working with backups][1] in the *Amazon # FSx for Lustre User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html # @return [Boolean] # # @!attribute [rw] drive_cache_type # The type of drive cache used by `PERSISTENT_1` file systems that are # provisioned with HDD storage devices. This parameter is required # when storage type is HDD. Set this property to `READ` to improve the # performance for frequently accessed files by caching up to 20% of # the total storage capacity of the file system. # # This parameter is required when `StorageType` is set to `HDD`. # @return [String] # # @!attribute [rw] data_compression_type # Sets the data compression configuration for the file system. # `DataCompressionType` can have the following values: # # * `NONE` - (Default) Data compression is turned off when the file # system is created. # # * `LZ4` - Data compression is turned on with the LZ4 algorithm. # # For more information, see [Lustre data compression][1] in the # *Amazon FSx for Lustre User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html # @return [String] # # @!attribute [rw] log_configuration # The Lustre logging configuration used when creating an Amazon FSx # for Lustre file system. When logging is enabled, Lustre logs error # and warning events for data repositories associated with your file # system to Amazon CloudWatch Logs. # @return [Types::LustreLogCreateConfiguration] # # @!attribute [rw] root_squash_configuration # The Lustre root squash configuration used when creating an Amazon # FSx for Lustre file system. When enabled, root squash restricts # root-level access from clients that try to access your file system # as a root user. # @return [Types::LustreRootSquashConfiguration] # # @!attribute [rw] metadata_configuration # The Lustre metadata performance configuration for the creation of an # FSx for Lustre file system using a `PERSISTENT_2` deployment type. # @return [Types::CreateFileSystemLustreMetadataConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemLustreConfiguration AWS API Documentation # class CreateFileSystemLustreConfiguration < Struct.new( :weekly_maintenance_start_time, :import_path, :export_path, :imported_file_chunk_size, :deployment_type, :auto_import_policy, :per_unit_storage_throughput, :daily_automatic_backup_start_time, :automatic_backup_retention_days, :copy_tags_to_backups, :drive_cache_type, :data_compression_type, :log_configuration, :root_squash_configuration, :metadata_configuration) SENSITIVE = [] include Aws::Structure end # The Lustre metadata performance configuration for the creation of an # Amazon FSx for Lustre file system using a `PERSISTENT_2` deployment # type. The configuration uses a Metadata IOPS value to set the maximum # rate of metadata disk IOPS supported by the file system. # # After creation, the file system supports increasing metadata # performance. For more information on Metadata IOPS, see [Lustre # metadata performance configuration][1] in the *Amazon FSx for Lustre # User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-metadata-performance.html#metadata-configuration # # @!attribute [rw] iops # (USER\_PROVISIONED mode only) Specifies the number of Metadata IOPS # to provision for the file system. This parameter sets the maximum # rate of metadata disk IOPS supported by the file system. Valid # values are `1500`, `3000`, `6000`, `12000`, and multiples of `12000` # up to a maximum of `192000`. # # Iops doesn’t have a default value. If you're using # USER\_PROVISIONED mode, you can choose to specify a valid value. If # you're using AUTOMATIC mode, you cannot specify a value because FSx # for Lustre automatically sets the value based on your file system # storage capacity. # # # @return [Integer] # # @!attribute [rw] mode # The metadata configuration mode for provisioning Metadata IOPS for # an FSx for Lustre file system using a `PERSISTENT_2` deployment # type. # # * In AUTOMATIC mode, FSx for Lustre automatically provisions and # scales the number of Metadata IOPS for your file system based on # your file system storage capacity. # # * In USER\_PROVISIONED mode, you specify the number of Metadata IOPS # to provision for your file system. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemLustreMetadataConfiguration AWS API Documentation # class CreateFileSystemLustreMetadataConfiguration < Struct.new( :iops, :mode) SENSITIVE = [] include Aws::Structure end # The ONTAP configuration properties of the FSx for ONTAP file system # that you are creating. # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] deployment_type # Specifies the FSx for ONTAP file system deployment type to use in # creating the file system. # # * `MULTI_AZ_1` - A high availability file system configured for # Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) # unavailability. This is a first-generation FSx for ONTAP file # system. # # * `MULTI_AZ_2` - A high availability file system configured for # Multi-AZ redundancy to tolerate temporary AZ unavailability. This # is a second-generation FSx for ONTAP file system. # # * `SINGLE_AZ_1` - A file system configured for Single-AZ redundancy. # This is a first-generation FSx for ONTAP file system. # # * `SINGLE_AZ_2` - A file system configured with multiple # high-availability (HA) pairs for Single-AZ redundancy. This is a # second-generation FSx for ONTAP file system. # # For information about the use cases for Multi-AZ and Single-AZ # deployments, refer to [Choosing a file system deployment type][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html # @return [String] # # @!attribute [rw] endpoint_ip_address_range # (Multi-AZ only) Specifies the IP address range in which the # endpoints to access your file system will be created. By default in # the Amazon FSx API, Amazon FSx selects an unused IP address range # for you from the 198.19.* range. By default in the Amazon FSx # console, Amazon FSx chooses the last 64 IP addresses from the VPC’s # primary CIDR range to use as the endpoint IP address range for the # file system. You can have overlapping endpoint IP addresses for file # systems deployed in the same VPC/route tables, as long as they # don't overlap with any subnet. # @return [String] # # @!attribute [rw] fsx_admin_password # The ONTAP administrative password for the `fsxadmin` user with which # you administer your file system using the NetApp ONTAP CLI and REST # API. # @return [String] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS configuration for the FSx for ONTAP file system. # @return [Types::DiskIopsConfiguration] # # @!attribute [rw] preferred_subnet_id # Required when `DeploymentType` is set to `MULTI_AZ_1` or # `MULTI_AZ_2`. This specifies the subnet in which you want the # preferred file server to be located. # @return [String] # # @!attribute [rw] route_table_ids # (Multi-AZ only) Specifies the route tables in which Amazon FSx # creates the rules for routing traffic to the correct file server. # You should specify all virtual private cloud (VPC) route tables # associated with the subnets in which your clients are located. By # default, Amazon FSx selects your VPC's default route table. # # Amazon FSx manages these route tables for Multi-AZ file systems # using tag-based authentication. These route tables are tagged with # `Key: AmazonFSx; Value: ManagedByAmazonFSx`. When creating FSx for # ONTAP Multi-AZ file systems using CloudFormation we recommend that # you add the `Key: AmazonFSx; Value: ManagedByAmazonFSx` tag # manually. # # # @return [Array] # # @!attribute [rw] throughput_capacity # Sets the throughput capacity for the file system that you're # creating in megabytes per second (MBps). For more information, see # [Managing throughput capacity][1] in the FSx for ONTAP User Guide. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The value of `ThroughputCapacity` and # `ThroughputCapacityPerHAPair` are not the same value. # # * The value of `ThroughputCapacity` when divided by the value of # `HAPairs` is outside of the valid range for `ThroughputCapacity`. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html # @return [Integer] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] ha_pairs # Specifies how many high-availability (HA) pairs of file servers will # power your file system. First-generation file systems are powered by # 1 HA pair. Second-generation multi-AZ file systems are powered by 1 # HA pair. Second generation single-AZ file systems are powered by up # to 12 HA pairs. The default value is 1. The value of this property # affects the values of `StorageCapacity`, `Iops`, and # `ThroughputCapacity`. For more information, see [High-availability # (HA) pairs][1] in the FSx for ONTAP user guide. Block storage # protocol support (iSCSI and NVMe over TCP) is disabled on file # systems with more than 6 HA pairs. For more information, see [Using # block storage protocols][2]. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The value of `HAPairs` is less than 1 or greater than 12. # # * The value of `HAPairs` is greater than 1 and the value of # `DeploymentType` is `SINGLE_AZ_1`, `MULTI_AZ_1`, or `MULTI_AZ_2`. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage # @return [Integer] # # @!attribute [rw] throughput_capacity_per_ha_pair # Use to choose the throughput capacity per HA pair, rather than the # total throughput for the file system. # # You can define either the `ThroughputCapacityPerHAPair` or the # `ThroughputCapacity` when creating a file system, but not both. # # This field and `ThroughputCapacity` are the same for file systems # powered by one HA pair. # # * For `SINGLE_AZ_1` and `MULTI_AZ_1` file systems, valid values are # 128, 256, 512, 1024, 2048, or 4096 MBps. # # * For `SINGLE_AZ_2`, valid values are 1536, 3072, or 6144 MBps. # # * For `MULTI_AZ_2`, valid values are 384, 768, 1536, 3072, or 6144 # MBps. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The value of `ThroughputCapacity` and # `ThroughputCapacityPerHAPair` are not the same value for file # systems with one HA pair. # # * The value of deployment type is `SINGLE_AZ_2` and # `ThroughputCapacity` / `ThroughputCapacityPerHAPair` is not a # valid HA pair (a value between 1 and 12). # # * The value of `ThroughputCapacityPerHAPair` is not a valid value. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemOntapConfiguration AWS API Documentation # class CreateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :deployment_type, :endpoint_ip_address_range, :fsx_admin_password, :disk_iops_configuration, :preferred_subnet_id, :route_table_ids, :throughput_capacity, :weekly_maintenance_start_time, :ha_pairs, :throughput_capacity_per_ha_pair) SENSITIVE = [:fsx_admin_password] include Aws::Structure end # The Amazon FSx for OpenZFS configuration properties for the file # system that you are creating. # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] copy_tags_to_backups # A Boolean value 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. 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. # @return [Boolean] # # @!attribute [rw] copy_tags_to_volumes # A Boolean value indicating whether tags for the file system should # be copied to volumes. This value defaults to `false`. If it's set # to `true`, all tags for the file system are copied to volumes 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 # volumes. If you specify one or more tags when creating the volume, # no tags are copied from the file system, regardless of this value. # @return [Boolean] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] deployment_type # Specifies the file system deployment type. Valid values are the # following: # # * `MULTI_AZ_1`- Creates file systems with high availability and # durability by replicating your data and supporting failover across # multiple Availability Zones in the same Amazon Web Services # Region. # # * `SINGLE_AZ_HA_2`- Creates file systems with high availability and # throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC # cache by deploying a primary and standby file system within the # same Availability Zone. # # * `SINGLE_AZ_HA_1`- Creates file systems with high availability and # throughput capacities of 64 - 4,096 MB/s by deploying a primary # and standby file system within the same Availability Zone. # # * `SINGLE_AZ_2`- Creates file systems with throughput capacities of # 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically # recover within a single Availability Zone. # # * `SINGLE_AZ_1`- Creates file systems with throughput capacities of # 64 - 4,096 MBs that automatically recover within a single # Availability Zone. # # For a list of which Amazon Web Services Regions each deployment type # is available in, see [Deployment type availability][1]. For more # information on the differences in performance between deployment # types, see [File system performance][2] in the *Amazon FSx for # OpenZFS User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions # [2]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance # @return [String] # # @!attribute [rw] throughput_capacity # Specifies the throughput of an Amazon FSx for OpenZFS file system, # measured in megabytes per second (MBps). Valid values depend on the # DeploymentType you choose, as follows: # # * For `MULTI_AZ_1` and `SINGLE_AZ_2`, valid values are 160, 320, # 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps. # # * For `SINGLE_AZ_1`, valid values are 64, 128, 256, 512, 1024, 2048, # 3072, or 4096 MBps. # # You pay for additional throughput capacity that you provision. # @return [Integer] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS (input/output operations per second) configuration for # an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, # or FSx for OpenZFS file system. By default, Amazon FSx automatically # provisions 3 IOPS per GB of storage capacity. You can provision # additional IOPS per GB of storage. The configuration consists of the # total number of provisioned SSD IOPS and how it is was provisioned, # or the mode (by the customer or by Amazon FSx). # @return [Types::DiskIopsConfiguration] # # @!attribute [rw] root_volume_configuration # The configuration Amazon FSx uses when creating the root value of # the Amazon FSx for OpenZFS file system. All volumes are children of # the root volume. # @return [Types::OpenZFSCreateRootVolumeConfiguration] # # @!attribute [rw] preferred_subnet_id # Required when `DeploymentType` is set to `MULTI_AZ_1`. This # specifies the subnet in which you want the preferred file server to # be located. # @return [String] # # @!attribute [rw] endpoint_ip_address_range # (Multi-AZ only) Specifies the IP address range in which the # endpoints to access your file system will be created. By default in # the Amazon FSx API and Amazon FSx console, Amazon FSx selects an # available /28 IP address range for you from one of the VPC's CIDR # ranges. You can have overlapping endpoint IP addresses for file # systems deployed in the same VPC/route tables. # @return [String] # # @!attribute [rw] route_table_ids # (Multi-AZ only) Specifies the route tables in which Amazon FSx # creates the rules for routing traffic to the correct file server. # You should specify all virtual private cloud (VPC) route tables # associated with the subnets in which your clients are located. By # default, Amazon FSx selects your VPC's default route table. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemOpenZFSConfiguration AWS API Documentation # class CreateFileSystemOpenZFSConfiguration < Struct.new( :automatic_backup_retention_days, :copy_tags_to_backups, :copy_tags_to_volumes, :daily_automatic_backup_start_time, :deployment_type, :throughput_capacity, :weekly_maintenance_start_time, :disk_iops_configuration, :root_volume_configuration, :preferred_subnet_id, :endpoint_ip_address_range, :route_table_ids) SENSITIVE = [] include Aws::Structure end # The request object used to create a new Amazon FSx file system. # # @!attribute [rw] client_request_token # A string of up to 63 ASCII characters that Amazon FSx uses to ensure # idempotent creation. This string is automatically filled on your # behalf when you use the Command Line Interface (CLI) or an Amazon # Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] file_system_type # The type of Amazon FSx file system to create. Valid values are # `WINDOWS`, `LUSTRE`, `ONTAP`, and `OPENZFS`. # @return [String] # # @!attribute [rw] storage_capacity # Sets the storage capacity of the file system that you're creating, # in gibibytes (GiB). # # **FSx for Lustre file systems** - The amount of storage capacity # that you can configure depends on the value that you set for # `StorageType` and the Lustre `DeploymentType`, as follows: # # * For `SCRATCH_2`, `PERSISTENT_2`, and `PERSISTENT_1` deployment # types using SSD storage type, the valid values are 1200 GiB, 2400 # GiB, and increments of 2400 GiB. # # * For `PERSISTENT_1` HDD file systems, valid values are increments # of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 # GiB for 40 MB/s/TiB file systems. # # * For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400 # GiB, and increments of 3600 GiB. # # **FSx for ONTAP file systems** - The amount of storage capacity that # you can configure depends on the value of the `HAPairs` property. # The minimum value is calculated as 1,024 * `HAPairs` and the # maximum is calculated as 524,288 * `HAPairs`. # # **FSx for OpenZFS file systems** - The amount of storage capacity # that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). # # **FSx for Windows File Server file systems** - The amount of storage # capacity that you can configure depends on the value that you set # for `StorageType` as follows: # # * For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). # # * For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB). # @return [Integer] # # @!attribute [rw] storage_type # Sets the storage type for the file system that you're creating. # Valid values are `SSD` and `HDD`. # # * Set to `SSD` to use solid state drive storage. SSD is supported on # all Windows, Lustre, ONTAP, and OpenZFS deployment types. # # * Set to `HDD` to use hard disk drive storage. HDD is supported on # `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment # types, and on `PERSISTENT_1` Lustre file system deployment types. # # Default value is `SSD`. For more information, see [ Storage type # options][1] in the *FSx for Windows File Server User Guide* and # [Multiple storage options][2] in the *FSx for Lustre User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options # [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options # @return [String] # # @!attribute [rw] subnet_ids # Specifies the IDs of the subnets that the file system will be # accessible from. For Windows and ONTAP `MULTI_AZ_1` deployment # types,provide exactly two subnet IDs, one for the preferred file # server and one for the standby file server. You specify one of these # subnets as the preferred subnet using the `WindowsConfiguration > # PreferredSubnetID` or `OntapConfiguration > PreferredSubnetID` # properties. For more information about Multi-AZ file system # configuration, see [ Availability and durability: Single-AZ and # Multi-AZ file systems][1] in the *Amazon FSx for Windows User Guide* # and [ Availability and durability][2] in the *Amazon FSx for ONTAP # User Guide*. # # For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` and all Lustre # deployment types, provide exactly one subnet ID. The file server is # launched in that subnet's Availability Zone. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html # @return [Array] # # @!attribute [rw] security_group_ids # 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. # # You must specify a security group if you are creating a Multi-AZ FSx # for ONTAP file system in a VPC subnet that has been shared with you. # @return [Array] # # @!attribute [rw] tags # The tags to apply to the file system that's being created. The key # value of the `Name` tag appears in the console as the file system # name. # @return [Array] # # @!attribute [rw] kms_key_id # Specifies the ID of the Key Management Service (KMS) key to use for # encrypting data on Amazon FSx file systems, as follows: # # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment # types only. # # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon # FSx service KMS key for your account. # # * Amazon FSx for NetApp ONTAP # # * Amazon FSx for OpenZFS # # * Amazon FSx for Windows File Server # # If a `KmsKeyId` isn't specified, the Amazon FSx-managed KMS key for # your account is used. For more information, see [Encrypt][1] in the # *Key Management Service API Reference*. # # # # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html # @return [String] # # @!attribute [rw] windows_configuration # The Microsoft Windows configuration for the file system that's # being created. # @return [Types::CreateFileSystemWindowsConfiguration] # # @!attribute [rw] lustre_configuration # The Lustre configuration for the file system being created. # # The following parameters are not supported for file systems with a # data repository association created with . # # * `AutoImportPolicy` # # * `ExportPath` # # * `ImportedFileChunkSize` # # * `ImportPath` # # # @return [Types::CreateFileSystemLustreConfiguration] # # @!attribute [rw] ontap_configuration # The ONTAP configuration properties of the FSx for ONTAP file system # that you are creating. # @return [Types::CreateFileSystemOntapConfiguration] # # @!attribute [rw] file_system_type_version # For FSx for Lustre file systems, sets the Lustre version for the # file system that you're creating. Valid values are `2.10`, `2.12`, # and `2.15`: # # * `2.10` is supported by the Scratch and Persistent\_1 Lustre # deployment types. # # * `2.12` is supported by all Lustre deployment types, except for # `PERSISTENT_2` with a metadata configuration mode. # # * `2.15` is supported by all Lustre deployment types and is # recommended for all new file systems. # # Default value is `2.10`, except for the following deployments: # # * Default value is `2.12` when `DeploymentType` is set to # `PERSISTENT_2` without a metadata configuration mode. # # * Default value is `2.15` when `DeploymentType` is set to # `PERSISTENT_2` with a metadata configuration mode. # @return [String] # # @!attribute [rw] open_zfs_configuration # The OpenZFS configuration for the file system that's being created. # @return [Types::CreateFileSystemOpenZFSConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemRequest AWS API Documentation # class CreateFileSystemRequest < Struct.new( :client_request_token, :file_system_type, :storage_capacity, :storage_type, :subnet_ids, :security_group_ids, :tags, :kms_key_id, :windows_configuration, :lustre_configuration, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end # The response object returned after the file system is created. # # @!attribute [rw] file_system # The configuration of the file system that was created. # @return [Types::FileSystem] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemResponse AWS API Documentation # class CreateFileSystemResponse < Struct.new( :file_system) SENSITIVE = [] include Aws::Structure end # The configuration object for the Microsoft Windows file system used in # `CreateFileSystem` and `CreateFileSystemFromBackup` operations. # # @!attribute [rw] active_directory_id # The ID for an existing Amazon Web Services Managed Microsoft Active # Directory (AD) instance that the file system should join when it's # created. # @return [String] # # @!attribute [rw] self_managed_active_directory_configuration # The configuration that Amazon FSx uses to join a FSx for Windows # File Server file system or an FSx for ONTAP storage virtual machine # (SVM) to a self-managed (including on-premises) Microsoft Active # Directory (AD) directory. For more information, see [ Using Amazon # FSx for Windows with your self-managed Microsoft Active # Directory][1] or [Managing FSx for ONTAP SVMs][2]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html # @return [Types::SelfManagedActiveDirectoryConfiguration] # # @!attribute [rw] deployment_type # Specifies the file system deployment type, valid values are the # following: # # * `MULTI_AZ_1` - Deploys a high availability file system that is # configured for Multi-AZ redundancy to tolerate temporary # Availability Zone (AZ) unavailability. You can only deploy a # Multi-AZ file system in Amazon Web Services Regions that have a # minimum of three Availability Zones. Also supports HDD storage # type # # * `SINGLE_AZ_1` - (Default) Choose to deploy a file system that is # configured for single AZ redundancy. # # * `SINGLE_AZ_2` - The latest generation Single AZ file system. # Specifies a file system that is configured for single AZ # redundancy and supports HDD storage type. # # For more information, see [ Availability and Durability: Single-AZ # and Multi-AZ File Systems][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html # @return [String] # # @!attribute [rw] preferred_subnet_id # Required when `DeploymentType` is set to `MULTI_AZ_1`. This # specifies the subnet in which you want the preferred file server to # be located. For in-Amazon Web Services applications, we recommend # that you launch your clients in the same Availability Zone (AZ) as # your preferred file server to reduce cross-AZ data transfer costs # and minimize latency. # @return [String] # # @!attribute [rw] throughput_capacity # Sets the throughput capacity of an Amazon FSx file system, measured # in megabytes per second (MB/s), in 2 to the *n*th increments, # between 2^3 (8) and 2^11 (2048). # @return [Integer] # # @!attribute [rw] weekly_maintenance_start_time # The preferred start time to perform weekly maintenance, formatted # d:HH:MM in the UTC time zone, where d is the weekday number, from 1 # through 7, beginning with Monday and ending with Sunday. # @return [String] # # @!attribute [rw] daily_automatic_backup_start_time # The preferred time to take daily automatic backups, formatted HH:MM # in the UTC time zone. # @return [String] # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] copy_tags_to_backups # 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. 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. # @return [Boolean] # # @!attribute [rw] aliases # An array of one or more DNS alias names that you want to associate # with the Amazon FSx file system. Aliases allow you to use existing # DNS names to access the data in your Amazon FSx file system. You can # associate up to 50 aliases with a file system at any time. You can # associate additional DNS aliases after you create the file system # using the AssociateFileSystemAliases operation. You can remove DNS # aliases from the file system after it is created using the # DisassociateFileSystemAliases operation. You only need to specify # the alias name in the request payload. # # For more information, see [Working with DNS Aliases][1] and # [Walkthrough 5: Using DNS aliases to access your file system][2], # including additional steps you must take to be able to access your # file system using a DNS alias. # # An alias name has to meet the following requirements: # # * Formatted as a fully-qualified domain name (FQDN), # `hostname.domain`, for example, `accounting.example.com`. # # * Can contain alphanumeric characters, the underscore (\_), and the # hyphen (-). # # * Cannot start or end with a hyphen. # # * Can start with a numeric. # # For DNS alias names, Amazon FSx stores alphabetic characters as # lowercase letters (a-z), regardless of how you specify them: as # uppercase letters, lowercase letters, or the corresponding letters # in escape codes. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html # [2]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html # @return [Array] # # @!attribute [rw] audit_log_configuration # The configuration that Amazon FSx for Windows File Server uses to # audit and log user accesses of files, folders, and file shares on # the Amazon FSx for Windows File Server file system. # @return [Types::WindowsAuditLogCreateConfiguration] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS (input/output operations per second) configuration for # an Amazon FSx for Windows file system. By default, Amazon FSx # automatically provisions 3 IOPS per GiB of storage capacity. You can # provision additional IOPS per GiB of storage, up to the maximum # limit associated with your chosen throughput capacity. # @return [Types::DiskIopsConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemWindowsConfiguration AWS API Documentation # class CreateFileSystemWindowsConfiguration < Struct.new( :active_directory_id, :self_managed_active_directory_configuration, :deployment_type, :preferred_subnet_id, :throughput_capacity, :weekly_maintenance_start_time, :daily_automatic_backup_start_time, :automatic_backup_retention_days, :copy_tags_to_backups, :aliases, :audit_log_configuration, :disk_iops_configuration) SENSITIVE = [] include Aws::Structure end # Specifies the configuration of the ONTAP volume that you are creating. # # @!attribute [rw] junction_path # Specifies the location in the SVM's namespace where the volume is # mounted. This parameter is required. The `JunctionPath` must have a # leading forward slash, such as `/vol3`. # @return [String] # # @!attribute [rw] security_style # Specifies the security style for the volume. If a volume's security # style is not specified, it is automatically set to the root # volume's security style. The security style determines the type of # permissions that FSx for ONTAP uses to control data access. Specify # one of the following values: # # * `UNIX` if the file system is managed by a UNIX administrator, the # majority of users are NFS clients, and an application accessing # the data uses a UNIX user as the service account. # # * `NTFS` if the file system is managed by a Windows administrator, # the majority of users are SMB clients, and an application # accessing the data uses a Windows user as the service account. # # * `MIXED` This is an advanced setting. For more information, see the # topic [What the security styles and their effects are][1] in the # NetApp Documentation Center. # # For more information, see [Volume security style][2] in the FSx for # ONTAP User Guide. # # # # [1]: https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style # @return [String] # # @!attribute [rw] size_in_megabytes # Use `SizeInBytes` instead. Specifies the size of the volume, in # megabytes (MB), that you are creating. # @return [Integer] # # @!attribute [rw] storage_efficiency_enabled # Set to true to enable deduplication, compression, and compaction # storage efficiency features on the volume, or set to false to # disable them. # # `StorageEfficiencyEnabled` is required when creating a `RW` volume # (`OntapVolumeType` set to `RW`). # @return [Boolean] # # @!attribute [rw] storage_virtual_machine_id # Specifies the ONTAP SVM in which to create the volume. # @return [String] # # @!attribute [rw] tiering_policy # Describes the data tiering policy for an ONTAP volume. When enabled, # Amazon FSx for ONTAP's intelligent tiering automatically # transitions a volume's data between the file system's primary # storage and capacity pool storage based on your access patterns. # # Valid tiering policies are the following: # # * `SNAPSHOT_ONLY` - (Default value) moves cold snapshots to the # capacity pool storage tier. # # ^ # ^ # # * `AUTO` - moves cold user data and snapshots to the capacity pool # storage tier based on your access patterns. # # ^ # ^ # # * `ALL` - moves all user data blocks in both the active file system # and Snapshot copies to the storage pool tier. # # ^ # ^ # # * `NONE` - keeps a volume's data in the primary storage tier, # preventing it from being moved to the capacity pool tier. # # ^ # @return [Types::TieringPolicy] # # @!attribute [rw] ontap_volume_type # Specifies the type of volume you are creating. Valid values are the # following: # # * `RW` specifies a read/write volume. `RW` is the default. # # * `DP` specifies a data-protection volume. A `DP` volume is # read-only and can be used as the destination of a NetApp # SnapMirror relationship. # # For more information, see [Volume types][1] in the Amazon FSx for # NetApp ONTAP User Guide. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types # @return [String] # # @!attribute [rw] snapshot_policy # Specifies the snapshot policy for the volume. There are three # built-in snapshot policies: # # * `default`: This is the default policy. A maximum of six hourly # snapshots taken five minutes past the hour. A maximum of two daily # snapshots taken Monday through Saturday at 10 minutes after # midnight. A maximum of two weekly snapshots taken every Sunday at # 15 minutes after midnight. # # * `default-1weekly`: This policy is the same as the `default` policy # except that it only retains one snapshot from the weekly schedule. # # * `none`: This policy does not take any snapshots. This policy can # be assigned to volumes to prevent automatic snapshots from being # taken. # # You can also provide the name of a custom policy that you created # with the ONTAP CLI or REST API. # # For more information, see [Snapshot policies][1] in the Amazon FSx # for NetApp ONTAP User Guide. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies # @return [String] # # @!attribute [rw] copy_tags_to_backups # A boolean flag indicating whether tags for the volume should be # copied to backups. This value defaults to false. If it's set to # true, all tags for the volume 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. If you specify one or more tags when # creating a user-initiated backup, no tags are copied from the # volume, regardless of this value. # @return [Boolean] # # @!attribute [rw] snaplock_configuration # Specifies the SnapLock configuration for an FSx for ONTAP volume. # @return [Types::CreateSnaplockConfiguration] # # @!attribute [rw] volume_style # Use to specify the style of an ONTAP volume. FSx for ONTAP offers # two styles of volumes that you can use for different purposes, # FlexVol and FlexGroup volumes. For more information, see [Volume # styles][1] in the Amazon FSx for NetApp ONTAP User Guide. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles # @return [String] # # @!attribute [rw] aggregate_configuration # Use to specify configuration options for a volume’s storage # aggregate or aggregates. # @return [Types::CreateAggregateConfiguration] # # @!attribute [rw] size_in_bytes # Specifies the configured size of the volume, in bytes. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOntapVolumeConfiguration AWS API Documentation # class CreateOntapVolumeConfiguration < Struct.new( :junction_path, :security_style, :size_in_megabytes, :storage_efficiency_enabled, :storage_virtual_machine_id, :tiering_policy, :ontap_volume_type, :snapshot_policy, :copy_tags_to_backups, :snaplock_configuration, :volume_style, :aggregate_configuration, :size_in_bytes) SENSITIVE = [] include Aws::Structure end # The snapshot configuration to use when creating an Amazon FSx for # OpenZFS volume from a snapshot. # # @!attribute [rw] snapshot_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] copy_strategy # Specifies the strategy used when copying data from the snapshot to # the new volume. # # * `CLONE` - The new volume references the data in the origin # snapshot. Cloning a snapshot is faster than copying data from the # snapshot to a new volume and doesn't consume disk throughput. # However, the origin snapshot can't be deleted if there is a # volume using its copied data. # # * `FULL_COPY` - Copies all data from the snapshot to the new volume. # # Specify this option to create the volume from a snapshot on # another FSx for OpenZFS file system. # # The `INCREMENTAL_COPY` option is only for updating an existing # volume by using a snapshot from another FSx for OpenZFS file system. # For more information, see [CopySnapshotAndUpdateVolume][1]. # # # # # # [1]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOpenZFSOriginSnapshotConfiguration AWS API Documentation # class CreateOpenZFSOriginSnapshotConfiguration < Struct.new( :snapshot_arn, :copy_strategy) SENSITIVE = [] include Aws::Structure end # Specifies the configuration of the Amazon FSx for OpenZFS volume that # you are creating. # # @!attribute [rw] parent_volume_id # The ID of the volume to use as the parent volume of the volume that # you are creating. # @return [String] # # @!attribute [rw] storage_capacity_reservation_gi_b # Specifies the amount of storage in gibibytes (GiB) to reserve from # the parent volume. Setting `StorageCapacityReservationGiB` # guarantees that the specified amount of storage space on the parent # volume will always be available for the volume. You can't reserve # more storage than the parent volume has. To *not* specify a storage # capacity reservation, set this to `0` or `-1`. For more information, # see [Volume properties][1] in the *Amazon FSx for OpenZFS User # Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties # @return [Integer] # # @!attribute [rw] storage_capacity_quota_gi_b # Sets the maximum storage size in gibibytes (GiB) for the volume. You # can specify a quota that is larger than the storage on the parent # volume. A volume quota limits the amount of storage that the volume # can consume to the configured amount, but does not guarantee the # space will be available on the parent volume. To guarantee quota # space, you must also set `StorageCapacityReservationGiB`. To *not* # specify a storage capacity quota, set this to `-1`. # # For more information, see [Volume properties][1] in the *Amazon FSx # for OpenZFS User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties # @return [Integer] # # @!attribute [rw] record_size_ki_b # Specifies the suggested block size for a volume in a ZFS dataset, in # kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, # or 1024 KiB. The default is 128 KiB. We recommend using the default # setting for the majority of use cases. Generally, workloads that # write in fixed small or large record sizes may benefit from setting # a custom record size, like database workloads (small record size) or # media streaming workloads (large record size). For additional # guidance on when to set a custom record size, see [ ZFS Record # size][1] in the *Amazon FSx for OpenZFS User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance # @return [Integer] # # @!attribute [rw] data_compression_type # Specifies the method used to compress the data on the volume. The # compression type is `NONE` by default. # # * `NONE` - Doesn't compress the data on the volume. `NONE` is the # default. # # * `ZSTD` - Compresses the data in the volume using the Zstandard # (ZSTD) compression algorithm. ZSTD compression provides a higher # level of data compression and higher read throughput performance # than LZ4 compression. # # * `LZ4` - Compresses the data in the volume using the LZ4 # compression algorithm. LZ4 compression provides a lower level of # compression and higher write throughput performance than ZSTD # compression. # # For more information about volume compression types and the # performance of your Amazon FSx for OpenZFS file system, see [ Tips # for maximizing performance][1] File system and volume settings in # the *Amazon FSx for OpenZFS User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs # @return [String] # # @!attribute [rw] copy_tags_to_snapshots # A Boolean value indicating whether tags for the volume should be # copied to snapshots. This value defaults to `false`. If it's set to # `true`, all tags for the volume are copied to snapshots 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 snapshots. # If you specify one or more tags when creating the snapshot, no tags # are copied from the volume, regardless of this value. # @return [Boolean] # # @!attribute [rw] origin_snapshot # The configuration object that specifies the snapshot to use as the # origin of the data for the volume. # @return [Types::CreateOpenZFSOriginSnapshotConfiguration] # # @!attribute [rw] read_only # A Boolean value indicating whether the volume is read-only. # @return [Boolean] # # @!attribute [rw] nfs_exports # The configuration object for mounting a Network File System (NFS) # file system. # @return [Array] # # @!attribute [rw] user_and_group_quotas # Configures how much storage users and groups can use on the volume. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOpenZFSVolumeConfiguration AWS API Documentation # class CreateOpenZFSVolumeConfiguration < Struct.new( :parent_volume_id, :storage_capacity_reservation_gi_b, :storage_capacity_quota_gi_b, :record_size_ki_b, :data_compression_type, :copy_tags_to_snapshots, :origin_snapshot, :read_only, :nfs_exports, :user_and_group_quotas) SENSITIVE = [] include Aws::Structure end # Defines the SnapLock configuration when creating an FSx for ONTAP # SnapLock volume. # # @!attribute [rw] audit_log_volume # Enables or disables the audit log volume for an FSx for ONTAP # SnapLock volume. The default value is `false`. If you set # `AuditLogVolume` to `true`, the SnapLock volume is created as an # audit log volume. The minimum retention period for an audit log # volume is six months. # # For more information, see [ SnapLock audit log volumes][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume # @return [Boolean] # # @!attribute [rw] autocommit_period # The configuration object for setting the autocommit period of files # in an FSx for ONTAP SnapLock volume. # @return [Types::AutocommitPeriod] # # @!attribute [rw] privileged_delete # Enables, disables, or permanently disables privileged delete on an # FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete # allows SnapLock administrators to delete WORM files even if they # have active retention periods. `PERMANENTLY_DISABLED` is a terminal # state. If privileged delete is permanently disabled on a SnapLock # volume, you can't re-enable it. The default value is `DISABLED`. # # For more information, see [Privileged delete][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete # @return [String] # # @!attribute [rw] retention_period # Specifies the retention period of an FSx for ONTAP SnapLock volume. # @return [Types::SnaplockRetentionPeriod] # # @!attribute [rw] snaplock_type # Specifies the retention mode of an FSx for ONTAP SnapLock volume. # After it is set, it can't be changed. You can choose one of the # following retention modes: # # * `COMPLIANCE`: Files transitioned to write once, read many (WORM) # on a Compliance volume can't be deleted until their retention # periods expire. This retention mode is used to address government # or industry-specific mandates or to protect against ransomware # attacks. For more information, see [SnapLock Compliance][1]. # # * `ENTERPRISE`: Files transitioned to WORM on an Enterprise volume # can be deleted by authorized users before their retention periods # expire using privileged delete. This retention mode is used to # advance an organization's data integrity and internal compliance # or to test retention settings before using SnapLock Compliance. # For more information, see [SnapLock Enterprise][2]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html # @return [String] # # @!attribute [rw] volume_append_mode_enabled # Enables or disables volume-append mode on an FSx for ONTAP SnapLock # volume. Volume-append mode allows you to create WORM-appendable # files and write data to them incrementally. The default value is # `false`. # # For more information, see [Volume-append mode][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateSnaplockConfiguration AWS API Documentation # class CreateSnaplockConfiguration < Struct.new( :audit_log_volume, :autocommit_period, :privileged_delete, :retention_period, :snaplock_type, :volume_append_mode_enabled) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] name # The name of the snapshot. # @return [String] # # @!attribute [rw] volume_id # The ID of the volume that you are taking a snapshot of. # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateSnapshotRequest AWS API Documentation # class CreateSnapshotRequest < Struct.new( :client_request_token, :name, :volume_id, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # A description of the snapshot. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateSnapshotResponse AWS API Documentation # class CreateSnapshotResponse < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] active_directory_configuration # Describes the self-managed Microsoft Active Directory to which you # want to join the SVM. Joining an Active Directory provides user # authentication and access control for SMB clients, including # Microsoft Windows and macOS clients accessing the file system. # @return [Types::CreateSvmActiveDirectoryConfiguration] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @!attribute [rw] name # The name of the SVM. # @return [String] # # @!attribute [rw] svm_admin_password # The password to use when managing the SVM using the NetApp ONTAP CLI # or REST API. If you do not specify a password, you can still use the # file system's `fsxadmin` user to manage the SVM. # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] root_volume_security_style # The security style of the root volume of the SVM. Specify one of the # following values: # # * `UNIX` if the file system is managed by a UNIX administrator, the # majority of users are NFS clients, and an application accessing # the data uses a UNIX user as the service account. # # * `NTFS` if the file system is managed by a Microsoft Windows # administrator, the majority of users are SMB clients, and an # application accessing the data uses a Microsoft Windows user as # the service account. # # * `MIXED` This is an advanced setting. For more information, see # [Volume security style][1] in the Amazon FSx for NetApp ONTAP User # Guide. # # # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateStorageVirtualMachineRequest AWS API Documentation # class CreateStorageVirtualMachineRequest < Struct.new( :active_directory_configuration, :client_request_token, :file_system_id, :name, :svm_admin_password, :tags, :root_volume_security_style) SENSITIVE = [:svm_admin_password] include Aws::Structure end # @!attribute [rw] storage_virtual_machine # Returned after a successful `CreateStorageVirtualMachine` operation; # describes the SVM just created. # @return [Types::StorageVirtualMachine] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateStorageVirtualMachineResponse AWS API Documentation # class CreateStorageVirtualMachineResponse < Struct.new( :storage_virtual_machine) SENSITIVE = [] include Aws::Structure end # The configuration that Amazon FSx uses to join the ONTAP storage # virtual machine (SVM) to your self-managed (including on-premises) # Microsoft Active Directory directory. # # @!attribute [rw] net_bios_name # The NetBIOS name of the Active Directory computer object that will # be created for your SVM. # @return [String] # # @!attribute [rw] self_managed_active_directory_configuration # The configuration that Amazon FSx uses to join a FSx for Windows # File Server file system or an FSx for ONTAP storage virtual machine # (SVM) to a self-managed (including on-premises) Microsoft Active # Directory (AD) directory. For more information, see [ Using Amazon # FSx for Windows with your self-managed Microsoft Active # Directory][1] or [Managing FSx for ONTAP SVMs][2]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html # @return [Types::SelfManagedActiveDirectoryConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateSvmActiveDirectoryConfiguration AWS API Documentation # class CreateSvmActiveDirectoryConfiguration < Struct.new( :net_bios_name, :self_managed_active_directory_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] backup_id # The ID of the source backup. Specifies the backup that you are # copying. # @return [String] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] name # The name of the new volume you're creating. # @return [String] # # @!attribute [rw] ontap_configuration # Specifies the configuration of the ONTAP volume that you are # creating. # @return [Types::CreateOntapVolumeConfiguration] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeFromBackupRequest AWS API Documentation # class CreateVolumeFromBackupRequest < Struct.new( :backup_id, :client_request_token, :name, :ontap_configuration, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volume # Returned after a successful `CreateVolumeFromBackup` API operation, # describing the volume just created. # @return [Types::Volume] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeFromBackupResponse AWS API Documentation # class CreateVolumeFromBackupResponse < Struct.new( :volume) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] volume_type # Specifies the type of volume to create; `ONTAP` and `OPENZFS` are # the only valid volume types. # @return [String] # # @!attribute [rw] name # Specifies the name of the volume that you're creating. # @return [String] # # @!attribute [rw] ontap_configuration # Specifies the configuration to use when creating the ONTAP volume. # @return [Types::CreateOntapVolumeConfiguration] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] open_zfs_configuration # Specifies the configuration to use when creating the OpenZFS volume. # @return [Types::CreateOpenZFSVolumeConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeRequest AWS API Documentation # class CreateVolumeRequest < Struct.new( :client_request_token, :volume_type, :name, :ontap_configuration, :tags, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volume # Returned after a successful `CreateVolume` API operation, describing # the volume just created. # @return [Types::Volume] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeResponse AWS API Documentation # class CreateVolumeResponse < Struct.new( :volume) SENSITIVE = [] include Aws::Structure end # The configuration of a data repository association that links an # Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon # File Cache resource to an Amazon S3 bucket or an NFS file system. The # data repository association configuration object is returned in the # response of the following operations: # # * `CreateDataRepositoryAssociation` # # * `UpdateDataRepositoryAssociation` # # * `DescribeDataRepositoryAssociations` # # Data repository associations are supported on Amazon File Cache # resources and all FSx for Lustre 2.12 and 2.15 file systems, excluding # `scratch_1` deployment type. # # @!attribute [rw] association_id # The system-generated, unique ID of the data repository association. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @!attribute [rw] lifecycle # Describes the state of a data repository association. The lifecycle # can have the following values: # # * `CREATING` - The data repository association between the file # system or cache and the data repository is being created. The data # repository is unavailable. # # * `AVAILABLE` - The data repository association is available for # use. # # * `MISCONFIGURED` - The data repository association is # misconfigured. Until the configuration is corrected, automatic # import and automatic export will not work (only for Amazon FSx for # Lustre). # # * `UPDATING` - The data repository association is undergoing a # customer initiated update that might affect its availability. # # * `DELETING` - The data repository association is undergoing a # customer initiated deletion. # # * `FAILED` - The data repository association is in a terminal state # that cannot be recovered. # @return [String] # # @!attribute [rw] failure_details # Provides detailed information about the data repository if its # `Lifecycle` is set to `MISCONFIGURED` or `FAILED`. # @return [Types::DataRepositoryFailureDetails] # # @!attribute [rw] file_system_path # A path on the Amazon FSx for Lustre file system that points to a # high-level directory (such as `/ns1/`) or subdirectory (such as # `/ns1/subdir/`) that will be mapped 1-1 with `DataRepositoryPath`. # The leading forward slash in the name is required. Two data # repository associations cannot have overlapping file system paths. # For example, if a data repository is associated with file system # path `/ns1/`, then you cannot link another data repository with file # system path `/ns1/ns2`. # # This path specifies where in your file system files will be exported # from or imported to. This file system directory can be linked to # only one Amazon S3 bucket, and no other S3 bucket can be linked to # the directory. # # If you specify only a forward slash (`/`) as the file system path, # you can link only one data repository to the file system. You can # only specify "/" as the file system path for the first data # repository associated with a file system. # # # @return [String] # # @!attribute [rw] data_repository_path # The path to the data repository that will be linked to the cache or # file system. # # * For Amazon File Cache, the path can be an NFS data repository that # will be linked to the cache. The path can be in one of two # formats: # # * If you are not using the `DataRepositorySubdirectories` # parameter, the path is to an NFS Export directory (or one of its # subdirectories) in the format # `nsf://nfs-domain-name/exportpath`. You can therefore link a # single NFS Export to a single data repository association. # # * If you are using the `DataRepositorySubdirectories` parameter, # the path is the domain name of the NFS file system in the format # `nfs://filer-domain-name`, which indicates the root of the # subdirectories specified with the `DataRepositorySubdirectories` # parameter. # # * For Amazon File Cache, the path can be an S3 bucket or prefix in # the format `s3://bucket-name/prefix/` (where `prefix` is # optional). # # * For Amazon FSx for Lustre, the path can be an S3 bucket or prefix # in the format `s3://bucket-name/prefix/` (where `prefix` is # optional). # @return [String] # # @!attribute [rw] batch_import_meta_data_on_create # A boolean flag indicating whether an import data repository task to # import metadata should run after the data repository association is # created. The task runs if this flag is set to `true`. # # `BatchImportMetaDataOnCreate` is not supported for data repositories # linked to an Amazon File Cache resource. # # # @return [Boolean] # # @!attribute [rw] imported_file_chunk_size # 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 or cache. # # 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. # @return [Integer] # # @!attribute [rw] s3 # The configuration for an Amazon S3 data repository linked to an # Amazon FSx for Lustre file system with a data repository # association. # @return [Types::S3DataRepositoryConfiguration] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] creation_time # The time that the resource was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] file_cache_id # The globally unique ID of the Amazon File Cache resource. # @return [String] # # @!attribute [rw] file_cache_path # A path on the Amazon File Cache that points to a high-level # directory (such as `/ns1/`) or subdirectory (such as `/ns1/subdir/`) # that will be mapped 1-1 with `DataRepositoryPath`. The leading # forward slash in the path is required. Two data repository # associations cannot have overlapping cache paths. For example, if a # data repository is associated with cache path `/ns1/`, then you # cannot link another data repository with cache path `/ns1/ns2`. # # This path specifies the directory in your cache where files will be # exported from. This cache directory can be linked to only one data # repository (S3 or NFS) and no other data repository can be linked to # the directory. # # The cache path can only be set to root (/) on an NFS DRA when # `DataRepositorySubdirectories` is specified. If you specify root (/) # as the cache path, you can create only one DRA on the cache. # # The cache path cannot be set to root (/) for an S3 DRA. # # # @return [String] # # @!attribute [rw] data_repository_subdirectories # For Amazon File Cache, a list of NFS Exports that will be linked # with an NFS data repository association. All the subdirectories must # be on a single NFS file system. The Export paths are in the format # `/exportpath1`. To use this parameter, you must configure # `DataRepositoryPath` as the domain name of the NFS file system. The # NFS file system domain name in effect is the root of the # subdirectories. Note that `DataRepositorySubdirectories` is not # supported for S3 data repositories. # @return [Array] # # @!attribute [rw] nfs # The configuration for an NFS data repository linked to an Amazon # File Cache resource with a data repository association. # @return [Types::NFSDataRepositoryConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryAssociation AWS API Documentation # class DataRepositoryAssociation < Struct.new( :association_id, :resource_arn, :file_system_id, :lifecycle, :failure_details, :file_system_path, :data_repository_path, :batch_import_meta_data_on_create, :imported_file_chunk_size, :s3, :tags, :creation_time, :file_cache_id, :file_cache_path, :data_repository_subdirectories, :nfs) SENSITIVE = [] include Aws::Structure end # No data repository associations were found based upon the supplied # parameters. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryAssociationNotFound AWS API Documentation # class DataRepositoryAssociationNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The data repository configuration object for Lustre file systems # returned in the response of the `CreateFileSystem` operation. # # This data type is not supported on file systems with a data repository # association. For file systems with a data repository association, see # . # # @!attribute [rw] lifecycle # 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` - The data repository configuration between the FSx # file system and the linked S3 data repository is being created. # The data repository is unavailable. # # * `AVAILABLE` - The data repository is available for use. # # * `MISCONFIGURED` - Amazon FSx cannot automatically import updates # from the S3 bucket until the data repository configuration is # corrected. For more information, see [Troubleshooting a # Misconfigured linked S3 bucket][1]. # # * `UPDATING` - The data repository is undergoing a customer # initiated update and availability may be impacted. # # * `FAILED` - The data repository is in a terminal state that cannot # be recovered. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository # @return [String] # # @!attribute [rw] import_path # 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. # @return [String] # # @!attribute [rw] export_path # 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. # @return [String] # # @!attribute [rw] imported_file_chunk_size # 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. # @return [Integer] # # @!attribute [rw] auto_import_policy # Describes the file system's linked S3 data repository's # `AutoImportPolicy`. The AutoImportPolicy configures how Amazon FSx # keeps your file and directory listings up to date as you add or # modify objects in your linked S3 bucket. `AutoImportPolicy` can have # the following values: # # * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file # and directory listings from the linked S3 bucket when the file # system is created. FSx does not update file and directory listings # for any new or changed objects after choosing this option. # # * `NEW` - AutoImport is on. Amazon FSx automatically imports # directory listings of any new objects added to the linked S3 # bucket that do not currently exist in the FSx file system. # # * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports # file and directory listings of any new objects added to the S3 # bucket and any existing objects that are changed in the S3 bucket # after you choose this option. # # * `NEW_CHANGED_DELETED` - AutoImport is on. Amazon FSx automatically # imports file and directory listings of any new objects added to # the S3 bucket, any existing objects that are changed in the S3 # bucket, and any objects that were deleted in the S3 bucket. # @return [String] # # @!attribute [rw] failure_details # Provides detailed information about the data repository if its # `Lifecycle` is set to `MISCONFIGURED` or `FAILED`. # @return [Types::DataRepositoryFailureDetails] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryConfiguration AWS API Documentation # class DataRepositoryConfiguration < Struct.new( :lifecycle, :import_path, :export_path, :imported_file_chunk_size, :auto_import_policy, :failure_details) SENSITIVE = [] include Aws::Structure end # Provides detailed information about the data repository if its # `Lifecycle` is set to `MISCONFIGURED` or `FAILED`. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryFailureDetails AWS API Documentation # class DataRepositoryFailureDetails < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A description of the data repository task. # # * You use import and export data repository tasks to perform bulk # transfer operations between an Amazon FSx for Lustre file system and # a linked data repository. # # * You use release data repository tasks to release files that have # been exported to a linked S3 bucket from your Amazon FSx for Lustre # file system. # # * An Amazon File Cache resource uses a task to automatically release # files from the cache. # # To learn more about data repository tasks, see [Data Repository # Tasks][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html # # @!attribute [rw] task_id # The system-generated, unique 17-digit ID of the data repository # task. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the data repository task, as follows: # # * `PENDING` - The task has not started. # # * `EXECUTING` - The task is in process. # # * `FAILED` - The task was not able to be completed. For example, # there may be files the task failed to process. The # DataRepositoryTaskFailureDetails property provides more # information about task failures. # # * `SUCCEEDED` - The task has completed successfully. # # * `CANCELED` - The task was canceled and it did not complete. # # * `CANCELING` - The task is in process of being canceled. # # You cannot delete an FSx for Lustre file system if there are data # repository tasks for the file system in the `PENDING` or `EXECUTING` # states. Please retry when the data repository task is finished (with # a status of `CANCELED`, `SUCCEEDED`, or `FAILED`). You can use the # DescribeDataRepositoryTask action to monitor the task status. # Contact the FSx team if you need to delete your file system # immediately. # # # @return [String] # # @!attribute [rw] type # The type of data repository task. # # * `EXPORT_TO_REPOSITORY` tasks export from your Amazon FSx for # Lustre file system to a linked data repository. # # * `IMPORT_METADATA_FROM_REPOSITORY` tasks import metadata changes # from a linked S3 bucket to your Amazon FSx for Lustre file system. # # * `RELEASE_DATA_FROM_FILESYSTEM` tasks release files in your Amazon # FSx for Lustre file system that have been exported to a linked S3 # bucket and that meet your specified release criteria. # # * `AUTO_RELEASE_DATA` tasks automatically release files from an # Amazon File Cache resource. # @return [String] # # @!attribute [rw] creation_time # The time that the resource was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] start_time # The time the system began processing the task. # @return [Time] # # @!attribute [rw] end_time # The time the system completed processing the task, populated after # the task is complete. # @return [Time] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] file_system_id # The globally unique ID of the file system. # @return [String] # # @!attribute [rw] paths # An array of paths that specify the data for the data repository task # to process. For example, in an EXPORT\_TO\_REPOSITORY task, the # paths specify which data to export to the linked data repository. # # (Default) If `Paths` is not specified, Amazon FSx uses the file # system root directory. # @return [Array] # # @!attribute [rw] failure_details # Failure message describing why the task failed, it is populated only # when `Lifecycle` is set to `FAILED`. # @return [Types::DataRepositoryTaskFailureDetails] # # @!attribute [rw] status # Provides the status of the number of files that the task has # processed successfully and failed to process. # @return [Types::DataRepositoryTaskStatus] # # @!attribute [rw] report # Provides a report detailing the data repository task results of the # files processed that match the criteria specified in the report # `Scope` parameter. FSx delivers the report to the file system's # linked data repository in Amazon S3, using the path specified in the # report `Path` parameter. You can specify whether or not a report # gets generated for a task using the `Enabled` parameter. # @return [Types::CompletionReport] # # @!attribute [rw] capacity_to_release # Specifies the amount of data to release, in GiB, by an Amazon File # Cache AUTO\_RELEASE\_DATA task that automatically releases files # from the cache. # @return [Integer] # # @!attribute [rw] file_cache_id # The system-generated, unique ID of the cache. # @return [String] # # @!attribute [rw] release_configuration # The configuration that specifies the last accessed time criteria for # files that will be released from an Amazon FSx for Lustre file # system. # @return [Types::ReleaseConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTask AWS API Documentation # class DataRepositoryTask < Struct.new( :task_id, :lifecycle, :type, :creation_time, :start_time, :end_time, :resource_arn, :tags, :file_system_id, :paths, :failure_details, :status, :report, :capacity_to_release, :file_cache_id, :release_configuration) SENSITIVE = [] include Aws::Structure end # The data repository task could not be canceled because the task has # already ended. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTaskEnded AWS API Documentation # class DataRepositoryTaskEnded < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # An existing data repository task is currently executing on the file # system. Wait until the existing task has completed, then create the # new task. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTaskExecuting AWS API Documentation # class DataRepositoryTaskExecuting < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Provides information about why a data repository task failed. Only # populated when the task `Lifecycle` is set to `FAILED`. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTaskFailureDetails AWS API Documentation # class DataRepositoryTaskFailureDetails < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # (Optional) An array of filter objects you can use to filter the # response of data repository tasks you will see in the the response. # You can filter the tasks returned in the response by one or more file # system IDs, task lifecycles, and by task type. A filter object # consists of a filter `Name`, and one or more `Values` for the filter. # # @!attribute [rw] name # Name of the task property to use in filtering the tasks returned in # the response. # # * Use `file-system-id` to retrieve data repository tasks for # specific file systems. # # * Use `task-lifecycle` to retrieve data repository tasks with one or # more specific lifecycle states, as follows: CANCELED, EXECUTING, # FAILED, PENDING, and SUCCEEDED. # @return [String] # # @!attribute [rw] values # Use Values to include the specific file system IDs and task # lifecycle states for the filters you are using. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTaskFilter AWS API Documentation # class DataRepositoryTaskFilter < Struct.new( :name, :values) SENSITIVE = [] include Aws::Structure end # The data repository task or tasks you specified could not be found. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTaskNotFound AWS API Documentation # class DataRepositoryTaskNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Provides the task status showing a running total of the total number # of files to be processed, the number successfully processed, and the # number of files the task failed to process. # # @!attribute [rw] total_count # The total number of files that the task will process. While a task # is executing, the sum of `SucceededCount` plus `FailedCount` may not # equal `TotalCount`. When the task is complete, `TotalCount` equals # the sum of `SucceededCount` plus `FailedCount`. # @return [Integer] # # @!attribute [rw] succeeded_count # A running total of the number of files that the task has # successfully processed. # @return [Integer] # # @!attribute [rw] failed_count # A running total of the number of files that the task failed to # process. # @return [Integer] # # @!attribute [rw] last_updated_time # The time at which the task status was last updated. # @return [Time] # # @!attribute [rw] released_capacity # The total amount of data, in GiB, released by an Amazon File Cache # AUTO\_RELEASE\_DATA task that automatically releases files from the # cache. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTaskStatus AWS API Documentation # class DataRepositoryTaskStatus < Struct.new( :total_count, :succeeded_count, :failed_count, :last_updated_time, :released_capacity) SENSITIVE = [] include Aws::Structure end # The request object for the `DeleteBackup` operation. # # @!attribute [rw] backup_id # The ID of the backup that you want to delete. # @return [String] # # @!attribute [rw] client_request_token # A string of up to 63 ASCII characters that Amazon FSx uses to ensure # idempotent deletion. This parameter is automatically filled on your # behalf when using the CLI or SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackupRequest AWS API Documentation # class DeleteBackupRequest < Struct.new( :backup_id, :client_request_token) SENSITIVE = [] include Aws::Structure end # The response object for the `DeleteBackup` operation. # # @!attribute [rw] backup_id # The ID of the backup that was deleted. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the backup. If the `DeleteBackup` operation # is successful, the status is `DELETED`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackupResponse AWS API Documentation # class DeleteBackupResponse < Struct.new( :backup_id, :lifecycle) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] association_id # The ID of the data repository association that you want to delete. # @return [String] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] delete_data_in_file_system # Set to `true` to delete the data in the file system that corresponds # to the data repository association. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteDataRepositoryAssociationRequest AWS API Documentation # class DeleteDataRepositoryAssociationRequest < Struct.new( :association_id, :client_request_token, :delete_data_in_file_system) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] association_id # The ID of the data repository association being deleted. # @return [String] # # @!attribute [rw] lifecycle # Describes the lifecycle state of the data repository association # being deleted. # @return [String] # # @!attribute [rw] delete_data_in_file_system # Indicates whether data in the file system that corresponds to the # data repository association is being deleted. Default is `false`. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteDataRepositoryAssociationResponse AWS API Documentation # class DeleteDataRepositoryAssociationResponse < Struct.new( :association_id, :lifecycle, :delete_data_in_file_system) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_cache_id # The ID of the cache that's being deleted. # @return [String] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileCacheRequest AWS API Documentation # class DeleteFileCacheRequest < Struct.new( :file_cache_id, :client_request_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_cache_id # The ID of the cache that's being deleted. # @return [String] # # @!attribute [rw] lifecycle # The cache lifecycle for the deletion request. If the # `DeleteFileCache` operation is successful, this status is # `DELETING`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileCacheResponse AWS API Documentation # class DeleteFileCacheResponse < Struct.new( :file_cache_id, :lifecycle) SENSITIVE = [] include Aws::Structure end # The configuration object for the Amazon FSx for Lustre file system # being deleted in the `DeleteFileSystem` operation. # # @!attribute [rw] skip_final_backup # Set `SkipFinalBackup` to false if you want to take a final backup of # the file system you are deleting. By default, Amazon FSx will not # take a final backup on your behalf when the `DeleteFileSystem` # operation is invoked. (Default = true) # # The `fsx:CreateBackup` permission is required if you set # `SkipFinalBackup` to `false` in order to delete the file system and # take a final backup. # # # @return [Boolean] # # @!attribute [rw] final_backup_tags # Use if `SkipFinalBackup` is set to `false`, and you want to apply an # array of tags to the final backup. If you have set the file system # property `CopyTagsToBackups` to true, and you specify one or more # `FinalBackupTags` when deleting a file system, Amazon FSx will not # copy any existing file system tags to the backup. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemLustreConfiguration AWS API Documentation # class DeleteFileSystemLustreConfiguration < Struct.new( :skip_final_backup, :final_backup_tags) SENSITIVE = [] include Aws::Structure end # The response object for the Amazon FSx for Lustre file system being # deleted in the `DeleteFileSystem` operation. # # @!attribute [rw] final_backup_id # The ID of the final backup for this file system. # @return [String] # # @!attribute [rw] final_backup_tags # The set of tags applied to the final backup. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemLustreResponse AWS API Documentation # class DeleteFileSystemLustreResponse < Struct.new( :final_backup_id, :final_backup_tags) SENSITIVE = [] include Aws::Structure end # The configuration object for the Amazon FSx for OpenZFS file system # used in the `DeleteFileSystem` operation. # # @!attribute [rw] skip_final_backup # By default, Amazon FSx for OpenZFS 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 taking a final backup, set this # value to `true`. # @return [Boolean] # # @!attribute [rw] final_backup_tags # A list of tags to apply to the file system's final backup. # @return [Array] # # @!attribute [rw] options # To delete a file system if there are child volumes present below the # root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`. If # your file system has child volumes and you don't use this option, # the delete request will fail. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemOpenZFSConfiguration AWS API Documentation # class DeleteFileSystemOpenZFSConfiguration < Struct.new( :skip_final_backup, :final_backup_tags, :options) SENSITIVE = [] include Aws::Structure end # The response object for the Amazon FSx for OpenZFS file system that's # being deleted in the `DeleteFileSystem` operation. # # @!attribute [rw] final_backup_id # The ID of the source backup. Specifies the backup that you are # copying. # @return [String] # # @!attribute [rw] final_backup_tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemOpenZFSResponse AWS API Documentation # class DeleteFileSystemOpenZFSResponse < Struct.new( :final_backup_id, :final_backup_tags) SENSITIVE = [] include Aws::Structure end # The request object for `DeleteFileSystem` operation. # # @!attribute [rw] file_system_id # The ID of the file system that you want to delete. # @return [String] # # @!attribute [rw] client_request_token # A string of up to 63 ASCII characters that Amazon FSx uses to ensure # idempotent deletion. This token is automatically filled on your # behalf when using the Command Line Interface (CLI) or an Amazon Web # Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] windows_configuration # The configuration object for the Microsoft Windows file system used # in the `DeleteFileSystem` operation. # @return [Types::DeleteFileSystemWindowsConfiguration] # # @!attribute [rw] lustre_configuration # The configuration object for the Amazon FSx for Lustre file system # being deleted in the `DeleteFileSystem` operation. # @return [Types::DeleteFileSystemLustreConfiguration] # # @!attribute [rw] open_zfs_configuration # The configuration object for the OpenZFS file system used in the # `DeleteFileSystem` operation. # @return [Types::DeleteFileSystemOpenZFSConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemRequest AWS API Documentation # class DeleteFileSystemRequest < Struct.new( :file_system_id, :client_request_token, :windows_configuration, :lustre_configuration, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end # The response object for the `DeleteFileSystem` operation. # # @!attribute [rw] file_system_id # The ID of the file system that's being deleted. # @return [String] # # @!attribute [rw] lifecycle # The file system lifecycle for the deletion request. If the # `DeleteFileSystem` operation is successful, this status is # `DELETING`. # @return [String] # # @!attribute [rw] windows_response # The response object for the Microsoft Windows file system used in # the `DeleteFileSystem` operation. # @return [Types::DeleteFileSystemWindowsResponse] # # @!attribute [rw] lustre_response # The response object for the Amazon FSx for Lustre file system being # deleted in the `DeleteFileSystem` operation. # @return [Types::DeleteFileSystemLustreResponse] # # @!attribute [rw] open_zfs_response # The response object for the OpenZFS file system that's being # deleted in the `DeleteFileSystem` operation. # @return [Types::DeleteFileSystemOpenZFSResponse] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemResponse AWS API Documentation # class DeleteFileSystemResponse < Struct.new( :file_system_id, :lifecycle, :windows_response, :lustre_response, :open_zfs_response) SENSITIVE = [] include Aws::Structure end # The configuration object for the Microsoft Windows file system used in # the `DeleteFileSystem` operation. # # @!attribute [rw] skip_final_backup # 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. # @return [Boolean] # # @!attribute [rw] final_backup_tags # A set of tags for your final backup. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemWindowsConfiguration AWS API Documentation # class DeleteFileSystemWindowsConfiguration < Struct.new( :skip_final_backup, :final_backup_tags) SENSITIVE = [] include Aws::Structure end # The response object for the Microsoft Windows file system used in the # `DeleteFileSystem` operation. # # @!attribute [rw] final_backup_id # The ID of the final backup for this file system. # @return [String] # # @!attribute [rw] final_backup_tags # The set of tags applied to the final backup. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemWindowsResponse AWS API Documentation # class DeleteFileSystemWindowsResponse < Struct.new( :final_backup_id, :final_backup_tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] snapshot_id # The ID of the snapshot that you want to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteSnapshotRequest AWS API Documentation # class DeleteSnapshotRequest < Struct.new( :client_request_token, :snapshot_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot_id # The ID of the deleted snapshot. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the snapshot. If the `DeleteSnapshot` # operation is successful, this status is `DELETING`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteSnapshotResponse AWS API Documentation # class DeleteSnapshotResponse < Struct.new( :snapshot_id, :lifecycle) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] storage_virtual_machine_id # The ID of the SVM that you want to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteStorageVirtualMachineRequest AWS API Documentation # class DeleteStorageVirtualMachineRequest < Struct.new( :client_request_token, :storage_virtual_machine_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] storage_virtual_machine_id # The ID of the SVM Amazon FSx is deleting. # @return [String] # # @!attribute [rw] lifecycle # Describes the lifecycle state of the SVM being deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteStorageVirtualMachineResponse AWS API Documentation # class DeleteStorageVirtualMachineResponse < Struct.new( :storage_virtual_machine_id, :lifecycle) SENSITIVE = [] include Aws::Structure end # Use to specify skipping a final backup, adding tags to a final backup, # or bypassing the retention period of an FSx for ONTAP SnapLock # Enterprise volume when deleting an FSx for ONTAP volume. # # @!attribute [rw] skip_final_backup # Set to true if you want to skip taking a final backup of the volume # you are deleting. # @return [Boolean] # # @!attribute [rw] final_backup_tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] bypass_snaplock_enterprise_retention # Setting this to `true` allows a SnapLock administrator to delete an # FSx for ONTAP SnapLock Enterprise volume with unexpired write once, # read many (WORM) files. The IAM permission # `fsx:BypassSnaplockEnterpriseRetention` is also required to delete # SnapLock Enterprise volumes with unexpired WORM files. The default # value is `false`. # # For more information, see [ Deleting a SnapLock volume][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-delete-volume.html # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOntapConfiguration AWS API Documentation # class DeleteVolumeOntapConfiguration < Struct.new( :skip_final_backup, :final_backup_tags, :bypass_snaplock_enterprise_retention) SENSITIVE = [] include Aws::Structure end # The response object for the Amazon FSx for NetApp ONTAP volume being # deleted in the `DeleteVolume` operation. # # @!attribute [rw] final_backup_id # The ID of the source backup. Specifies the backup that you are # copying. # @return [String] # # @!attribute [rw] final_backup_tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOntapResponse AWS API Documentation # class DeleteVolumeOntapResponse < Struct.new( :final_backup_id, :final_backup_tags) SENSITIVE = [] include Aws::Structure end # A value that specifies whether to delete all child volumes and # snapshots. # # @!attribute [rw] options # To delete the volume's child volumes, snapshots, and clones, use # the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOpenZFSConfiguration AWS API Documentation # class DeleteVolumeOpenZFSConfiguration < Struct.new( :options) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] volume_id # The ID of the volume that you are deleting. # @return [String] # # @!attribute [rw] ontap_configuration # For Amazon FSx for ONTAP volumes, specify whether to take a final # backup of the volume and apply tags to the backup. To apply tags to # the backup, you must have the `fsx:TagResource` permission. # @return [Types::DeleteVolumeOntapConfiguration] # # @!attribute [rw] open_zfs_configuration # For Amazon FSx for OpenZFS volumes, specify whether to delete all # child volumes and snapshots. # @return [Types::DeleteVolumeOpenZFSConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeRequest AWS API Documentation # class DeleteVolumeRequest < Struct.new( :client_request_token, :volume_id, :ontap_configuration, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volume_id # The ID of the volume that's being deleted. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle state of the volume being deleted. If the # `DeleteVolume` operation is successful, this value is `DELETING`. # @return [String] # # @!attribute [rw] ontap_response # Returned after a `DeleteVolume` request, showing the status of the # delete request. # @return [Types::DeleteVolumeOntapResponse] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeResponse AWS API Documentation # class DeleteVolumeResponse < Struct.new( :volume_id, :lifecycle, :ontap_response) SENSITIVE = [] include Aws::Structure end # The request object for the `DescribeBackups` operation. # # @!attribute [rw] backup_ids # The IDs of the backups that you want to retrieve. This parameter # value overrides any filters. If any IDs aren't found, a # `BackupNotFound` error occurs. # @return [Array] # # @!attribute [rw] filters # The filters structure. The supported names are `file-system-id`, # `backup-type`, `file-system-type`, and `volume-id`. # @return [Array] # # @!attribute [rw] max_results # Maximum number of backups to return in the response. 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. # @return [Integer] # # @!attribute [rw] next_token # An opaque pagination token returned from a previous # `DescribeBackups` operation. If a token is present, the operation # continues the list from where the returning call left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackupsRequest AWS API Documentation # class DescribeBackupsRequest < Struct.new( :backup_ids, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # Response object for the `DescribeBackups` operation. # # @!attribute [rw] backups # An array of backups. # @return [Array] # # @!attribute [rw] next_token # A `NextToken` value is present if there are more backups than # returned in the response. You can use the `NextToken` value in the # subsequent request to fetch the backups. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackupsResponse AWS API Documentation # class DescribeBackupsResponse < Struct.new( :backups, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] association_ids # IDs of the data repository associations whose descriptions you want # to retrieve (String). # @return [Array] # # @!attribute [rw] filters # A list of `Filter` elements. # @return [Array] # # @!attribute [rw] max_results # The maximum number of resources to return in the response. This # value must be an integer greater than zero. # @return [Integer] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeDataRepositoryAssociationsRequest AWS API Documentation # class DescribeDataRepositoryAssociationsRequest < Struct.new( :association_ids, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] associations # An array of one or more data repository association descriptions. # @return [Array] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeDataRepositoryAssociationsResponse AWS API Documentation # class DescribeDataRepositoryAssociationsResponse < Struct.new( :associations, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] task_ids # (Optional) IDs of the tasks whose descriptions you want to retrieve # (String). # @return [Array] # # @!attribute [rw] filters # (Optional) You can use filters to narrow the # `DescribeDataRepositoryTasks` response to include just tasks for # specific file systems, or tasks in a specific lifecycle state. # @return [Array] # # @!attribute [rw] max_results # The maximum number of resources to return in the response. This # value must be an integer greater than zero. # @return [Integer] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeDataRepositoryTasksRequest AWS API Documentation # class DescribeDataRepositoryTasksRequest < Struct.new( :task_ids, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_repository_tasks # The collection of data repository task descriptions returned. # @return [Array] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeDataRepositoryTasksResponse AWS API Documentation # class DescribeDataRepositoryTasksResponse < Struct.new( :data_repository_tasks, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_cache_ids # IDs of the caches whose descriptions you want to retrieve (String). # @return [Array] # # @!attribute [rw] max_results # The maximum number of resources to return in the response. This # value must be an integer greater than zero. # @return [Integer] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileCachesRequest AWS API Documentation # class DescribeFileCachesRequest < Struct.new( :file_cache_ids, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_caches # The response object for the `DescribeFileCaches` operation. # @return [Array] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileCachesResponse AWS API Documentation # class DescribeFileCachesResponse < Struct.new( :file_caches, :next_token) SENSITIVE = [] include Aws::Structure end # The request object for `DescribeFileSystemAliases` operation. # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] file_system_id # The ID of the file system to return the associated DNS aliases for # (String). # @return [String] # # @!attribute [rw] max_results # Maximum number of DNS aliases 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. # @return [Integer] # # @!attribute [rw] next_token # Opaque pagination token returned from a previous # `DescribeFileSystemAliases` operation (String). If a token is # included in the request, the action continues the list from where # the previous returning call left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemAliasesRequest AWS API Documentation # class DescribeFileSystemAliasesRequest < Struct.new( :client_request_token, :file_system_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # The response object for `DescribeFileSystemAliases` operation. # # @!attribute [rw] aliases # An array of one or more DNS aliases currently associated with the # specified file system. # @return [Array] # # @!attribute [rw] next_token # Present if there are more DNS aliases than returned in the response # (String). You can use the `NextToken` value in a later request to # fetch additional descriptions. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemAliasesResponse AWS API Documentation # class DescribeFileSystemAliasesResponse < Struct.new( :aliases, :next_token) SENSITIVE = [] include Aws::Structure end # The request object for `DescribeFileSystems` operation. # # @!attribute [rw] file_system_ids # IDs of the file systems whose descriptions you want to retrieve # (String). # @return [Array] # # @!attribute [rw] max_results # 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. # @return [Integer] # # @!attribute [rw] next_token # Opaque pagination token returned from a previous # `DescribeFileSystems` operation (String). If a token present, the # operation continues the list from where the returning call left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemsRequest AWS API Documentation # class DescribeFileSystemsRequest < Struct.new( :file_system_ids, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # The response object for `DescribeFileSystems` operation. # # @!attribute [rw] file_systems # An array of file system descriptions. # @return [Array] # # @!attribute [rw] next_token # Present if there are more file systems than returned in the response # (String). You can use the `NextToken` value in the later request to # fetch the descriptions. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemsResponse AWS API Documentation # class DescribeFileSystemsResponse < Struct.new( :file_systems, :next_token) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeSharedVpcConfigurationRequest AWS API Documentation # class DescribeSharedVpcConfigurationRequest < Aws::EmptyStructure; end # @!attribute [rw] enable_fsx_route_table_updates_from_participant_accounts # Indicates whether participant accounts can create FSx for ONTAP # Multi-AZ file systems in shared subnets. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeSharedVpcConfigurationResponse AWS API Documentation # class DescribeSharedVpcConfigurationResponse < Struct.new( :enable_fsx_route_table_updates_from_participant_accounts) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot_ids # The IDs of the snapshots that you want to retrieve. This parameter # value overrides any filters. If any IDs aren't found, a # `SnapshotNotFound` error occurs. # @return [Array] # # @!attribute [rw] filters # The filters structure. The supported names are `file-system-id` or # `volume-id`. # @return [Array] # # @!attribute [rw] max_results # The maximum number of resources to return in the response. This # value must be an integer greater than zero. # @return [Integer] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @!attribute [rw] include_shared # Set to `false` (default) if you want to only see the snapshots owned # by your Amazon Web Services account. Set to `true` if you want to # see the snapshots in your account and the ones shared with you from # another account. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeSnapshotsRequest AWS API Documentation # class DescribeSnapshotsRequest < Struct.new( :snapshot_ids, :filters, :max_results, :next_token, :include_shared) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshots # An array of snapshots. # @return [Array] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeSnapshotsResponse AWS API Documentation # class DescribeSnapshotsResponse < Struct.new( :snapshots, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] storage_virtual_machine_ids # Enter the ID of one or more SVMs that you want to view. # @return [Array] # # @!attribute [rw] filters # Enter a filter name:value pair to view a select set of SVMs. # @return [Array] # # @!attribute [rw] max_results # The maximum number of resources to return in the response. This # value must be an integer greater than zero. # @return [Integer] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeStorageVirtualMachinesRequest AWS API Documentation # class DescribeStorageVirtualMachinesRequest < Struct.new( :storage_virtual_machine_ids, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] storage_virtual_machines # Returned after a successful `DescribeStorageVirtualMachines` # operation, describing each SVM. # @return [Array] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeStorageVirtualMachinesResponse AWS API Documentation # class DescribeStorageVirtualMachinesResponse < Struct.new( :storage_virtual_machines, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volume_ids # The IDs of the volumes whose descriptions you want to retrieve. # @return [Array] # # @!attribute [rw] filters # Enter a filter `Name` and `Values` pair to view a select set of # volumes. # @return [Array] # # @!attribute [rw] max_results # The maximum number of resources to return in the response. This # value must be an integer greater than zero. # @return [Integer] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumesRequest AWS API Documentation # class DescribeVolumesRequest < Struct.new( :volume_ids, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volumes # Returned after a successful `DescribeVolumes` operation, describing # each volume. # @return [Array] # # @!attribute [rw] next_token # (Optional) Opaque pagination token returned from a previous # operation (String). If present, this token indicates from what point # you can continue processing the request, where the previous # `NextToken` value left off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumesResponse AWS API Documentation # class DescribeVolumesResponse < Struct.new( :volumes, :next_token) SENSITIVE = [] include Aws::Structure end # The request object of DNS aliases to disassociate from an Amazon FSx # for Windows File Server file system. # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] file_system_id # Specifies the file system from which to disassociate the DNS # aliases. # @return [String] # # @!attribute [rw] aliases # An array of one or more DNS alias names to disassociate, or remove, # from the file system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DisassociateFileSystemAliasesRequest AWS API Documentation # class DisassociateFileSystemAliasesRequest < Struct.new( :client_request_token, :file_system_id, :aliases) SENSITIVE = [] include Aws::Structure end # The system generated response showing the DNS aliases that Amazon FSx # is attempting to disassociate from the file system. Use the API # operation to monitor the status of the aliases Amazon FSx is removing # from the file system. # # @!attribute [rw] aliases # An array of one or more DNS aliases that Amazon FSx is attempting to # disassociate from the file system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DisassociateFileSystemAliasesResponse AWS API Documentation # class DisassociateFileSystemAliasesResponse < Struct.new( :aliases) SENSITIVE = [] include Aws::Structure end # The SSD IOPS (input/output operations per second) configuration for an # Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or # FSx for OpenZFS file system. By default, Amazon FSx automatically # provisions 3 IOPS per GB of storage capacity. You can provision # additional IOPS per GB of storage. The configuration consists of the # total number of provisioned SSD IOPS and how it is was provisioned, or # the mode (by the customer or by Amazon FSx). # # @!attribute [rw] mode # Specifies whether the file system is using the `AUTOMATIC` setting # of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a # `USER_PROVISIONED` value. # @return [String] # # @!attribute [rw] iops # The total number of SSD IOPS provisioned for the file system. # # The minimum and maximum values for this property depend on the value # of `HAPairs` and `StorageCapacity`. The minimum value is calculated # as `StorageCapacity` * 3 * `HAPairs` (3 IOPS per GB of # `StorageCapacity`). The maximum value is calculated as 200,000 * # `HAPairs`. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) if # the value of `Iops` is outside of the minimum or maximum values. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DiskIopsConfiguration AWS API Documentation # class DiskIopsConfiguration < Struct.new( :mode, :iops) SENSITIVE = [] include Aws::Structure end # Defines the minimum amount of time since last access for a file to be # eligible for release. Only files that have been exported to S3 and # that were last accessed or modified before this point-in-time are # eligible to be released from the Amazon FSx for Lustre file system. # # @!attribute [rw] unit # The unit of time used by the `Value` parameter to determine if a # file can be released, based on when it was last accessed. `DAYS` is # the only supported value. This is a required parameter. # @return [String] # # @!attribute [rw] value # An integer that represents the minimum amount of time (in days) # since a file was last accessed in the file system. Only exported # files with a `MAX(atime, ctime, mtime)` timestamp that is more than # this amount of time in the past (relative to the task create time) # will be released. The default of `Value` is `0`. This is a required # parameter. # # If an exported file meets the last accessed time criteria, its file # or directory path must also be specified in the `Paths` parameter of # the operation in order for the file to be released. # # # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DurationSinceLastAccess AWS API Documentation # class DurationSinceLastAccess < Struct.new( :unit, :value) SENSITIVE = [] include Aws::Structure end # A description of a specific Amazon File Cache resource, which is a # response object from the `DescribeFileCaches` operation. # # @!attribute [rw] owner_id # An Amazon Web Services account ID. This ID is a 12-digit number that # you use to construct Amazon Resource Names (ARNs) for resources. # @return [String] # # @!attribute [rw] creation_time # The time that the resource was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] file_cache_id # The system-generated, unique ID of the cache. # @return [String] # # @!attribute [rw] file_cache_type # The type of cache, which must be `LUSTRE`. # @return [String] # # @!attribute [rw] file_cache_type_version # The Lustre version of the cache, which must be `2.12`. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the cache. The following are the possible # values and what they mean: # # * `AVAILABLE` - The cache is in a healthy state, and is reachable # and available for use. # # * `CREATING` - The new cache is being created. # # * `DELETING` - An existing cache is being deleted. # # * `UPDATING` - The cache is undergoing a customer-initiated update. # # * `FAILED` - An existing cache has experienced an unrecoverable # failure. When creating a new cache, the cache was unable to be # created. # @return [String] # # @!attribute [rw] failure_details # A structure providing details of any failures that occurred. # @return [Types::FileCacheFailureDetails] # # @!attribute [rw] storage_capacity # The storage capacity of the cache in gibibytes (GiB). # @return [Integer] # # @!attribute [rw] vpc_id # The ID of your virtual private cloud (VPC). For more information, # see [VPC and subnets][1] in the *Amazon VPC User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html # @return [String] # # @!attribute [rw] subnet_ids # A list of subnet IDs that the cache will be accessible from. You can # specify only one subnet ID in a call to the `CreateFileCache` # operation. # @return [Array] # # @!attribute [rw] network_interface_ids # A list of network interface IDs. # @return [Array] # # @!attribute [rw] dns_name # The Domain Name System (DNS) name for the cache. # @return [String] # # @!attribute [rw] kms_key_id # Specifies the ID of the Key Management Service (KMS) key to use for # encrypting data on an Amazon File Cache. If a `KmsKeyId` isn't # specified, the Amazon FSx-managed KMS key for your account is used. # For more information, see [Encrypt][1] in the *Key Management # Service API Reference*. # # # # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] lustre_configuration # The configuration for the Amazon File Cache resource. # @return [Types::FileCacheLustreConfiguration] # # @!attribute [rw] data_repository_association_ids # A list of IDs of data repository associations that are associated # with this cache. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCache AWS API Documentation # class FileCache < Struct.new( :owner_id, :creation_time, :file_cache_id, :file_cache_type, :file_cache_type_version, :lifecycle, :failure_details, :storage_capacity, :vpc_id, :subnet_ids, :network_interface_ids, :dns_name, :kms_key_id, :resource_arn, :lustre_configuration, :data_repository_association_ids) SENSITIVE = [] include Aws::Structure end # The response object for the Amazon File Cache resource being created # in the `CreateFileCache` operation. # # @!attribute [rw] owner_id # An Amazon Web Services account ID. This ID is a 12-digit number that # you use to construct Amazon Resource Names (ARNs) for resources. # @return [String] # # @!attribute [rw] creation_time # The time that the resource was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] file_cache_id # The system-generated, unique ID of the cache. # @return [String] # # @!attribute [rw] file_cache_type # The type of cache, which must be `LUSTRE`. # @return [String] # # @!attribute [rw] file_cache_type_version # The Lustre version of the cache, which must be `2.12`. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the cache. The following are the possible # values and what they mean: # # * `AVAILABLE` - The cache is in a healthy state, and is reachable # and available for use. # # * `CREATING` - The new cache is being created. # # * `DELETING` - An existing cache is being deleted. # # * `UPDATING` - The cache is undergoing a customer-initiated update. # # * `FAILED` - An existing cache has experienced an unrecoverable # failure. When creating a new cache, the cache was unable to be # created. # @return [String] # # @!attribute [rw] failure_details # A structure providing details of any failures that occurred in # creating a cache. # @return [Types::FileCacheFailureDetails] # # @!attribute [rw] storage_capacity # The storage capacity of the cache in gibibytes (GiB). # @return [Integer] # # @!attribute [rw] vpc_id # The ID of your virtual private cloud (VPC). For more information, # see [VPC and subnets][1] in the *Amazon VPC User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html # @return [String] # # @!attribute [rw] subnet_ids # A list of subnet IDs that the cache will be accessible from. You can # specify only one subnet ID in a call to the `CreateFileCache` # operation. # @return [Array] # # @!attribute [rw] network_interface_ids # A list of network interface IDs. # @return [Array] # # @!attribute [rw] dns_name # The Domain Name System (DNS) name for the cache. # @return [String] # # @!attribute [rw] kms_key_id # Specifies the ID of the Key Management Service (KMS) key to use for # encrypting data on an Amazon File Cache. If a `KmsKeyId` isn't # specified, the Amazon FSx-managed KMS key for your account is used. # For more information, see [Encrypt][1] in the *Key Management # Service API Reference*. # # # # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] copy_tags_to_data_repository_associations # A boolean flag indicating whether tags for the cache should be # copied to data repository associations. # @return [Boolean] # # @!attribute [rw] lustre_configuration # The configuration for the Amazon File Cache resource. # @return [Types::FileCacheLustreConfiguration] # # @!attribute [rw] data_repository_association_ids # A list of IDs of data repository associations that are associated # with this cache. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCacheCreating AWS API Documentation # class FileCacheCreating < Struct.new( :owner_id, :creation_time, :file_cache_id, :file_cache_type, :file_cache_type_version, :lifecycle, :failure_details, :storage_capacity, :vpc_id, :subnet_ids, :network_interface_ids, :dns_name, :kms_key_id, :resource_arn, :tags, :copy_tags_to_data_repository_associations, :lustre_configuration, :data_repository_association_ids) SENSITIVE = [] include Aws::Structure end # The configuration for a data repository association (DRA) to be # created during the Amazon File Cache resource creation. The DRA links # the cache to either an Amazon S3 bucket or prefix, or a Network File # System (NFS) data repository that supports the NFSv3 protocol. # # The DRA does not support automatic import or automatic export. # # @!attribute [rw] file_cache_path # A path on the cache that points to a high-level directory (such as # `/ns1/`) or subdirectory (such as `/ns1/subdir/`) that will be # mapped 1-1 with `DataRepositoryPath`. The leading forward slash in # the name is required. Two data repository associations cannot have # overlapping cache paths. For example, if a data repository is # associated with cache path `/ns1/`, then you cannot link another # data repository with cache path `/ns1/ns2`. # # This path specifies where in your cache files will be exported from. # This cache directory can be linked to only one data repository, and # no data repository other can be linked to the directory. # # The cache path can only be set to root (/) on an NFS DRA when # `DataRepositorySubdirectories` is specified. If you specify root (/) # as the cache path, you can create only one DRA on the cache. # # The cache path cannot be set to root (/) for an S3 DRA. # # # @return [String] # # @!attribute [rw] data_repository_path # The path to the S3 or NFS data repository that links to the cache. # You must provide one of the following paths: # # * The path can be an NFS data repository that links to the cache. # The path can be in one of two formats: # # * If you are not using the `DataRepositorySubdirectories` # parameter, the path is to an NFS Export directory (or one of its # subdirectories) in the format # `nfs://nfs-domain-name/exportpath`. You can therefore link a # single NFS Export to a single data repository association. # # * If you are using the `DataRepositorySubdirectories` parameter, # the path is the domain name of the NFS file system in the format # `nfs://filer-domain-name`, which indicates the root of the # subdirectories specified with the `DataRepositorySubdirectories` # parameter. # # * The path can be an S3 bucket or prefix in the format # `s3://bucket-name/prefix/` (where `prefix` is optional). # @return [String] # # @!attribute [rw] data_repository_subdirectories # A list of NFS Exports that will be linked with this data repository # association. The Export paths are in the format `/exportpath1`. To # use this parameter, you must configure `DataRepositoryPath` as the # domain name of the NFS file system. The NFS file system domain name # in effect is the root of the subdirectories. Note that # `DataRepositorySubdirectories` is not supported for S3 data # repositories. # @return [Array] # # @!attribute [rw] nfs # The configuration for a data repository association that links an # Amazon File Cache resource to an NFS data repository. # @return [Types::FileCacheNFSConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCacheDataRepositoryAssociation AWS API Documentation # class FileCacheDataRepositoryAssociation < Struct.new( :file_cache_path, :data_repository_path, :data_repository_subdirectories, :nfs) SENSITIVE = [] include Aws::Structure end # A structure providing details of any failures that occurred. # # @!attribute [rw] message # A message describing any failures that occurred. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCacheFailureDetails AWS API Documentation # class FileCacheFailureDetails < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The configuration for the Amazon File Cache resource. # # @!attribute [rw] per_unit_storage_throughput # Per unit storage throughput represents the megabytes per second of # read or write throughput per 1 tebibyte of storage provisioned. # Cache throughput capacity is equal to Storage capacity (TiB) * # PerUnitStorageThroughput (MB/s/TiB). The only supported value is # `1000`. # @return [Integer] # # @!attribute [rw] deployment_type # The deployment type of the Amazon File Cache resource, which must be # `CACHE_1`. # @return [String] # # @!attribute [rw] mount_name # You use the `MountName` value when mounting the cache. If you pass a # cache ID to the `DescribeFileCaches` operation, it returns the the # `MountName` value as part of the cache's description. # @return [String] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] metadata_configuration # The configuration for a Lustre MDT (Metadata Target) storage volume. # @return [Types::FileCacheLustreMetadataConfiguration] # # @!attribute [rw] log_configuration # The configuration for Lustre logging used to write the enabled # logging events for your Amazon File Cache resource to Amazon # CloudWatch Logs. # @return [Types::LustreLogConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCacheLustreConfiguration AWS API Documentation # class FileCacheLustreConfiguration < Struct.new( :per_unit_storage_throughput, :deployment_type, :mount_name, :weekly_maintenance_start_time, :metadata_configuration, :log_configuration) SENSITIVE = [] include Aws::Structure end # The configuration for a Lustre MDT (Metadata Target) storage volume. # The metadata on Amazon File Cache is managed by a Lustre Metadata # Server (MDS) while the actual metadata is persisted on an MDT. # # @!attribute [rw] storage_capacity # The storage capacity of the Lustre MDT (Metadata Target) storage # volume in gibibytes (GiB). The only supported value is `2400` GiB. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCacheLustreMetadataConfiguration AWS API Documentation # class FileCacheLustreMetadataConfiguration < Struct.new( :storage_capacity) SENSITIVE = [] include Aws::Structure end # The configuration for an NFS data repository association (DRA) created # during the creation of the Amazon File Cache resource. # # @!attribute [rw] version # The version of the NFS (Network File System) protocol of the NFS # data repository. The only supported value is `NFS3`, which indicates # that the data repository must support the NFSv3 protocol. # @return [String] # # @!attribute [rw] dns_ips # A list of up to 2 IP addresses of DNS servers used to resolve the # NFS file system domain name. The provided IP addresses can either be # the IP addresses of a DNS forwarder or resolver that the customer # manages and runs inside the customer VPC, or the IP addresses of the # on-premises DNS servers. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCacheNFSConfiguration AWS API Documentation # class FileCacheNFSConfiguration < Struct.new( :version, :dns_ips) SENSITIVE = [] include Aws::Structure end # No caches were found based upon supplied parameters. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileCacheNotFound AWS API Documentation # class FileCacheNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A description of a specific Amazon FSx file system. # # @!attribute [rw] owner_id # The Amazon Web Services account that created the file system. If the # file system was created by a user in IAM Identity Center, the Amazon # Web Services account to which the IAM user belongs is the owner. # @return [String] # # @!attribute [rw] creation_time # The time that the file system was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] file_system_id # The system-generated, unique 17-digit ID of the file system. # @return [String] # # @!attribute [rw] file_system_type # The type of Amazon FSx file system, which can be `LUSTRE`, # `WINDOWS`, `ONTAP`, or `OPENZFS`. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the file system. The 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` - The file system is in a failed but recoverable # state. # # * `MISCONFIGURED_UNAVAILABLE` - (Amazon FSx for Windows File Server # only) The file system is currently unavailable due to a change in # your Active Directory configuration. # # * `UPDATING` - The file system is undergoing a customer-initiated # update. # @return [String] # # @!attribute [rw] failure_details # A structure providing details of any failures that occurred. # @return [Types::FileSystemFailureDetails] # # @!attribute [rw] storage_capacity # The storage capacity of the file system in gibibytes (GiB). # # Amazon FSx responds with an HTTP status code 400 (Bad Request) if # the value of `StorageCapacity` is outside of the minimum or maximum # values. # @return [Integer] # # @!attribute [rw] storage_type # The type of storage the file system is using. If set to `SSD`, the # file system uses solid state drive storage. If set to `HDD`, the # file system uses hard disk drive storage. # @return [String] # # @!attribute [rw] vpc_id # The ID of the primary virtual private cloud (VPC) for the file # system. # @return [String] # # @!attribute [rw] subnet_ids # Specifies the IDs of the subnets that the file system is accessible # from. For the Amazon FSx Windows and ONTAP `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 FSx for Lustre file systems, and Single-AZ Windows file systems, # this is the ID of the subnet that contains the file system's # endpoint. For `MULTI_AZ_1` Windows and ONTAP file systems, the file # system endpoint is available in the `PreferredSubnetID`. # @return [Array] # # @!attribute [rw] network_interface_ids # The IDs of the elastic network interfaces from which a specific file # system is accessible. The elastic network interface is automatically # created in the same virtual private cloud (VPC) that the Amazon FSx # file system was created in. For more information, see [Elastic # Network Interfaces][1] 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. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html # @return [Array] # # @!attribute [rw] dns_name # The Domain Name System (DNS) name for the file system. # @return [String] # # @!attribute [rw] kms_key_id # The ID of the Key Management Service (KMS) key used to encrypt # Amazon FSx file system data. Used as follows with Amazon FSx file # system types: # # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment # types only. # # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon # FSx service KMS key for your account. # # * Amazon FSx for NetApp ONTAP # # * Amazon FSx for OpenZFS # # * Amazon FSx for Windows File Server # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the file system resource. # @return [String] # # @!attribute [rw] tags # The tags to associate with the file system. For more information, # see [Tagging your Amazon FSx resources][1] in the *Amazon FSx for # Lustre User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html # @return [Array] # # @!attribute [rw] windows_configuration # The configuration for this Amazon FSx for Windows File Server file # system. # @return [Types::WindowsFileSystemConfiguration] # # @!attribute [rw] lustre_configuration # The configuration for the Amazon FSx for Lustre file system. # @return [Types::LustreFileSystemConfiguration] # # @!attribute [rw] administrative_actions # A list of administrative actions for the file system that are in # process or waiting to be processed. Administrative actions describe # changes to the Amazon FSx system that you have initiated using the # `UpdateFileSystem` operation. # @return [Array] # # @!attribute [rw] ontap_configuration # The configuration for this Amazon FSx for NetApp ONTAP file system. # @return [Types::OntapFileSystemConfiguration] # # @!attribute [rw] file_system_type_version # The Lustre version of the Amazon FSx for Lustre file system, which # can be `2.10`, `2.12`, or `2.15`. # @return [String] # # @!attribute [rw] open_zfs_configuration # The configuration for this Amazon FSx for OpenZFS file system. # @return [Types::OpenZFSFileSystemConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystem AWS API Documentation # class FileSystem < Struct.new( :owner_id, :creation_time, :file_system_id, :file_system_type, :lifecycle, :failure_details, :storage_capacity, :storage_type, :vpc_id, :subnet_ids, :network_interface_ids, :dns_name, :kms_key_id, :resource_arn, :tags, :windows_configuration, :lustre_configuration, :administrative_actions, :ontap_configuration, :file_system_type_version, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end # An Amazon FSx for NetApp ONTAP file system has two endpoints that are # used to access data or to manage the file system using the NetApp # ONTAP CLI, REST API, or NetApp SnapMirror. They are the `Management` # and `Intercluster` endpoints. # # @!attribute [rw] dns_name # The file system's DNS name. You can mount your file system using # its DNS name. # @return [String] # # @!attribute [rw] ip_addresses # IP addresses of the file system endpoint. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemEndpoint AWS API Documentation # class FileSystemEndpoint < Struct.new( :dns_name, :ip_addresses) SENSITIVE = [] include Aws::Structure end # An Amazon FSx for NetApp ONTAP file system has the following endpoints # that are used to access data or to manage the file system using the # NetApp ONTAP CLI, REST API, or NetApp SnapMirror. # # @!attribute [rw] intercluster # An endpoint for managing your file system by setting up NetApp # SnapMirror with other ONTAP systems. # @return [Types::FileSystemEndpoint] # # @!attribute [rw] management # An endpoint for managing your file system using the NetApp ONTAP CLI # and NetApp ONTAP API. # @return [Types::FileSystemEndpoint] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemEndpoints AWS API Documentation # class FileSystemEndpoints < Struct.new( :intercluster, :management) SENSITIVE = [] include Aws::Structure end # A structure providing details of any failures that occurred. # # @!attribute [rw] message # A message describing any failures that occurred. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemFailureDetails AWS API Documentation # class FileSystemFailureDetails < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The Lustre metadata performance configuration of an Amazon FSx for # Lustre file system using a `PERSISTENT_2` deployment type. The # configuration enables the file system to support increasing metadata # performance. # # @!attribute [rw] iops # The number of Metadata IOPS provisioned for the file system. Valid # values are `1500`, `3000`, `6000`, `12000`, and multiples of `12000` # up to a maximum of `192000`. # @return [Integer] # # @!attribute [rw] mode # The metadata configuration mode for provisioning Metadata IOPS for # the file system. # # * In AUTOMATIC mode, FSx for Lustre automatically provisions and # scales the number of Metadata IOPS on your file system based on # your file system storage capacity. # # * In USER\_PROVISIONED mode, you can choose to specify the number of # Metadata IOPS to provision for your file system. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemLustreMetadataConfiguration AWS API Documentation # class FileSystemLustreMetadataConfiguration < Struct.new( :iops, :mode) SENSITIVE = [] include Aws::Structure end # No Amazon FSx file systems were found based upon supplied parameters. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemNotFound AWS API Documentation # class FileSystemNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A filter used to restrict the results of describe calls. You can use # multiple filters to return results that meet all applied filter # requirements. # # @!attribute [rw] name # The name for this filter. # @return [String] # # @!attribute [rw] values # The values of the filter. These are all the values for any of the # applied filters. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Filter AWS API Documentation # class Filter < Struct.new( :name, :values) SENSITIVE = [] include Aws::Structure end # The error returned when a second request is received with the same # client request token but different parameters settings. A client # request token should always uniquely identify a single request. # # @!attribute [rw] parameter # A parameter that is incompatible with the earlier request. # @return [String] # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/IncompatibleParameterError AWS API Documentation # class IncompatibleParameterError < Struct.new( :parameter, :message) SENSITIVE = [] include Aws::Structure end # Amazon FSx doesn't support Multi-AZ Windows File Server copy backup # in the destination Region, so the copied backup can't be restored. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/IncompatibleRegionForMultiAZ AWS API Documentation # class IncompatibleRegionForMultiAZ < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A generic error indicating a server-side failure. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InternalServerError AWS API Documentation # class InternalServerError < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # You have filtered the response to a data repository type that is not # supported. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidDataRepositoryType AWS API Documentation # class InvalidDataRepositoryType < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The Key Management Service (KMS) key of the destination backup is not # valid. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidDestinationKmsKey AWS API Documentation # class InvalidDestinationKmsKey < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The path provided for data repository export isn't valid. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidExportPath AWS API Documentation # class InvalidExportPath < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The path provided for data repository import isn't valid. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidImportPath AWS API Documentation # class InvalidImportPath < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # One or more network settings specified in the request are invalid. # # @!attribute [rw] message # Error message explaining what's wrong with network settings. # @return [String] # # @!attribute [rw] invalid_subnet_id # The subnet ID that is either invalid or not part of the VPC # specified. # @return [String] # # @!attribute [rw] invalid_security_group_id # The security group ID is either invalid or not part of the VPC # specified. # @return [String] # # @!attribute [rw] invalid_route_table_id # The route table ID is either invalid or not part of the VPC # specified. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidNetworkSettings AWS API Documentation # class InvalidNetworkSettings < Struct.new( :message, :invalid_subnet_id, :invalid_security_group_id, :invalid_route_table_id) SENSITIVE = [] include Aws::Structure end # An invalid value for `PerUnitStorageThroughput` was provided. Please # create your file system again, using a valid value. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidPerUnitStorageThroughput AWS API Documentation # class InvalidPerUnitStorageThroughput < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The Region provided for `SourceRegion` is not valid or is in a # different Amazon Web Services partition. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidRegion AWS API Documentation # class InvalidRegion < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The Key Management Service (KMS) key of the source backup is not # valid. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidSourceKmsKey AWS API Documentation # class InvalidSourceKmsKey < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Describes why a resource lifecycle state changed. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LifecycleTransitionReason AWS API Documentation # class LifecycleTransitionReason < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The request object for `ListTagsForResource` operation. # # @!attribute [rw] resource_arn # The ARN of the Amazon FSx resource that will have its tags listed. # @return [String] # # @!attribute [rw] max_results # 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. # @return [Integer] # # @!attribute [rw] next_token # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResourceRequest AWS API Documentation # class ListTagsForResourceRequest < Struct.new( :resource_arn, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # The response object for `ListTagsForResource` operation. # # @!attribute [rw] tags # A list of tags on the resource. # @return [Array] # # @!attribute [rw] next_token # This is present if there are more tags than returned in the response # (String). You can use the `NextToken` value in the later request to # fetch the tags. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResourceResponse AWS API Documentation # class ListTagsForResourceResponse < Struct.new( :tags, :next_token) SENSITIVE = [] include Aws::Structure end # The configuration for the Amazon FSx for Lustre file system. # # @!attribute [rw] weekly_maintenance_start_time # The preferred start time to perform weekly maintenance, formatted # d:HH:MM in the UTC time zone. Here, `d` is the weekday number, from # 1 through 7, beginning with Monday and ending with Sunday. # @return [String] # # @!attribute [rw] data_repository_configuration # The data repository configuration object for Lustre file systems # returned in the response of the `CreateFileSystem` operation. # # This data type is not supported on file systems with a data # repository association. For file systems with a data repository # association, see . # @return [Types::DataRepositoryConfiguration] # # @!attribute [rw] deployment_type # 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` and `PERSISTENT_2` deployment type is used for # longer-term storage and workloads and encryption of data in transit. # `PERSISTENT_2` offers higher `PerUnitStorageThroughput` (up to 1000 # MB/s/TiB) along with a lower minimum storage capacity requirement # (600 GiB). To learn more about FSx for Lustre deployment types, see # [ FSx for Lustre deployment options][1]. # # The default is `SCRATCH_1`. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html # @return [String] # # @!attribute [rw] per_unit_storage_throughput # 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` and `PERSISTENT_2` deployment types. # # Valid values: # # * For `PERSISTENT_1` SSD storage: 50, 100, 200. # # * For `PERSISTENT_1` HDD storage: 12, 40. # # * For `PERSISTENT_2` SSD storage: 125, 250, 500, 1000. # @return [Integer] # # @!attribute [rw] mount_name # You use the `MountName` value when mounting the file system. # # For the `SCRATCH_1` deployment type, this value is always "`fsx`". # For `SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2` deployment # types, this value is a string that is unique within an Amazon Web # Services Region. # @return [String] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] copy_tags_to_backups # A boolean flag indicating whether tags on the file system are 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) # @return [Boolean] # # @!attribute [rw] drive_cache_type # The type of drive cache used by `PERSISTENT_1` file systems that are # provisioned with HDD storage devices. This parameter is required # when `StorageType` is HDD. When set to `READ` the file system has an # SSD storage cache that is sized to 20% of the file system's storage # capacity. This improves the performance for frequently accessed # files by caching up to 20% of the total storage capacity. # # This parameter is required when `StorageType` is set to HDD. # @return [String] # # @!attribute [rw] data_compression_type # The data compression configuration for the file system. # `DataCompressionType` can have the following values: # # * `NONE` - Data compression is turned off for the file system. # # * `LZ4` - Data compression is turned on with the LZ4 algorithm. # # For more information, see [Lustre data compression][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html # @return [String] # # @!attribute [rw] log_configuration # The Lustre logging configuration. Lustre logging writes the enabled # log events for your file system to Amazon CloudWatch Logs. # @return [Types::LustreLogConfiguration] # # @!attribute [rw] root_squash_configuration # The Lustre root squash configuration for an Amazon FSx for Lustre # file system. When enabled, root squash restricts root-level access # from clients that try to access your file system as a root user. # @return [Types::LustreRootSquashConfiguration] # # @!attribute [rw] metadata_configuration # The Lustre metadata performance configuration for an Amazon FSx for # Lustre file system using a `PERSISTENT_2` deployment type. # @return [Types::FileSystemLustreMetadataConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LustreFileSystemConfiguration AWS API Documentation # class LustreFileSystemConfiguration < Struct.new( :weekly_maintenance_start_time, :data_repository_configuration, :deployment_type, :per_unit_storage_throughput, :mount_name, :daily_automatic_backup_start_time, :automatic_backup_retention_days, :copy_tags_to_backups, :drive_cache_type, :data_compression_type, :log_configuration, :root_squash_configuration, :metadata_configuration) SENSITIVE = [] include Aws::Structure end # The configuration for Lustre logging used to write the enabled logging # events for your Amazon FSx for Lustre file system or Amazon File Cache # resource to Amazon CloudWatch Logs. # # @!attribute [rw] level # The data repository events that are logged by Amazon FSx. # # * `WARN_ONLY` - only warning events are logged. # # * `ERROR_ONLY` - only error events are logged. # # * `WARN_ERROR` - both warning events and error events are logged. # # * `DISABLED` - logging of data repository events is turned off. # # Note that Amazon File Cache uses a default setting of `WARN_ERROR`, # which can't be changed. # @return [String] # # @!attribute [rw] destination # The Amazon Resource Name (ARN) that specifies the destination of the # logs. The destination can be any Amazon CloudWatch Logs log group # ARN. The destination ARN must be in the same Amazon Web Services # partition, Amazon Web Services Region, and Amazon Web Services # account as your Amazon FSx file system. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LustreLogConfiguration AWS API Documentation # class LustreLogConfiguration < Struct.new( :level, :destination) SENSITIVE = [] include Aws::Structure end # The Lustre logging configuration used when creating or updating an # Amazon FSx for Lustre file system. An Amazon File Cache is created # with Lustre logging enabled by default, with a setting of `WARN_ERROR` # for the logging events. which can't be changed. # # Lustre logging writes the enabled logging events for your file system # or cache to Amazon CloudWatch Logs. # # @!attribute [rw] level # Sets which data repository events are logged by Amazon FSx. # # * `WARN_ONLY` - only warning events are logged. # # * `ERROR_ONLY` - only error events are logged. # # * `WARN_ERROR` - both warning events and error events are logged. # # * `DISABLED` - logging of data repository events is turned off. # @return [String] # # @!attribute [rw] destination # The Amazon Resource Name (ARN) that specifies the destination of the # logs. # # The destination can be any Amazon CloudWatch Logs log group ARN, # with the following requirements: # # * The destination ARN that you provide must be in the same Amazon # Web Services partition, Amazon Web Services Region, and Amazon Web # Services account as your Amazon FSx file system. # # * The name of the Amazon CloudWatch Logs log group must begin with # the `/aws/fsx` prefix. # # * If you do not provide a destination, Amazon FSx will create and # use a log stream in the CloudWatch Logs `/aws/fsx/lustre` log # group (for Amazon FSx for Lustre) or `/aws/fsx/filecache` (for # Amazon File Cache). # # * If `Destination` is provided and the resource does not exist, the # request will fail with a `BadRequest` error. # # * If `Level` is set to `DISABLED`, you cannot specify a destination # in `Destination`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LustreLogCreateConfiguration AWS API Documentation # class LustreLogCreateConfiguration < Struct.new( :level, :destination) SENSITIVE = [] include Aws::Structure end # The configuration for Lustre root squash used to restrict root-level # access from clients that try to access your FSx for Lustre file system # as root. Use the `RootSquash` parameter to enable root squash. To # learn more about Lustre root squash, see [Lustre root squash][1]. # # You can also use the `NoSquashNids` parameter to provide an array of # clients who are not affected by the root squash setting. These clients # will access the file system as root, with unrestricted privileges. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/root-squash.html # # @!attribute [rw] root_squash # You enable root squash by setting a user ID (UID) and group ID (GID) # for the file system in the format `UID:GID` (for example, # `365534:65534`). The UID and GID values can range from `0` to # `4294967294`: # # * A non-zero value for UID and GID enables root squash. The UID and # GID values can be different, but each must be a non-zero value. # # * A value of `0` (zero) for UID and GID indicates root, and # therefore disables root squash. # # When root squash is enabled, the user ID and group ID of a root user # accessing the file system are re-mapped to the UID and GID you # provide. # @return [String] # # @!attribute [rw] no_squash_nids # When root squash is enabled, you can optionally specify an array of # NIDs of clients for which root squash does not apply. A client NID # is a Lustre Network Identifier used to uniquely identify a client. # You can specify the NID as either a single address or a range of # addresses: # # * A single address is described in standard Lustre NID format by # specifying the client’s IP address followed by the Lustre network # ID (for example, `10.0.1.6@tcp`). # # * An address range is described using a dash to separate the range # (for example, `10.0.[2-10].[1-255]@tcp`). # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LustreRootSquashConfiguration AWS API Documentation # class LustreRootSquashConfiguration < Struct.new( :root_squash, :no_squash_nids) SENSITIVE = [] include Aws::Structure end # A cache configuration is required for this operation. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/MissingFileCacheConfiguration AWS API Documentation # class MissingFileCacheConfiguration < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A file system configuration is required for this operation. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/MissingFileSystemConfiguration AWS API Documentation # class MissingFileSystemConfiguration < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # A volume configuration is required for this operation. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/MissingVolumeConfiguration AWS API Documentation # class MissingVolumeConfiguration < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The configuration for a data repository association that links an # Amazon File Cache resource to an NFS data repository. # # @!attribute [rw] version # The version of the NFS (Network File System) protocol of the NFS # data repository. Currently, the only supported value is `NFS3`, # which indicates that the data repository must support the NFSv3 # protocol. # @return [String] # # @!attribute [rw] dns_ips # A list of up to 2 IP addresses of DNS servers used to resolve the # NFS file system domain name. The provided IP addresses can either be # the IP addresses of a DNS forwarder or resolver that the customer # manages and runs inside the customer VPC, or the IP addresses of the # on-premises DNS servers. # @return [Array] # # @!attribute [rw] auto_export_policy # This parameter is not supported for Amazon File Cache. # @return [Types::AutoExportPolicy] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/NFSDataRepositoryConfiguration AWS API Documentation # class NFSDataRepositoryConfiguration < Struct.new( :version, :dns_ips, :auto_export_policy) SENSITIVE = [] include Aws::Structure end # The resource specified for the tagging operation is not a resource # type owned by Amazon FSx. Use the API of the relevant service to # perform the operation. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the non-Amazon FSx resource. # @return [String] # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/NotServiceResourceError AWS API Documentation # class NotServiceResourceError < Struct.new( :resource_arn, :message) SENSITIVE = [] include Aws::Structure end # Configuration for the FSx for NetApp ONTAP file system. # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] deployment_type # Specifies the FSx for ONTAP file system deployment type in use in # the file system. # # * `MULTI_AZ_1` - A high availability file system configured for # Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) # unavailability. This is a first-generation FSx for ONTAP file # system. # # * `MULTI_AZ_2` - A high availability file system configured for # Multi-AZ redundancy to tolerate temporary AZ unavailability. This # is a second-generation FSx for ONTAP file system. # # * `SINGLE_AZ_1` - A file system configured for Single-AZ redundancy. # This is a first-generation FSx for ONTAP file system. # # * `SINGLE_AZ_2` - A file system configured with multiple # high-availability (HA) pairs for Single-AZ redundancy. This is a # second-generation FSx for ONTAP file system. # # For information about the use cases for Multi-AZ and Single-AZ # deployments, refer to [Choosing Multi-AZ or Single-AZ file system # deployment][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html # @return [String] # # @!attribute [rw] endpoint_ip_address_range # (Multi-AZ only) Specifies the IP address range in which the # endpoints to access your file system will be created. By default in # the Amazon FSx API, Amazon FSx selects an unused IP address range # for you from the 198.19.* range. By default in the Amazon FSx # console, Amazon FSx chooses the last 64 IP addresses from the VPC’s # primary CIDR range to use as the endpoint IP address range for the # file system. You can have overlapping endpoint IP addresses for file # systems deployed in the same VPC/route tables. # @return [String] # # @!attribute [rw] endpoints # The `Management` and `Intercluster` endpoints that are used to # access data or to manage the file system using the NetApp ONTAP CLI, # REST API, or NetApp SnapMirror. # @return [Types::FileSystemEndpoints] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS configuration for the ONTAP file system, specifying the # number of provisioned IOPS and the provision mode. # @return [Types::DiskIopsConfiguration] # # @!attribute [rw] preferred_subnet_id # 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][1] in the *Amazon VPC User Guide.* # # # # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html # @return [String] # # @!attribute [rw] route_table_ids # (Multi-AZ only) The VPC route tables in which your file system's # endpoints are created. # @return [Array] # # @!attribute [rw] throughput_capacity # The sustained throughput of an Amazon FSx file system in Megabytes # per second (MBps). # @return [Integer] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] fsx_admin_password # You can use the `fsxadmin` user account to access the NetApp ONTAP # CLI and REST API. The password value is always redacted in the # response. # @return [String] # # @!attribute [rw] ha_pairs # Specifies how many high-availability (HA) file server pairs the file # system will have. The default value is 1. The value of this property # affects the values of `StorageCapacity`, `Iops`, and # `ThroughputCapacity`. For more information, see [High-availability # (HA) pairs][1] in the FSx for ONTAP user guide. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The value of `HAPairs` is less than 1 or greater than 12. # # * The value of `HAPairs` is greater than 1 and the value of # `DeploymentType` is `SINGLE_AZ_1`, `MULTI_AZ_1`, or `MULTI_AZ_2`. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html # @return [Integer] # # @!attribute [rw] throughput_capacity_per_ha_pair # Use to choose the throughput capacity per HA pair. When the value of # `HAPairs` is equal to 1, the value of `ThroughputCapacityPerHAPair` # is the total throughput for the file system. # # This field and `ThroughputCapacity` cannot be defined in the same # API call, but one is required. # # This field and `ThroughputCapacity` are the same for file systems # with one HA pair. # # * For `SINGLE_AZ_1` and `MULTI_AZ_1` file systems, valid values are # 128, 256, 512, 1024, 2048, or 4096 MBps. # # * For `SINGLE_AZ_2`, valid values are 1536, 3072, or 6144 MBps. # # * For `MULTI_AZ_2`, valid values are 384, 768, 1536, 3072, or 6144 # MBps. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The value of `ThroughputCapacity` and # `ThroughputCapacityPerHAPair` are not the same value. # # * The value of deployment type is `SINGLE_AZ_2` and # `ThroughputCapacity` / `ThroughputCapacityPerHAPair` is not a # valid HA pair (a value between 1 and 12). # # * The value of `ThroughputCapacityPerHAPair` is not a valid value. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapFileSystemConfiguration AWS API Documentation # class OntapFileSystemConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :deployment_type, :endpoint_ip_address_range, :endpoints, :disk_iops_configuration, :preferred_subnet_id, :route_table_ids, :throughput_capacity, :weekly_maintenance_start_time, :fsx_admin_password, :ha_pairs, :throughput_capacity_per_ha_pair) SENSITIVE = [:fsx_admin_password] include Aws::Structure end # The configuration of an Amazon FSx for NetApp ONTAP volume. # # @!attribute [rw] flex_cache_endpoint_type # Specifies the FlexCache endpoint type of the volume. Valid values # are the following: # # * `NONE` specifies that the volume doesn't have a FlexCache # configuration. `NONE` is the default. # # * `ORIGIN` specifies that the volume is the origin volume for a # FlexCache volume. # # * `CACHE` specifies that the volume is a FlexCache volume. # @return [String] # # @!attribute [rw] junction_path # Specifies the directory that network-attached storage (NAS) clients # use to mount the volume, along with the storage virtual machine # (SVM) Domain Name System (DNS) name or IP address. You can create a # `JunctionPath` directly below a parent volume junction or on a # directory within a volume. A `JunctionPath` for a volume named # `vol3` might be `/vol1/vol2/vol3`, or `/vol1/dir2/vol3`, or even # `/dir1/dir2/vol3`. # @return [String] # # @!attribute [rw] security_style # The security style for the volume, which can be `UNIX`, `NTFS`, or # `MIXED`. # @return [String] # # @!attribute [rw] size_in_megabytes # The configured size of the volume, in megabytes (MBs). # @return [Integer] # # @!attribute [rw] storage_efficiency_enabled # The volume's storage efficiency setting. # @return [Boolean] # # @!attribute [rw] storage_virtual_machine_id # The ID of the volume's storage virtual machine. # @return [String] # # @!attribute [rw] storage_virtual_machine_root # A Boolean flag indicating whether this volume is the root volume for # its storage virtual machine (SVM). Only one volume on an SVM can be # the root volume. This value defaults to `false`. If this value is # `true`, then this is the SVM root volume. # # This flag is useful when you're deleting an SVM, because you must # first delete all non-root volumes. This flag, when set to `false`, # helps you identify which volumes to delete before you can delete the # SVM. # @return [Boolean] # # @!attribute [rw] tiering_policy # The volume's `TieringPolicy` setting. # @return [Types::TieringPolicy] # # @!attribute [rw] uuid # The volume's universally unique identifier (UUID). # @return [String] # # @!attribute [rw] ontap_volume_type # Specifies the type of volume. Valid values are the following: # # * `RW` specifies a read/write volume. `RW` is the default. # # * `DP` specifies a data-protection volume. You can protect data by # replicating it to data-protection mirror copies. If a disaster # occurs, you can use these data-protection mirror copies to recover # data. # # * `LS` specifies a load-sharing mirror volume. A load-sharing mirror # reduces the network traffic to a FlexVol volume by providing # additional read-only access to clients. # @return [String] # # @!attribute [rw] snapshot_policy # Specifies the snapshot policy for the volume. There are three # built-in snapshot policies: # # * `default`: This is the default policy. A maximum of six hourly # snapshots taken five minutes past the hour. A maximum of two daily # snapshots taken Monday through Saturday at 10 minutes after # midnight. A maximum of two weekly snapshots taken every Sunday at # 15 minutes after midnight. # # * `default-1weekly`: This policy is the same as the `default` policy # except that it only retains one snapshot from the weekly schedule. # # * `none`: This policy does not take any snapshots. This policy can # be assigned to volumes to prevent automatic snapshots from being # taken. # # You can also provide the name of a custom policy that you created # with the ONTAP CLI or REST API. # # For more information, see [Snapshot policies][1] in the Amazon FSx # for NetApp ONTAP User Guide. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies # @return [String] # # @!attribute [rw] copy_tags_to_backups # A boolean flag indicating whether tags for the volume should be # copied to backups. This value defaults to false. If it's set to # true, all tags for the volume 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. If you specify one or more tags when # creating a user-initiated backup, no tags are copied from the # volume, regardless of this value. # @return [Boolean] # # @!attribute [rw] snaplock_configuration # The SnapLock configuration object for an FSx for ONTAP SnapLock # volume. # @return [Types::SnaplockConfiguration] # # @!attribute [rw] volume_style # Use to specify the style of an ONTAP volume. For more information # about FlexVols and FlexGroups, see [Volume types][1] in Amazon FSx # for NetApp ONTAP User Guide. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types.html # @return [String] # # @!attribute [rw] aggregate_configuration # This structure specifies configuration options for a volume’s # storage aggregate or aggregates. # @return [Types::AggregateConfiguration] # # @!attribute [rw] size_in_bytes # The configured size of the volume, in bytes. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapVolumeConfiguration AWS API Documentation # class OntapVolumeConfiguration < Struct.new( :flex_cache_endpoint_type, :junction_path, :security_style, :size_in_megabytes, :storage_efficiency_enabled, :storage_virtual_machine_id, :storage_virtual_machine_root, :tiering_policy, :uuid, :ontap_volume_type, :snapshot_policy, :copy_tags_to_backups, :snaplock_configuration, :volume_style, :aggregate_configuration, :size_in_bytes) SENSITIVE = [] include Aws::Structure end # Specifies who can mount an OpenZFS file system and the options # available while mounting the file system. # # @!attribute [rw] clients # A value that specifies who can mount the file system. You can # provide a wildcard character (`*`), an IP address (`0.0.0.0`), or a # CIDR address (`192.0.2.0/24`). By default, Amazon FSx uses the # wildcard character when specifying the client. # @return [String] # # @!attribute [rw] options # The options to use when mounting the file system. For a list of # options that you can use with Network File System (NFS), see the # [exports(5) - Linux man page][1]. When choosing your options, # consider the following: # # * `crossmnt` is used by default. If you don't specify `crossmnt` # when changing the client configuration, you won't be able to see # or access snapshots in your file system's snapshot directory. # # * `sync` is used by default. If you instead specify `async`, the # system acknowledges writes before writing to disk. If the system # crashes before the writes are finished, you lose the unwritten # data. # # # # [1]: https://linux.die.net/man/5/exports # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSClientConfiguration AWS API Documentation # class OpenZFSClientConfiguration < Struct.new( :clients, :options) SENSITIVE = [] include Aws::Structure end # The configuration of an Amazon FSx for OpenZFS root volume. # # @!attribute [rw] record_size_ki_b # Specifies the record size of an OpenZFS root volume, in kibibytes # (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 # KiB. The default is 128 KiB. Most workloads should use the default # record size. Database workflows can benefit from a smaller record # size, while streaming workflows can benefit from a larger record # size. For additional guidance on setting a custom record size, see [ # Tips for maximizing performance][1] in the *Amazon FSx for OpenZFS # User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs # @return [Integer] # # @!attribute [rw] data_compression_type # Specifies the method used to compress the data on the volume. The # compression type is `NONE` by default. # # * `NONE` - Doesn't compress the data on the volume. `NONE` is the # default. # # * `ZSTD` - Compresses the data in the volume using the Zstandard # (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides # a better compression ratio to minimize on-disk storage # utilization. # # * `LZ4` - Compresses the data in the volume using the LZ4 # compression algorithm. Compared to Z-Standard, LZ4 is less # compute-intensive and delivers higher write throughput speeds. # @return [String] # # @!attribute [rw] nfs_exports # The configuration object for mounting a file system. # @return [Array] # # @!attribute [rw] user_and_group_quotas # An object specifying how much storage users or groups can use on the # volume. # @return [Array] # # @!attribute [rw] copy_tags_to_snapshots # A Boolean value indicating whether tags for the volume should be # copied to snapshots of the volume. This value defaults to `false`. # If it's set to `true`, all tags for the volume are copied to # snapshots 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 snapshots. If you specify one or more tags when creating # the snapshot, no tags are copied from the volume, regardless of this # value. # @return [Boolean] # # @!attribute [rw] read_only # A Boolean value indicating whether the volume is read-only. Setting # this value to `true` can be useful after you have completed changes # to a volume and no longer want changes to occur. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSCreateRootVolumeConfiguration AWS API Documentation # class OpenZFSCreateRootVolumeConfiguration < Struct.new( :record_size_ki_b, :data_compression_type, :nfs_exports, :user_and_group_quotas, :copy_tags_to_snapshots, :read_only) SENSITIVE = [] include Aws::Structure end # The configuration for the Amazon FSx for OpenZFS file system. # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] copy_tags_to_backups # A Boolean value 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. # @return [Boolean] # # @!attribute [rw] copy_tags_to_volumes # A Boolean value indicating whether tags for the volume should be # copied to snapshots. This value defaults to `false`. If it's set to # `true`, all tags for the volume are copied to snapshots 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 snapshots. # If you specify one or more tags when creating the snapshot, no tags # are copied from the volume, regardless of this value. # @return [Boolean] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] deployment_type # Specifies the file-system deployment type. Amazon FSx for OpenZFS # supports
 `MULTI_AZ_1`, `SINGLE_AZ_HA_2`, `SINGLE_AZ_HA_1`, # `SINGLE_AZ_2`, and `SINGLE_AZ_1`. # @return [String] # # @!attribute [rw] throughput_capacity # The throughput of an Amazon FSx file system, measured in megabytes # per second (MBps). # @return [Integer] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS (input/output operations per second) configuration for # an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, # or FSx for OpenZFS file system. By default, Amazon FSx automatically # provisions 3 IOPS per GB of storage capacity. You can provision # additional IOPS per GB of storage. The configuration consists of the # total number of provisioned SSD IOPS and how it is was provisioned, # or the mode (by the customer or by Amazon FSx). # @return [Types::DiskIopsConfiguration] # # @!attribute [rw] root_volume_id # The ID of the root volume of the OpenZFS file system. # @return [String] # # @!attribute [rw] preferred_subnet_id # Required when `DeploymentType` is set to `MULTI_AZ_1`. This # specifies the subnet in which you want the preferred file server to # be located. # @return [String] # # @!attribute [rw] endpoint_ip_address_range # (Multi-AZ only) Specifies the IP address range in which the # endpoints to access your file system will be created. By default in # the Amazon FSx API and Amazon FSx console, Amazon FSx selects an # available /28 IP address range for you from one of the VPC's CIDR # ranges. You can have overlapping endpoint IP addresses for file # systems deployed in the same VPC/route tables. # @return [String] # # @!attribute [rw] route_table_ids # (Multi-AZ only) The VPC route tables in which your file system's # endpoints are created. # @return [Array] # # @!attribute [rw] endpoint_ip_address # The IP address of the endpoint that is used to access data or to # manage the file system. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSFileSystemConfiguration AWS API Documentation # class OpenZFSFileSystemConfiguration < Struct.new( :automatic_backup_retention_days, :copy_tags_to_backups, :copy_tags_to_volumes, :daily_automatic_backup_start_time, :deployment_type, :throughput_capacity, :weekly_maintenance_start_time, :disk_iops_configuration, :root_volume_id, :preferred_subnet_id, :endpoint_ip_address_range, :route_table_ids, :endpoint_ip_address) SENSITIVE = [] include Aws::Structure end # The Network File System (NFS) configurations for mounting an Amazon # FSx for OpenZFS file system. # # @!attribute [rw] client_configurations # A list of configuration objects that contain the client and options # for mounting the OpenZFS file system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSNfsExport AWS API Documentation # class OpenZFSNfsExport < Struct.new( :client_configurations) SENSITIVE = [] include Aws::Structure end # The snapshot configuration used when creating an Amazon FSx for # OpenZFS volume from a snapshot. # # @!attribute [rw] snapshot_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] copy_strategy # The strategy used when copying data from the snapshot to the new # volume. # # * `CLONE` - The new volume references the data in the origin # snapshot. Cloning a snapshot is faster than copying the data from # a snapshot to a new volume and doesn't consume disk throughput. # However, the origin snapshot can't be deleted if there is a # volume using its copied data. # # * `FULL_COPY` - Copies all data from the snapshot to the new volume. # # The `INCREMENTAL_COPY` option is only for updating an existing # volume by using a snapshot from another FSx for OpenZFS file system. # For more information, see [CopySnapshotAndUpdateVolume][1]. # # # # # # [1]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSOriginSnapshotConfiguration AWS API Documentation # class OpenZFSOriginSnapshotConfiguration < Struct.new( :snapshot_arn, :copy_strategy) SENSITIVE = [] include Aws::Structure end # Used to configure quotas that define how much storage a user or group # can use on an FSx for OpenZFS volume. For more information, see # [Volume properties][1] in the FSx for OpenZFS User Guide. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties # # @!attribute [rw] type # Specifies whether the quota applies to a user or group. # @return [String] # # @!attribute [rw] id # The ID of the user or group that the quota applies to. # @return [Integer] # # @!attribute [rw] storage_capacity_quota_gi_b # The user or group's storage quota, in gibibytes (GiB). # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSUserOrGroupQuota AWS API Documentation # class OpenZFSUserOrGroupQuota < Struct.new( :type, :id, :storage_capacity_quota_gi_b) SENSITIVE = [] include Aws::Structure end # The configuration of an Amazon FSx for OpenZFS volume. # # @!attribute [rw] parent_volume_id # The ID of the parent volume. # @return [String] # # @!attribute [rw] volume_path # The path to the volume from the root volume. For example, # `fsx/parentVolume/volume1`. # @return [String] # # @!attribute [rw] storage_capacity_reservation_gi_b # The amount of storage in gibibytes (GiB) to reserve from the parent # volume. You can't reserve more storage than the parent volume has # reserved. # @return [Integer] # # @!attribute [rw] storage_capacity_quota_gi_b # The maximum amount of storage in gibibtyes (GiB) that the volume can # use from its parent. You can specify a quota larger than the storage # on the parent volume. # @return [Integer] # # @!attribute [rw] record_size_ki_b # The record size of an OpenZFS volume, in kibibytes (KiB). Valid # values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default # is 128 KiB. Most workloads should use the default record size. For # guidance on when to set a custom record size, see the *Amazon FSx # for OpenZFS User Guide*. # @return [Integer] # # @!attribute [rw] data_compression_type # Specifies the method used to compress the data on the volume. The # compression type is `NONE` by default. # # * `NONE` - Doesn't compress the data on the volume. `NONE` is the # default. # # * `ZSTD` - Compresses the data in the volume using the Zstandard # (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides # a better compression ratio to minimize on-disk storage # utilization. # # * `LZ4` - Compresses the data in the volume using the LZ4 # compression algorithm. Compared to Z-Standard, LZ4 is less # compute-intensive and delivers higher write throughput speeds. # @return [String] # # @!attribute [rw] copy_tags_to_snapshots # A Boolean value indicating whether tags for the volume should be # copied to snapshots. This value defaults to `false`. If it's set to # `true`, all tags for the volume are copied to snapshots 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 snapshots. # If you specify one or more tags when creating the snapshot, no tags # are copied from the volume, regardless of this value. # @return [Boolean] # # @!attribute [rw] origin_snapshot # The configuration object that specifies the snapshot to use as the # origin of the data for the volume. # @return [Types::OpenZFSOriginSnapshotConfiguration] # # @!attribute [rw] read_only # A Boolean value indicating whether the volume is read-only. # @return [Boolean] # # @!attribute [rw] nfs_exports # The configuration object for mounting a Network File System (NFS) # file system. # @return [Array] # # @!attribute [rw] user_and_group_quotas # An object specifying how much storage users or groups can use on the # volume. # @return [Array] # # @!attribute [rw] restore_to_snapshot # Specifies the ID of the snapshot to which the volume was restored. # @return [String] # # @!attribute [rw] delete_intermediate_snaphots # A Boolean value indicating whether snapshots between the current # state and the specified snapshot should be deleted when a volume is # restored from snapshot. # @return [Boolean] # # @!attribute [rw] delete_cloned_volumes # A Boolean value indicating whether dependent clone volumes created # from intermediate snapshots should be deleted when a volume is # restored from snapshot. # @return [Boolean] # # @!attribute [rw] delete_intermediate_data # A Boolean value indicating whether snapshot data that differs # between the current state and the specified snapshot should be # overwritten when a volume is restored from a snapshot. # @return [Boolean] # # @!attribute [rw] source_snapshot_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] destination_snapshot # The ID of the snapshot that's being copied or was most recently # copied to the destination volume. # @return [String] # # @!attribute [rw] copy_strategy # Specifies the strategy used when copying data from the snapshot to # the new volume. # # * `CLONE` - The new volume references the data in the origin # snapshot. Cloning a snapshot is faster than copying data from the # snapshot to a new volume and doesn't consume disk throughput. # However, the origin snapshot can't be deleted if there is a # volume using its copied data. # # * `FULL_COPY` - Copies all data from the snapshot to the new volume. # # Specify this option to create the volume from a snapshot on # another FSx for OpenZFS file system. # # The `INCREMENTAL_COPY` option is only for updating an existing # volume by using a snapshot from another FSx for OpenZFS file system. # For more information, see [CopySnapshotAndUpdateVolume][1]. # # # # # # [1]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSVolumeConfiguration AWS API Documentation # class OpenZFSVolumeConfiguration < Struct.new( :parent_volume_id, :volume_path, :storage_capacity_reservation_gi_b, :storage_capacity_quota_gi_b, :record_size_ki_b, :data_compression_type, :copy_tags_to_snapshots, :origin_snapshot, :read_only, :nfs_exports, :user_and_group_quotas, :restore_to_snapshot, :delete_intermediate_snaphots, :delete_cloned_volumes, :delete_intermediate_data, :source_snapshot_arn, :destination_snapshot, :copy_strategy) SENSITIVE = [] include Aws::Structure end # The configuration that specifies a minimum amount of time since last # access for an exported file to be eligible for release from an Amazon # FSx for Lustre file system. Only files that were last accessed before # this point-in-time can be released. For example, if you specify a last # accessed time criteria of 9 days, only files that were last accessed # 9.00001 or more days ago can be released. # # Only file data that has been exported to S3 can be released. Files # that have not yet been exported to S3, such as new or changed files # that have not been exported, are not eligible for release. When files # are released, their metadata stays on the file system, so they can # still be accessed later. Users and applications can access a released # file by reading the file again, which restores data from Amazon S3 to # the FSx for Lustre file system. # # If a file meets the last accessed time criteria, its file or directory # path must also be specified with the `Paths` parameter of the # operation in order for the file to be released. # # # # @!attribute [rw] duration_since_last_access # Defines the point-in-time since an exported file was last accessed, # in order for that file to be eligible for release. Only files that # were last accessed before this point-in-time are eligible to be # released from the file system. # @return [Types::DurationSinceLastAccess] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ReleaseConfiguration AWS API Documentation # class ReleaseConfiguration < Struct.new( :duration_since_last_access) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ReleaseFileSystemNfsV3LocksRequest AWS API Documentation # class ReleaseFileSystemNfsV3LocksRequest < Struct.new( :file_system_id, :client_request_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_system # A description of a specific Amazon FSx file system. # @return [Types::FileSystem] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ReleaseFileSystemNfsV3LocksResponse AWS API Documentation # class ReleaseFileSystemNfsV3LocksResponse < Struct.new( :file_system) SENSITIVE = [] include Aws::Structure end # The resource specified does not support tagging. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource that doesn't support # tagging. # @return [String] # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ResourceDoesNotSupportTagging AWS API Documentation # class ResourceDoesNotSupportTagging < Struct.new( :resource_arn, :message) SENSITIVE = [] include Aws::Structure end # The resource specified by the Amazon Resource Name (ARN) can't be # found. # # @!attribute [rw] resource_arn # The resource ARN of the resource that can't be found. # @return [String] # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ResourceNotFound AWS API Documentation # class ResourceNotFound < Struct.new( :resource_arn, :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] volume_id # The ID of the volume that you are restoring. # @return [String] # # @!attribute [rw] snapshot_id # The ID of the source snapshot. Specifies the snapshot that you are # restoring from. # @return [String] # # @!attribute [rw] options # The settings used when restoring the specified volume from snapshot. # # * `DELETE_INTERMEDIATE_SNAPSHOTS` - Deletes snapshots between the # current state and the specified snapshot. If there are # intermediate snapshots and this option isn't used, # `RestoreVolumeFromSnapshot` fails. # # * `DELETE_CLONED_VOLUMES` - Deletes any dependent clone volumes # created from intermediate snapshots. If there are any dependent # clone volumes and this option isn't used, # `RestoreVolumeFromSnapshot` fails. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/RestoreVolumeFromSnapshotRequest AWS API Documentation # class RestoreVolumeFromSnapshotRequest < Struct.new( :client_request_token, :volume_id, :snapshot_id, :options) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volume_id # The ID of the volume that you restored. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle state of the volume being restored. # @return [String] # # @!attribute [rw] administrative_actions # A list of administrative actions for the file system that are in # process or waiting to be processed. Administrative actions describe # changes to the Amazon FSx system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/RestoreVolumeFromSnapshotResponse AWS API Documentation # class RestoreVolumeFromSnapshotResponse < Struct.new( :volume_id, :lifecycle, :administrative_actions) SENSITIVE = [] include Aws::Structure end # Specifies the retention period of an FSx for ONTAP SnapLock volume. # After it is set, it can't be changed. Files can't be deleted or # modified during the retention period. # # For more information, see [Working with the retention period in # SnapLock][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html # # @!attribute [rw] type # Defines the type of time for the retention period of an FSx for # ONTAP SnapLock volume. Set it to one of the valid types. If you set # it to `INFINITE`, the files are retained forever. If you set it to # `UNSPECIFIED`, the files are retained until you set an explicit # retention period. # @return [String] # # @!attribute [rw] value # Defines the amount of time for the retention period of an FSx for # ONTAP SnapLock volume. You can't set a value for `INFINITE` or # `UNSPECIFIED`. For all other options, the following ranges are # valid: # # * `Seconds`: 0 - 65,535 # # * `Minutes`: 0 - 65,535 # # * `Hours`: 0 - 24 # # * `Days`: 0 - 365 # # * `Months`: 0 - 12 # # * `Years`: 0 - 100 # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/RetentionPeriod AWS API Documentation # class RetentionPeriod < Struct.new( :type, :value) SENSITIVE = [] include Aws::Structure end # The configuration for an Amazon S3 data repository linked to an Amazon # FSx for Lustre file system with a data repository association. The # configuration consists of an `AutoImportPolicy` that defines which # file events on the data repository are automatically imported to the # file system and an `AutoExportPolicy` that defines which file events # on the file system are automatically exported to the data repository. # File events are when files or directories are added, changed, or # deleted on the file system or the data repository. # # Data repository associations on Amazon File Cache don't use # `S3DataRepositoryConfiguration` because they don't support automatic # import or automatic export. # # # # @!attribute [rw] auto_import_policy # Specifies the type of updated objects (new, changed, deleted) that # will be automatically imported from the linked S3 bucket to your # file system. # @return [Types::AutoImportPolicy] # # @!attribute [rw] auto_export_policy # Specifies the type of updated objects (new, changed, deleted) that # will be automatically exported from your file system to the linked # S3 bucket. # @return [Types::AutoExportPolicy] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/S3DataRepositoryConfiguration AWS API Documentation # class S3DataRepositoryConfiguration < Struct.new( :auto_import_policy, :auto_export_policy) SENSITIVE = [] include Aws::Structure end # The configuration of the self-managed Microsoft Active Directory (AD) # directory to which the Windows File Server or ONTAP storage virtual # machine (SVM) instance is joined. # # @!attribute [rw] domain_name # The fully qualified domain name of the self-managed AD directory. # @return [String] # # @!attribute [rw] organizational_unit_distinguished_name # The fully qualified distinguished name of the organizational unit # within the self-managed AD directory to which the Windows File # Server or ONTAP storage virtual machine (SVM) instance is joined. # @return [String] # # @!attribute [rw] file_system_administrators_group # The name of the domain group whose members have administrative # privileges for the FSx file system. # @return [String] # # @!attribute [rw] user_name # The user name for the service account on your self-managed AD domain # that FSx uses to join to your AD domain. # @return [String] # # @!attribute [rw] dns_ips # A list of up to three IP addresses of DNS servers or domain # controllers in the self-managed AD directory. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SelfManagedActiveDirectoryAttributes AWS API Documentation # class SelfManagedActiveDirectoryAttributes < Struct.new( :domain_name, :organizational_unit_distinguished_name, :file_system_administrators_group, :user_name, :dns_ips) SENSITIVE = [] include Aws::Structure end # The configuration that Amazon FSx uses to join a FSx for Windows File # Server file system or an FSx for ONTAP storage virtual machine (SVM) # to a self-managed (including on-premises) Microsoft Active Directory # (AD) directory. For more information, see [ Using Amazon FSx for # Windows with your self-managed Microsoft Active Directory][1] or # [Managing FSx for ONTAP SVMs][2]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html # # @!attribute [rw] domain_name # The fully qualified domain name of the self-managed AD directory, # such as `corp.example.com`. # @return [String] # # @!attribute [rw] organizational_unit_distinguished_name # (Optional) The fully qualified distinguished name of the # organizational unit within your self-managed AD directory. 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][1]. 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. # # # # [1]: https://tools.ietf.org/html/rfc2253 # @return [String] # # @!attribute [rw] file_system_administrators_group # (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, setting # audit controls (audit ACLs) on files and folders, and administering # the file system remotely by using the FSx Remote PowerShell. 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. # @return [String] # # @!attribute [rw] user_name # 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. # @return [String] # # @!attribute [rw] password # The password for the service account on your self-managed AD domain # that Amazon FSx will use to join to your AD domain. # @return [String] # # @!attribute [rw] dns_ips # A list of up to three IP addresses of DNS servers or domain # controllers in the self-managed AD directory. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SelfManagedActiveDirectoryConfiguration AWS API Documentation # class SelfManagedActiveDirectoryConfiguration < Struct.new( :domain_name, :organizational_unit_distinguished_name, :file_system_administrators_group, :user_name, :password, :dns_ips) SENSITIVE = [:password] include Aws::Structure end # Specifies changes you are making to the self-managed Microsoft Active # Directory configuration to which an FSx for Windows File Server file # system or an FSx for ONTAP SVM is joined. # # @!attribute [rw] user_name # Specifies the updated user name for the service account on your # self-managed Active Directory domain. Amazon FSx uses this account # to join to your self-managed Active Directory domain. # # This account must have the permissions required to join computers to # the domain in the organizational unit provided in # `OrganizationalUnitDistinguishedName`. # @return [String] # # @!attribute [rw] password # Specifies the updated password for the service account on your # self-managed Active Directory domain. Amazon FSx uses this account # to join to your self-managed Active Directory domain. # @return [String] # # @!attribute [rw] dns_ips # A list of up to three DNS server or domain controller IP addresses # in your self-managed Active Directory domain. # @return [Array] # # @!attribute [rw] domain_name # Specifies an updated fully qualified domain name of your # self-managed Active Directory configuration. # @return [String] # # @!attribute [rw] organizational_unit_distinguished_name # Specifies an updated fully qualified distinguished name of the # organization unit within your self-managed Active Directory. # @return [String] # # @!attribute [rw] file_system_administrators_group # For FSx for ONTAP file systems only - Specifies the updated name of # the self-managed Active Directory domain group whose members are # granted administrative privileges for the Amazon FSx resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SelfManagedActiveDirectoryConfigurationUpdates AWS API Documentation # class SelfManagedActiveDirectoryConfigurationUpdates < Struct.new( :user_name, :password, :dns_ips, :domain_name, :organizational_unit_distinguished_name, :file_system_administrators_group) SENSITIVE = [:password] include Aws::Structure end # An error indicating that a particular service limit was exceeded. You # can increase some service limits by contacting Amazon Web Services # Support. # # @!attribute [rw] limit # Enumeration of the service limit that was exceeded. # @return [String] # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ServiceLimitExceeded AWS API Documentation # class ServiceLimitExceeded < Struct.new( :limit, :message) SENSITIVE = [] include Aws::Structure end # Specifies the SnapLock configuration for an FSx for ONTAP SnapLock # volume. # # @!attribute [rw] audit_log_volume # Enables or disables the audit log volume for an FSx for ONTAP # SnapLock volume. The default value is `false`. If you set # `AuditLogVolume` to `true`, the SnapLock volume is created as an # audit log volume. The minimum retention period for an audit log # volume is six months. # # For more information, see [ SnapLock audit log volumes][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume # @return [Boolean] # # @!attribute [rw] autocommit_period # The configuration object for setting the autocommit period of files # in an FSx for ONTAP SnapLock volume. # @return [Types::AutocommitPeriod] # # @!attribute [rw] privileged_delete # Enables, disables, or permanently disables privileged delete on an # FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete # allows SnapLock administrators to delete write once, read many # (WORM) files even if they have active retention periods. # `PERMANENTLY_DISABLED` is a terminal state. If privileged delete is # permanently disabled on a SnapLock volume, you can't re-enable it. # The default value is `DISABLED`. # # For more information, see [Privileged delete][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete # @return [String] # # @!attribute [rw] retention_period # Specifies the retention period of an FSx for ONTAP SnapLock volume. # @return [Types::SnaplockRetentionPeriod] # # @!attribute [rw] snaplock_type # Specifies the retention mode of an FSx for ONTAP SnapLock volume. # After it is set, it can't be changed. You can choose one of the # following retention modes: # # * `COMPLIANCE`: Files transitioned to write once, read many (WORM) # on a Compliance volume can't be deleted until their retention # periods expire. This retention mode is used to address government # or industry-specific mandates or to protect against ransomware # attacks. For more information, see [SnapLock Compliance][1]. # # * `ENTERPRISE`: Files transitioned to WORM on an Enterprise volume # can be deleted by authorized users before their retention periods # expire using privileged delete. This retention mode is used to # advance an organization's data integrity and internal compliance # or to test retention settings before using SnapLock Compliance. # For more information, see [SnapLock Enterprise][2]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html # @return [String] # # @!attribute [rw] volume_append_mode_enabled # Enables or disables volume-append mode on an FSx for ONTAP SnapLock # volume. Volume-append mode allows you to create WORM-appendable # files and write data to them incrementally. The default value is # `false`. # # For more information, see [Volume-append mode][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SnaplockConfiguration AWS API Documentation # class SnaplockConfiguration < Struct.new( :audit_log_volume, :autocommit_period, :privileged_delete, :retention_period, :snaplock_type, :volume_append_mode_enabled) SENSITIVE = [] include Aws::Structure end # The configuration to set the retention period of an FSx for ONTAP # SnapLock volume. The retention period includes default, maximum, and # minimum settings. For more information, see [Working with the # retention period in SnapLock][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html # # @!attribute [rw] default_retention # The retention period assigned to a write once, read many (WORM) file # by default if an explicit retention period is not set for an FSx for # ONTAP SnapLock volume. The default retention period must be greater # than or equal to the minimum retention period and less than or equal # to the maximum retention period. # @return [Types::RetentionPeriod] # # @!attribute [rw] minimum_retention # The shortest retention period that can be assigned to a WORM file on # an FSx for ONTAP SnapLock volume. # @return [Types::RetentionPeriod] # # @!attribute [rw] maximum_retention # The longest retention period that can be assigned to a WORM file on # an FSx for ONTAP SnapLock volume. # @return [Types::RetentionPeriod] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SnaplockRetentionPeriod AWS API Documentation # class SnaplockRetentionPeriod < Struct.new( :default_retention, :minimum_retention, :maximum_retention) SENSITIVE = [] include Aws::Structure end # A snapshot of an Amazon FSx for OpenZFS volume. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] snapshot_id # The ID of the snapshot. # @return [String] # # @!attribute [rw] name # The name of the snapshot. # @return [String] # # @!attribute [rw] volume_id # The ID of the volume that the snapshot is of. # @return [String] # # @!attribute [rw] creation_time # The time that the resource was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] lifecycle # The lifecycle status of the snapshot. # # * `PENDING` - Amazon FSx hasn't started creating the snapshot. # # * `CREATING` - Amazon FSx is creating the snapshot. # # * `DELETING` - Amazon FSx is deleting the snapshot. # # * `AVAILABLE` - The snapshot is fully available. # @return [String] # # @!attribute [rw] lifecycle_transition_reason # Describes why a resource lifecycle state changed. # @return [Types::LifecycleTransitionReason] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] administrative_actions # A list of administrative actions for the file system that are in # process or waiting to be processed. Administrative actions describe # changes to the Amazon FSx system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Snapshot AWS API Documentation # class Snapshot < Struct.new( :resource_arn, :snapshot_id, :name, :volume_id, :creation_time, :lifecycle, :lifecycle_transition_reason, :tags, :administrative_actions) SENSITIVE = [] include Aws::Structure end # A filter used to restrict the results of `DescribeSnapshots` calls. # You can use multiple filters to return results that meet all applied # filter requirements. # # @!attribute [rw] name # The name of the filter to use. You can filter by the # `file-system-id` or by `volume-id`. # @return [String] # # @!attribute [rw] values # The `file-system-id` or `volume-id` that you are filtering for. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SnapshotFilter AWS API Documentation # class SnapshotFilter < Struct.new( :name, :values) SENSITIVE = [] include Aws::Structure end # No Amazon FSx snapshots were found based on the supplied parameters. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SnapshotNotFound AWS API Documentation # class SnapshotNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The request was rejected because the lifecycle status of the source # backup isn't `AVAILABLE`. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @!attribute [rw] backup_id # The ID of the source backup. Specifies the backup that you are # copying. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SourceBackupUnavailable AWS API Documentation # class SourceBackupUnavailable < Struct.new( :message, :backup_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StartMisconfiguredStateRecoveryRequest AWS API Documentation # class StartMisconfiguredStateRecoveryRequest < Struct.new( :client_request_token, :file_system_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_system # A description of a specific Amazon FSx file system. # @return [Types::FileSystem] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StartMisconfiguredStateRecoveryResponse AWS API Documentation # class StartMisconfiguredStateRecoveryResponse < Struct.new( :file_system) SENSITIVE = [] include Aws::Structure end # Describes the Amazon FSx for NetApp ONTAP storage virtual machine # (SVM) configuration. # # @!attribute [rw] active_directory_configuration # Describes the Microsoft Active Directory configuration to which the # SVM is joined, if applicable. # @return [Types::SvmActiveDirectoryConfiguration] # # @!attribute [rw] creation_time # The time that the resource was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] endpoints # The endpoints that are used to access data or to manage the SVM # using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They # are the `Iscsi`, `Management`, `Nfs`, and `Smb` endpoints. # @return [Types::SvmEndpoints] # # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @!attribute [rw] lifecycle # Describes the SVM's lifecycle status. # # * `CREATED` - The SVM is fully available for use. # # * `CREATING` - Amazon FSx is creating the new SVM. # # * `DELETING` - Amazon FSx is deleting an existing SVM. # # * `FAILED` - Amazon FSx was unable to create the SVM. # # * `MISCONFIGURED` - The SVM is in a failed but recoverable state. # # * `PENDING` - Amazon FSx has not started creating the SVM. # @return [String] # # @!attribute [rw] name # The name of the SVM, if provisioned. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] storage_virtual_machine_id # The SVM's system generated unique ID. # @return [String] # # @!attribute [rw] subtype # Describes the SVM's subtype. # @return [String] # # @!attribute [rw] uuid # The SVM's UUID (universally unique identifier). # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] lifecycle_transition_reason # Describes why the SVM lifecycle state changed. # @return [Types::LifecycleTransitionReason] # # @!attribute [rw] root_volume_security_style # The security style of the root volume of the SVM. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachine AWS API Documentation # class StorageVirtualMachine < Struct.new( :active_directory_configuration, :creation_time, :endpoints, :file_system_id, :lifecycle, :name, :resource_arn, :storage_virtual_machine_id, :subtype, :uuid, :tags, :lifecycle_transition_reason, :root_volume_security_style) SENSITIVE = [] include Aws::Structure end # A filter used to restrict the results of describe calls for Amazon FSx # for NetApp ONTAP storage virtual machines (SVMs). You can use multiple # filters to return results that meet all applied filter requirements. # # @!attribute [rw] name # The name for this filter. # @return [String] # # @!attribute [rw] values # The values of the filter. These are all the values for any of the # applied filters. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachineFilter AWS API Documentation # class StorageVirtualMachineFilter < Struct.new( :name, :values) SENSITIVE = [] include Aws::Structure end # No FSx for ONTAP SVMs were found based upon the supplied parameters. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachineNotFound AWS API Documentation # class StorageVirtualMachineNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Describes the Microsoft Active Directory (AD) directory configuration # to which the FSx for ONTAP storage virtual machine (SVM) is joined. # Note that account credentials are not returned in the response # payload. # # @!attribute [rw] net_bios_name # The NetBIOS name of the AD computer object to which the SVM is # joined. # @return [String] # # @!attribute [rw] self_managed_active_directory_configuration # The configuration of the self-managed Microsoft Active Directory # (AD) directory to which the Windows File Server or ONTAP storage # virtual machine (SVM) instance is joined. # @return [Types::SelfManagedActiveDirectoryAttributes] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmActiveDirectoryConfiguration AWS API Documentation # class SvmActiveDirectoryConfiguration < Struct.new( :net_bios_name, :self_managed_active_directory_configuration) SENSITIVE = [] include Aws::Structure end # An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four # endpoints that are used to access data or to manage the SVM using the # NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the # `Iscsi`, `Management`, `Nfs`, and `Smb` endpoints. # # @!attribute [rw] dns_name # The file system's DNS name. You can mount your file system using # its DNS name. # @return [String] # # @!attribute [rw] ip_addresses # The SVM endpoint's IP addresses. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmEndpoint AWS API Documentation # class SvmEndpoint < Struct.new( :dns_name, :ip_addresses) SENSITIVE = [] include Aws::Structure end # An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the # following endpoints that are used to access data or to manage the SVM # using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. # # @!attribute [rw] iscsi # An endpoint for connecting using the Internet Small Computer Systems # Interface (iSCSI) protocol. # @return [Types::SvmEndpoint] # # @!attribute [rw] management # An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp # ONTAP API, or NetApp CloudManager. # @return [Types::SvmEndpoint] # # @!attribute [rw] nfs # An endpoint for connecting using the Network File System (NFS) # protocol. # @return [Types::SvmEndpoint] # # @!attribute [rw] smb # An endpoint for connecting using the Server Message Block (SMB) # protocol. # @return [Types::SvmEndpoint] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmEndpoints AWS API Documentation # class SvmEndpoints < Struct.new( :iscsi, :management, :nfs, :smb) SENSITIVE = [] include Aws::Structure end # Specifies a key-value pair for a resource tag. # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] 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`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Tag AWS API Documentation # class Tag < Struct.new( :key, :value) SENSITIVE = [] include Aws::Structure end # The request object for the `TagResource` operation. # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the Amazon FSx resource that you # want to tag. # @return [String] # # @!attribute [rw] tags # A list of tags for the resource. If a tag with a given key already # exists, the value is replaced by the one specified in this # parameter. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # The response object for the `TagResource` operation. # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceResponse AWS API Documentation # class TagResourceResponse < Aws::EmptyStructure; end # Describes the data tiering policy for an ONTAP volume. When enabled, # Amazon FSx for ONTAP's intelligent tiering automatically transitions # a volume's data between the file system's primary storage and # capacity pool storage based on your access patterns. # # Valid tiering policies are the following: # # * `SNAPSHOT_ONLY` - (Default value) moves cold snapshots to the # capacity pool storage tier. # # ^ # ^ # # * `AUTO` - moves cold user data and snapshots to the capacity pool # storage tier based on your access patterns. # # ^ # ^ # # * `ALL` - moves all user data blocks in both the active file system # and Snapshot copies to the storage pool tier. # # ^ # ^ # # * `NONE` - keeps a volume's data in the primary storage tier, # preventing it from being moved to the capacity pool tier. # # ^ # # @!attribute [rw] cooling_period # Specifies the number of days that user data in a volume must remain # inactive before it is considered "cold" and moved to the capacity # pool. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies. # Enter a whole number between 2 and 183. Default values are 31 days # for `AUTO` and 2 days for `SNAPSHOT_ONLY`. # @return [Integer] # # @!attribute [rw] name # Specifies the tiering policy used to transition data. Default value # is `SNAPSHOT_ONLY`. # # * `SNAPSHOT_ONLY` - moves cold snapshots to the capacity pool # storage tier. # # * `AUTO` - moves cold user data and snapshots to the capacity pool # storage tier based on your access patterns. # # * `ALL` - moves all user data blocks in both the active file system # and Snapshot copies to the storage pool tier. # # * `NONE` - keeps a volume's data in the primary storage tier, # preventing it from being moved to the capacity pool tier. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TieringPolicy AWS API Documentation # class TieringPolicy < Struct.new( :cooling_period, :name) SENSITIVE = [] include Aws::Structure end # The requested operation is not supported for this resource or API. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UnsupportedOperation AWS API Documentation # class UnsupportedOperation < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The request object for `UntagResource` action. # # @!attribute [rw] resource_arn # The ARN of the Amazon FSx resource to untag. # @return [String] # # @!attribute [rw] tag_keys # A list of keys of tags on the resource to untag. In case the tag key # doesn't exist, the call will still succeed to be idempotent. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # The response object for `UntagResource` action. # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResourceResponse AWS API Documentation # class UntagResourceResponse < Aws::EmptyStructure; end # @!attribute [rw] association_id # The ID of the data repository association that you are updating. # @return [String] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] imported_file_chunk_size # 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. # @return [Integer] # # @!attribute [rw] s3 # The configuration for an Amazon S3 data repository linked to an # Amazon FSx Lustre file system with a data repository association. # The configuration defines which file events (new, changed, or # deleted files or directories) are automatically imported from the # linked data repository to the file system or automatically exported # from the file system to the data repository. # @return [Types::S3DataRepositoryConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateDataRepositoryAssociationRequest AWS API Documentation # class UpdateDataRepositoryAssociationRequest < Struct.new( :association_id, :client_request_token, :imported_file_chunk_size, :s3) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] association # The response object returned after the data repository association # is updated. # @return [Types::DataRepositoryAssociation] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateDataRepositoryAssociationResponse AWS API Documentation # class UpdateDataRepositoryAssociationResponse < Struct.new( :association) SENSITIVE = [] include Aws::Structure end # The configuration update for an Amazon File Cache resource. # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileCacheLustreConfiguration AWS API Documentation # class UpdateFileCacheLustreConfiguration < Struct.new( :weekly_maintenance_start_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_cache_id # The ID of the cache that you are updating. # @return [String] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] lustre_configuration # The configuration updates for an Amazon File Cache resource. # @return [Types::UpdateFileCacheLustreConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileCacheRequest AWS API Documentation # class UpdateFileCacheRequest < Struct.new( :file_cache_id, :client_request_token, :lustre_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] file_cache # A description of the cache that was updated. # @return [Types::FileCache] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileCacheResponse AWS API Documentation # class UpdateFileCacheResponse < Struct.new( :file_cache) SENSITIVE = [] include Aws::Structure end # The configuration object for Amazon FSx for Lustre file systems used # in the `UpdateFileSystem` operation. # # @!attribute [rw] weekly_maintenance_start_time # (Optional) 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. # @return [String] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `0`. # @return [Integer] # # @!attribute [rw] auto_import_policy # (Optional) When you create your file system, your existing S3 # objects appear as file and directory listings. Use this property to # choose how Amazon FSx keeps your file and directory listing up to # date as you add or modify objects in your linked S3 bucket. # `AutoImportPolicy` can have the following values: # # * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file # and directory listings from the linked S3 bucket when the file # system is created. FSx does not update the file and directory # listing for any new or changed objects after choosing this option. # # * `NEW` - AutoImport is on. Amazon FSx automatically imports # directory listings of any new objects added to the linked S3 # bucket that do not currently exist in the FSx file system. # # * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports # file and directory listings of any new objects added to the S3 # bucket and any existing objects that are changed in the S3 bucket # after you choose this option. # # * `NEW_CHANGED_DELETED` - AutoImport is on. Amazon FSx automatically # imports file and directory listings of any new objects added to # the S3 bucket, any existing objects that are changed in the S3 # bucket, and any objects that were deleted in the S3 bucket. # # This parameter is not supported for file systems with a data # repository association. # @return [String] # # @!attribute [rw] data_compression_type # Sets the data compression configuration for the file system. # `DataCompressionType` can have the following values: # # * `NONE` - Data compression is turned off for the file system. # # * `LZ4` - Data compression is turned on with the LZ4 algorithm. # # If you don't use `DataCompressionType`, the file system retains its # current data compression configuration. # # For more information, see [Lustre data compression][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html # @return [String] # # @!attribute [rw] log_configuration # The Lustre logging configuration used when updating an Amazon FSx # for Lustre file system. When logging is enabled, Lustre logs error # and warning events for data repositories associated with your file # system to Amazon CloudWatch Logs. # @return [Types::LustreLogCreateConfiguration] # # @!attribute [rw] root_squash_configuration # The Lustre root squash configuration used when updating an Amazon # FSx for Lustre file system. When enabled, root squash restricts # root-level access from clients that try to access your file system # as a root user. # @return [Types::LustreRootSquashConfiguration] # # @!attribute [rw] per_unit_storage_throughput # The throughput of an Amazon FSx for Lustre Persistent SSD-based file # system, measured in megabytes per second per tebibyte (MB/s/TiB). # You can increase or decrease your file system's throughput. Valid # values depend on the deployment type of the file system, as follows: # # * For `PERSISTENT_1` SSD-based deployment types, valid values are # 50, 100, and 200 MB/s/TiB. # # * For `PERSISTENT_2` SSD-based deployment types, valid values are # 125, 250, 500, and 1000 MB/s/TiB. # # For more information, see [ Managing throughput capacity][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-throughput-capacity.html # @return [Integer] # # @!attribute [rw] metadata_configuration # The Lustre metadata performance configuration for an Amazon FSx for # Lustre file system using a `PERSISTENT_2` deployment type. When this # configuration is enabled, the file system supports increasing # metadata performance. # @return [Types::UpdateFileSystemLustreMetadataConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemLustreConfiguration AWS API Documentation # class UpdateFileSystemLustreConfiguration < Struct.new( :weekly_maintenance_start_time, :daily_automatic_backup_start_time, :automatic_backup_retention_days, :auto_import_policy, :data_compression_type, :log_configuration, :root_squash_configuration, :per_unit_storage_throughput, :metadata_configuration) SENSITIVE = [] include Aws::Structure end # The Lustre metadata performance configuration update for an Amazon FSx # for Lustre file system using a `PERSISTENT_2` deployment type. You can # request an increase in your file system's Metadata IOPS and/or switch # your file system's metadata configuration mode. For more information, # see [Managing metadata performance][1] in the *Amazon FSx for Lustre # User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-metadata-performance.html # # @!attribute [rw] iops # (USER\_PROVISIONED mode only) Specifies the number of Metadata IOPS # to provision for your file system. Valid values are `1500`, `3000`, # `6000`, `12000`, and multiples of `12000` up to a maximum of # `192000`. # # The value you provide must be greater than or equal to the current # number of Metadata IOPS provisioned for the file system. # @return [Integer] # # @!attribute [rw] mode # The metadata configuration mode for provisioning Metadata IOPS for # an FSx for Lustre file system using a `PERSISTENT_2` deployment # type. # # * To increase the Metadata IOPS or to switch from AUTOMATIC mode, # specify `USER_PROVISIONED` as the value for this parameter. Then # use the Iops parameter to provide a Metadata IOPS value that is # greater than or equal to the current number of Metadata IOPS # provisioned for the file system. # # * To switch from USER\_PROVISIONED mode, specify `AUTOMATIC` as the # value for this parameter, but do not input a value for Iops. # # If you request to switch from USER\_PROVISIONED to AUTOMATIC mode # and the current Metadata IOPS value is greater than the automated # default, FSx for Lustre rejects the request because downscaling # Metadata IOPS is not supported. # # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemLustreMetadataConfiguration AWS API Documentation # class UpdateFileSystemLustreMetadataConfiguration < Struct.new( :iops, :mode) SENSITIVE = [] include Aws::Structure end # The configuration updates for an Amazon FSx for NetApp ONTAP file # system. # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] fsx_admin_password # Update the password for the `fsxadmin` user by entering a new # password. You use the `fsxadmin` user to access the NetApp ONTAP CLI # and REST API to manage your file system resources. For more # information, see [Managing resources using NetApp Applicaton][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html # @return [String] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS (input output operations per second) configuration for # an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS # per GB of storage capacity, but you can provision additional IOPS # per GB of storage. The configuration consists of an IOPS mode # (`AUTOMATIC` or `USER_PROVISIONED`), and in the case of # `USER_PROVISIONED` IOPS, the total number of SSD IOPS provisioned. # For more information, see [Updating SSD storage capacity and # IOPS][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/increase-primary-storage.html # @return [Types::DiskIopsConfiguration] # # @!attribute [rw] throughput_capacity # Enter a new value to change the amount of throughput capacity for # the file system in megabytes per second (MBps). For more # information, see [Managing throughput capacity][1] in the FSx for # ONTAP User Guide. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The value of `ThroughputCapacity` and # `ThroughputCapacityPerHAPair` are not the same value. # # * The value of `ThroughputCapacity` when divided by the value of # `HAPairs` is outside of the valid range for `ThroughputCapacity`. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html # @return [Integer] # # @!attribute [rw] add_route_table_ids # (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) # route tables to associate (add) with your Amazon FSx for NetApp # ONTAP file system. # @return [Array] # # @!attribute [rw] remove_route_table_ids # (Multi-AZ only) A list of IDs of existing virtual private cloud # (VPC) route tables to disassociate (remove) from your Amazon FSx for # NetApp ONTAP file system. You can use the API operation to retrieve # the list of VPC route table IDs for a file system. # @return [Array] # # @!attribute [rw] throughput_capacity_per_ha_pair # Use to choose the throughput capacity per HA pair, rather than the # total throughput for the file system. # # This field and `ThroughputCapacity` cannot be defined in the same # API call, but one is required. # # This field and `ThroughputCapacity` are the same for file systems # with one HA pair. # # * For `SINGLE_AZ_1` and `MULTI_AZ_1` file systems, valid values are # 128, 256, 512, 1024, 2048, or 4096 MBps. # # * For `SINGLE_AZ_2`, valid values are 1536, 3072, or 6144 MBps. # # * For `MULTI_AZ_2`, valid values are 384, 768, 1536, 3072, or 6144 # MBps. # # Amazon FSx responds with an HTTP status code 400 (Bad Request) for # the following conditions: # # * The value of `ThroughputCapacity` and # `ThroughputCapacityPerHAPair` are not the same value for file # systems with one HA pair. # # * The value of deployment type is `SINGLE_AZ_2` and # `ThroughputCapacity` / `ThroughputCapacityPerHAPair` is not a # valid HA pair (a value between 1 and 12). # # * The value of `ThroughputCapacityPerHAPair` is not a valid value. # @return [Integer] # # @!attribute [rw] ha_pairs # Use to update the number of high-availability (HA) pairs for a # second-generation single-AZ file system. If you increase the number # of HA pairs for your file system, you must specify proportional # increases for `StorageCapacity`, `Iops`, and `ThroughputCapacity`. # For more information, see [High-availability (HA) pairs][1] in the # FSx for ONTAP user guide. Block storage protocol support (iSCSI and # NVMe over TCP) is disabled on file systems with more than 6 HA # pairs. For more information, see [Using block storage protocols][2]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemOntapConfiguration AWS API Documentation # class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end # The configuration updates for an Amazon FSx for OpenZFS file system. # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. # @return [Integer] # # @!attribute [rw] copy_tags_to_backups # A Boolean value 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. 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. # @return [Boolean] # # @!attribute [rw] copy_tags_to_volumes # A Boolean value indicating whether tags for the volume should be # copied to snapshots. This value defaults to `false`. If it's set to # `true`, all tags for the volume are copied to snapshots 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 snapshots. # If you specify one or more tags when creating the snapshot, no tags # are copied from the volume, regardless of this value. # @return [Boolean] # # @!attribute [rw] daily_automatic_backup_start_time # 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. # @return [String] # # @!attribute [rw] throughput_capacity # The throughput of an Amazon FSx for OpenZFS file system, measured in # megabytes per second
 (MB/s). Valid values depend on the # DeploymentType you choose, as follows: # # * For `MULTI_AZ_1` and `SINGLE_AZ_2`, valid values are 160, 320, # 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s. # # * For `SINGLE_AZ_1`, valid values are 64, 128, 256, 512, 1024, 2048, # 3072, or 4096 MB/s. # @return [Integer] # # @!attribute [rw] weekly_maintenance_start_time # A recurring weekly time, in the format `D:HH:MM`. # # `D` is the day of the week, for which 1 represents Monday and 7 # represents Sunday. For further details, see [the ISO-8601 spec as # described on Wikipedia][1]. # # `HH` is the zero-padded hour of the day (0-23), and `MM` is the # zero-padded minute of the hour. # # For example, `1:05:00` specifies maintenance at 5 AM Monday. # # # # [1]: https://en.wikipedia.org/wiki/ISO_week_date # @return [String] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS (input/output operations per second) configuration for # an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, # or FSx for OpenZFS file system. By default, Amazon FSx automatically # provisions 3 IOPS per GB of storage capacity. You can provision # additional IOPS per GB of storage. The configuration consists of the # total number of provisioned SSD IOPS and how it is was provisioned, # or the mode (by the customer or by Amazon FSx). # @return [Types::DiskIopsConfiguration] # # @!attribute [rw] add_route_table_ids # (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) # route tables to associate (add) with your Amazon FSx for OpenZFS # file system. # @return [Array] # # @!attribute [rw] remove_route_table_ids # (Multi-AZ only) A list of IDs of existing virtual private cloud # (VPC) route tables to disassociate (remove) from your Amazon FSx for # OpenZFS file system. You can use the API operation to retrieve the # list of VPC route table IDs for a file system. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemOpenZFSConfiguration AWS API Documentation # class UpdateFileSystemOpenZFSConfiguration < Struct.new( :automatic_backup_retention_days, :copy_tags_to_backups, :copy_tags_to_volumes, :daily_automatic_backup_start_time, :throughput_capacity, :weekly_maintenance_start_time, :disk_iops_configuration, :add_route_table_ids, :remove_route_table_ids) SENSITIVE = [] include Aws::Structure end # The request object for the `UpdateFileSystem` operation. # # @!attribute [rw] file_system_id # The ID of the file system that you are updating. # @return [String] # # @!attribute [rw] client_request_token # A string of up to 63 ASCII characters that Amazon FSx uses to ensure # idempotent updates. This string is automatically filled on your # behalf when you use the Command Line Interface (CLI) or an Amazon # Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] storage_capacity # Use this parameter to increase the storage capacity of an FSx for # Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for # ONTAP file system. Specifies the storage capacity target value, in # GiB, to increase the storage capacity for the file system that # you're updating. # # You can't make a storage capacity increase request if there is an # existing storage capacity increase request in progress. # # # # For Lustre file systems, the storage capacity target value can be # the following: # # * For `SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2 SSD` deployment # types, valid values are in multiples of 2400 GiB. The value must # be greater than the current storage capacity. # # * For `PERSISTENT HDD` file systems, valid values are multiples of # 6000 GiB for 12-MBps throughput per TiB file systems and multiples # of 1800 GiB for 40-MBps throughput per TiB file systems. The # values must be greater than the current storage capacity. # # * For `SCRATCH_1` file systems, you can't increase the storage # capacity. # # For more information, see [Managing storage and throughput # capacity][1] in the *FSx for Lustre User Guide*. # # For FSx for OpenZFS file systems, the storage capacity target value # must be at least 10 percent greater than the current storage # capacity value. For more information, see [Managing storage # capacity][2] in the *FSx for OpenZFS User Guide*. # # For Windows file systems, the storage capacity target value must be # at least 10 percent greater than the current storage capacity value. # To increase storage capacity, the file system must have at least 16 # MBps of throughput capacity. For more information, see [Managing # storage capacity][3] in the *Amazon FSxfor Windows File Server User # Guide*. # # For ONTAP file systems, the storage capacity target value must be at # least 10 percent greater than the current storage capacity value. # For more information, see [Managing storage capacity and provisioned # IOPS][4] in the *Amazon FSx for NetApp ONTAP User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html # [2]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html # [3]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html # [4]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html # @return [Integer] # # @!attribute [rw] windows_configuration # The configuration updates for an Amazon FSx for Windows File Server # file system. # @return [Types::UpdateFileSystemWindowsConfiguration] # # @!attribute [rw] lustre_configuration # The configuration object for Amazon FSx for Lustre file systems used # in the `UpdateFileSystem` operation. # @return [Types::UpdateFileSystemLustreConfiguration] # # @!attribute [rw] ontap_configuration # The configuration updates for an Amazon FSx for NetApp ONTAP file # system. # @return [Types::UpdateFileSystemOntapConfiguration] # # @!attribute [rw] open_zfs_configuration # The configuration updates for an FSx for OpenZFS file system. # @return [Types::UpdateFileSystemOpenZFSConfiguration] # # @!attribute [rw] storage_type # Specifies the file system's storage type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemRequest AWS API Documentation # class UpdateFileSystemRequest < Struct.new( :file_system_id, :client_request_token, :storage_capacity, :windows_configuration, :lustre_configuration, :ontap_configuration, :open_zfs_configuration, :storage_type) SENSITIVE = [] include Aws::Structure end # The response object for the `UpdateFileSystem` operation. # # @!attribute [rw] file_system # A description of the file system that was updated. # @return [Types::FileSystem] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemResponse AWS API Documentation # class UpdateFileSystemResponse < Struct.new( :file_system) SENSITIVE = [] include Aws::Structure end # Updates the configuration for an existing Amazon FSx for Windows File # Server file system. Amazon FSx only overwrites existing properties # with non-null values provided in the request. # # @!attribute [rw] weekly_maintenance_start_time # The preferred start time to perform weekly maintenance, formatted # d:HH:MM in the UTC time zone. Where d is the weekday number, from 1 # through 7, with 1 = Monday and 7 = Sunday. # @return [String] # # @!attribute [rw] daily_automatic_backup_start_time # The preferred time to start the daily automatic backup, in the UTC # time zone, for example, `02:00` # @return [String] # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this # property to `0` disables automatic backups. You can retain automatic # backups for a maximum of 90 days. The default is `30`. For more # information, see [Working with Automatic Daily Backups][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups # @return [Integer] # # @!attribute [rw] throughput_capacity # Sets the target value for a file system's throughput capacity, in # MB/s, that you are updating the file system to. Valid values are 8, # 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput # capacity update request if there is an existing throughput capacity # update request in progress. For more information, see [Managing # Throughput Capacity][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html # @return [Integer] # # @!attribute [rw] self_managed_active_directory_configuration # The configuration Amazon FSx uses to join the Windows File Server # instance to the self-managed Microsoft AD directory. You cannot make # a self-managed Microsoft AD update request if there is an existing # self-managed Microsoft AD update request in progress. # @return [Types::SelfManagedActiveDirectoryConfigurationUpdates] # # @!attribute [rw] audit_log_configuration # The configuration that Amazon FSx for Windows File Server uses to # audit and log user accesses of files, folders, and file shares on # the Amazon FSx for Windows File Server file system.. # @return [Types::WindowsAuditLogCreateConfiguration] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS (input/output operations per second) configuration for # an Amazon FSx for Windows file system. By default, Amazon FSx # automatically provisions 3 IOPS per GiB of storage capacity. You can # provision additional IOPS per GiB of storage, up to the maximum # limit associated with your chosen throughput capacity. # @return [Types::DiskIopsConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemWindowsConfiguration AWS API Documentation # class UpdateFileSystemWindowsConfiguration < Struct.new( :weekly_maintenance_start_time, :daily_automatic_backup_start_time, :automatic_backup_retention_days, :throughput_capacity, :self_managed_active_directory_configuration, :audit_log_configuration, :disk_iops_configuration) SENSITIVE = [] include Aws::Structure end # Used to specify changes to the ONTAP configuration for the volume you # are updating. # # @!attribute [rw] junction_path # Specifies the location in the SVM's namespace where the volume is # mounted. The `JunctionPath` must have a leading forward slash, such # as `/vol3`. # @return [String] # # @!attribute [rw] security_style # The security style for the volume, which can be `UNIX`, `NTFS`, or # `MIXED`. # @return [String] # # @!attribute [rw] size_in_megabytes # Specifies the size of the volume in megabytes. # @return [Integer] # # @!attribute [rw] storage_efficiency_enabled # Default is `false`. Set to true to enable the deduplication, # compression, and compaction storage efficiency features on the # volume. # @return [Boolean] # # @!attribute [rw] tiering_policy # Update the volume's data tiering policy. # @return [Types::TieringPolicy] # # @!attribute [rw] snapshot_policy # Specifies the snapshot policy for the volume. There are three # built-in snapshot policies: # # * `default`: This is the default policy. A maximum of six hourly # snapshots taken five minutes past the hour. A maximum of two daily # snapshots taken Monday through Saturday at 10 minutes after # midnight. A maximum of two weekly snapshots taken every Sunday at # 15 minutes after midnight. # # * `default-1weekly`: This policy is the same as the `default` policy # except that it only retains one snapshot from the weekly schedule. # # * `none`: This policy does not take any snapshots. This policy can # be assigned to volumes to prevent automatic snapshots from being # taken. # # You can also provide the name of a custom policy that you created # with the ONTAP CLI or REST API. # # For more information, see [Snapshot policies][1] in the *Amazon FSx # for NetApp ONTAP User Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies # @return [String] # # @!attribute [rw] copy_tags_to_backups # A boolean flag indicating whether tags for the volume should be # copied to backups. This value defaults to false. If it's set to # true, all tags for the volume 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. If you specify one or more tags when # creating a user-initiated backup, no tags are copied from the # volume, regardless of this value. # @return [Boolean] # # @!attribute [rw] snaplock_configuration # The configuration object for updating the SnapLock configuration of # an FSx for ONTAP SnapLock volume. # @return [Types::UpdateSnaplockConfiguration] # # @!attribute [rw] size_in_bytes # The configured size of the volume, in bytes. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateOntapVolumeConfiguration AWS API Documentation # class UpdateOntapVolumeConfiguration < Struct.new( :junction_path, :security_style, :size_in_megabytes, :storage_efficiency_enabled, :tiering_policy, :snapshot_policy, :copy_tags_to_backups, :snaplock_configuration, :size_in_bytes) SENSITIVE = [] include Aws::Structure end # Used to specify changes to the OpenZFS configuration for the volume # that you are updating. # # @!attribute [rw] storage_capacity_reservation_gi_b # The amount of storage in gibibytes (GiB) to reserve from the parent # volume. You can't reserve more storage than the parent volume has # reserved. You can specify a value of `-1` to unset a volume's # storage capacity reservation. # @return [Integer] # # @!attribute [rw] storage_capacity_quota_gi_b # The maximum amount of storage in gibibytes (GiB) that the volume can # use from its parent. You can specify a quota larger than the storage # on the parent volume. You can specify a value of `-1` to unset a # volume's storage capacity quota. # @return [Integer] # # @!attribute [rw] record_size_ki_b # Specifies the record size of an OpenZFS volume, in kibibytes (KiB). # Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The # default is 128 KiB. Most workloads should use the default record # size. Database workflows can benefit from a smaller record size, # while streaming workflows can benefit from a larger record size. For # additional guidance on when to set a custom record size, see [ Tips # for maximizing performance][1] in the *Amazon FSx for OpenZFS User # Guide*. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs # @return [Integer] # # @!attribute [rw] data_compression_type # Specifies the method used to compress the data on the volume. The # compression type is `NONE` by default. # # * `NONE` - Doesn't compress the data on the volume. `NONE` is the # default. # # * `ZSTD` - Compresses the data in the volume using the Zstandard # (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides # a better compression ratio to minimize on-disk storage # utilization. # # * `LZ4` - Compresses the data in the volume using the LZ4 # compression algorithm. Compared to Z-Standard, LZ4 is less # compute-intensive and delivers higher write throughput speeds. # @return [String] # # @!attribute [rw] nfs_exports # The configuration object for mounting a Network File System (NFS) # file system. # @return [Array] # # @!attribute [rw] user_and_group_quotas # An object specifying how much storage users or groups can use on the # volume. # @return [Array] # # @!attribute [rw] read_only # A Boolean value indicating whether the volume is read-only. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateOpenZFSVolumeConfiguration AWS API Documentation # class UpdateOpenZFSVolumeConfiguration < Struct.new( :storage_capacity_reservation_gi_b, :storage_capacity_quota_gi_b, :record_size_ki_b, :data_compression_type, :nfs_exports, :user_and_group_quotas, :read_only) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] enable_fsx_route_table_updates_from_participant_accounts # Specifies whether participant accounts can create FSx for ONTAP # Multi-AZ file systems in shared subnets. Set to `true` to enable or # `false` to disable. # @return [String] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSharedVpcConfigurationRequest AWS API Documentation # class UpdateSharedVpcConfigurationRequest < Struct.new( :enable_fsx_route_table_updates_from_participant_accounts, :client_request_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] enable_fsx_route_table_updates_from_participant_accounts # Indicates whether participant accounts can create FSx for ONTAP # Multi-AZ file systems in shared subnets. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSharedVpcConfigurationResponse AWS API Documentation # class UpdateSharedVpcConfigurationResponse < Struct.new( :enable_fsx_route_table_updates_from_participant_accounts) SENSITIVE = [] include Aws::Structure end # Updates the SnapLock configuration for an existing FSx for ONTAP # volume. # # @!attribute [rw] audit_log_volume # Enables or disables the audit log volume for an FSx for ONTAP # SnapLock volume. The default value is `false`. If you set # `AuditLogVolume` to `true`, the SnapLock volume is created as an # audit log volume. The minimum retention period for an audit log # volume is six months. # # For more information, see [ SnapLock audit log volumes][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume # @return [Boolean] # # @!attribute [rw] autocommit_period # The configuration object for setting the autocommit period of files # in an FSx for ONTAP SnapLock volume. # @return [Types::AutocommitPeriod] # # @!attribute [rw] privileged_delete # Enables, disables, or permanently disables privileged delete on an # FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete # allows SnapLock administrators to delete write once, read many # (WORM) files even if they have active retention periods. # `PERMANENTLY_DISABLED` is a terminal state. If privileged delete is # permanently disabled on a SnapLock volume, you can't re-enable it. # The default value is `DISABLED`. # # For more information, see [Privileged delete][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete # @return [String] # # @!attribute [rw] retention_period # Specifies the retention period of an FSx for ONTAP SnapLock volume. # @return [Types::SnaplockRetentionPeriod] # # @!attribute [rw] volume_append_mode_enabled # Enables or disables volume-append mode on an FSx for ONTAP SnapLock # volume. Volume-append mode allows you to create WORM-appendable # files and write data to them incrementally. The default value is # `false`. # # For more information, see [Volume-append mode][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSnaplockConfiguration AWS API Documentation # class UpdateSnaplockConfiguration < Struct.new( :audit_log_volume, :autocommit_period, :privileged_delete, :retention_period, :volume_append_mode_enabled) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] name # The name of the snapshot to update. # @return [String] # # @!attribute [rw] snapshot_id # The ID of the snapshot that you want to update, in the format # `fsvolsnap-0123456789abcdef0`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSnapshotRequest AWS API Documentation # class UpdateSnapshotRequest < Struct.new( :client_request_token, :name, :snapshot_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # Returned after a successful `UpdateSnapshot` operation, describing # the snapshot that you updated. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSnapshotResponse AWS API Documentation # class UpdateSnapshotResponse < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] active_directory_configuration # Specifies updates to an SVM's Microsoft Active Directory (AD) # configuration. # @return [Types::UpdateSvmActiveDirectoryConfiguration] # # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] storage_virtual_machine_id # The ID of the SVM that you want to update, in the format # `svm-0123456789abcdef0`. # @return [String] # # @!attribute [rw] svm_admin_password # Specifies a new SvmAdminPassword. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachineRequest AWS API Documentation # class UpdateStorageVirtualMachineRequest < Struct.new( :active_directory_configuration, :client_request_token, :storage_virtual_machine_id, :svm_admin_password) SENSITIVE = [:svm_admin_password] include Aws::Structure end # @!attribute [rw] storage_virtual_machine # Describes the Amazon FSx for NetApp ONTAP storage virtual machine # (SVM) configuration. # @return [Types::StorageVirtualMachine] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachineResponse AWS API Documentation # class UpdateStorageVirtualMachineResponse < Struct.new( :storage_virtual_machine) SENSITIVE = [] include Aws::Structure end # Specifies updates to an FSx for ONTAP storage virtual machine's (SVM) # Microsoft Active Directory (AD) configuration. Note that account # credentials are not returned in the response payload. # # @!attribute [rw] self_managed_active_directory_configuration # Specifies changes you are making to the self-managed Microsoft # Active Directory configuration to which an FSx for Windows File # Server file system or an FSx for ONTAP SVM is joined. # @return [Types::SelfManagedActiveDirectoryConfigurationUpdates] # # @!attribute [rw] net_bios_name # Specifies an updated NetBIOS name of the AD computer object # `NetBiosName` to which an SVM is joined. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSvmActiveDirectoryConfiguration AWS API Documentation # class UpdateSvmActiveDirectoryConfiguration < Struct.new( :self_managed_active_directory_configuration, :net_bios_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # (Optional) An idempotency token for resource creation, in a string # of up to 63 ASCII characters. This token is automatically filled on # your behalf when you use the Command Line Interface (CLI) or an # Amazon Web Services SDK. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] volume_id # The ID of the volume that you want to update, in the format # `fsvol-0123456789abcdef0`. # @return [String] # # @!attribute [rw] ontap_configuration # The configuration of the ONTAP volume that you are updating. # @return [Types::UpdateOntapVolumeConfiguration] # # @!attribute [rw] name # The name of the OpenZFS volume. OpenZFS root volumes are # automatically named `FSX`. Child volume names must be unique among # their parent volume's children. The name of the volume is part of # the mount string for the OpenZFS volume. # @return [String] # # @!attribute [rw] open_zfs_configuration # The configuration of the OpenZFS volume that you are updating. # @return [Types::UpdateOpenZFSVolumeConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolumeRequest AWS API Documentation # class UpdateVolumeRequest < Struct.new( :client_request_token, :volume_id, :ontap_configuration, :name, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] volume # A description of the volume just updated. Returned after a # successful `UpdateVolume` API operation. # @return [Types::Volume] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolumeResponse AWS API Documentation # class UpdateVolumeResponse < Struct.new( :volume) SENSITIVE = [] include Aws::Structure end # Describes an Amazon FSx volume. # # @!attribute [rw] creation_time # The time that the resource was created, in seconds (since # 1970-01-01T00:00:00Z), also known as Unix time. # @return [Time] # # @!attribute [rw] file_system_id # The globally unique ID of the file system, assigned by Amazon FSx. # @return [String] # # @!attribute [rw] lifecycle # The lifecycle status of the volume. # # * `AVAILABLE` - The volume is fully available for use. # # * `CREATED` - The volume has been created. # # * `CREATING` - Amazon FSx is creating the new volume. # # * `DELETING` - Amazon FSx is deleting an existing volume. # # * `FAILED` - Amazon FSx was unable to create the volume. # # * `MISCONFIGURED` - The volume is in a failed but recoverable state. # # * `PENDING` - Amazon FSx hasn't started creating the volume. # @return [String] # # @!attribute [rw] name # The name of the volume. # @return [String] # # @!attribute [rw] ontap_configuration # The configuration of an Amazon FSx for NetApp ONTAP volume. # @return [Types::OntapVolumeConfiguration] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely # identify Amazon Web Services resources. We require an ARN when you # need to specify a resource unambiguously across all of Amazon Web # Services. For more information, see [Amazon Resource Names # (ARNs)][1] in the *Amazon Web Services General Reference*. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # @return [String] # # @!attribute [rw] tags # A list of `Tag` values, with a maximum of 50 elements. # @return [Array] # # @!attribute [rw] volume_id # The system-generated, unique ID of the volume. # @return [String] # # @!attribute [rw] volume_type # The type of the volume. # @return [String] # # @!attribute [rw] lifecycle_transition_reason # The reason why the volume lifecycle status changed. # @return [Types::LifecycleTransitionReason] # # @!attribute [rw] administrative_actions # A list of administrative actions for the volume that are in process # or waiting to be processed. Administrative actions describe changes # to the volume that you have initiated using the `UpdateVolume` # action. # @return [Array] # # @!attribute [rw] open_zfs_configuration # The configuration of an Amazon FSx for OpenZFS volume. # @return [Types::OpenZFSVolumeConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Volume AWS API Documentation # class Volume < Struct.new( :creation_time, :file_system_id, :lifecycle, :name, :ontap_configuration, :resource_arn, :tags, :volume_id, :volume_type, :lifecycle_transition_reason, :administrative_actions, :open_zfs_configuration) SENSITIVE = [] include Aws::Structure end # A filter used to restrict the results of describe calls for Amazon FSx # for NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use # multiple filters to return results that meet all applied filter # requirements. # # @!attribute [rw] name # The name for this filter. # @return [String] # # @!attribute [rw] values # The values of the filter. These are all the values for any of the # applied filters. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/VolumeFilter AWS API Documentation # class VolumeFilter < Struct.new( :name, :values) SENSITIVE = [] include Aws::Structure end # No Amazon FSx volumes were found based upon the supplied parameters. # # @!attribute [rw] message # A detailed error message. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/VolumeNotFound AWS API Documentation # class VolumeNotFound < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The configuration that Amazon FSx for Windows File Server uses to # audit and log user accesses of files, folders, and file shares on the # Amazon FSx for Windows File Server file system. For more information, # see [ File access auditing][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/file-access-auditing.html # # @!attribute [rw] file_access_audit_log_level # Sets which attempt type is logged by Amazon FSx for file and folder # accesses. # # * `SUCCESS_ONLY` - only successful attempts to access files or # folders are logged. # # * `FAILURE_ONLY` - only failed attempts to access files or folders # are logged. # # * `SUCCESS_AND_FAILURE` - both successful attempts and failed # attempts to access files or folders are logged. # # * `DISABLED` - access auditing of files and folders is turned off. # @return [String] # # @!attribute [rw] file_share_access_audit_log_level # Sets which attempt type is logged by Amazon FSx for file share # accesses. # # * `SUCCESS_ONLY` - only successful attempts to access file shares # are logged. # # * `FAILURE_ONLY` - only failed attempts to access file shares are # logged. # # * `SUCCESS_AND_FAILURE` - both successful attempts and failed # attempts to access file shares are logged. # # * `DISABLED` - access auditing of file shares is turned off. # @return [String] # # @!attribute [rw] audit_log_destination # The Amazon Resource Name (ARN) for the destination of the audit # logs. The destination can be any Amazon CloudWatch Logs log group # ARN or Amazon Kinesis Data Firehose delivery stream ARN. # # The name of the Amazon CloudWatch Logs log group must begin with the # `/aws/fsx` prefix. The name of the Amazon Kinesis Data Firehose # delivery stream must begin with the `aws-fsx` prefix. # # The destination ARN (either CloudWatch Logs log group or Kinesis # Data Firehose delivery stream) must be in the same Amazon Web # Services partition, Amazon Web Services Region, and Amazon Web # Services account as your Amazon FSx file system. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsAuditLogConfiguration AWS API Documentation # class WindowsAuditLogConfiguration < Struct.new( :file_access_audit_log_level, :file_share_access_audit_log_level, :audit_log_destination) SENSITIVE = [] include Aws::Structure end # The Windows file access auditing configuration used when creating or # updating an Amazon FSx for Windows File Server file system. # # @!attribute [rw] file_access_audit_log_level # Sets which attempt type is logged by Amazon FSx for file and folder # accesses. # # * `SUCCESS_ONLY` - only successful attempts to access files or # folders are logged. # # * `FAILURE_ONLY` - only failed attempts to access files or folders # are logged. # # * `SUCCESS_AND_FAILURE` - both successful attempts and failed # attempts to access files or folders are logged. # # * `DISABLED` - access auditing of files and folders is turned off. # @return [String] # # @!attribute [rw] file_share_access_audit_log_level # Sets which attempt type is logged by Amazon FSx for file share # accesses. # # * `SUCCESS_ONLY` - only successful attempts to access file shares # are logged. # # * `FAILURE_ONLY` - only failed attempts to access file shares are # logged. # # * `SUCCESS_AND_FAILURE` - both successful attempts and failed # attempts to access file shares are logged. # # * `DISABLED` - access auditing of file shares is turned off. # @return [String] # # @!attribute [rw] audit_log_destination # The Amazon Resource Name (ARN) that specifies the destination of the # audit logs. # # The destination can be any Amazon CloudWatch Logs log group ARN or # Amazon Kinesis Data Firehose delivery stream ARN, with the following # requirements: # # * The destination ARN that you provide (either CloudWatch Logs log # group or Kinesis Data Firehose delivery stream) must be in the # same Amazon Web Services partition, Amazon Web Services Region, # and Amazon Web Services account as your Amazon FSx file system. # # * The name of the Amazon CloudWatch Logs log group must begin with # the `/aws/fsx` prefix. The name of the Amazon Kinesis Data # Firehose delivery stream must begin with the `aws-fsx` prefix. # # * If you do not provide a destination in `AuditLogDestination`, # Amazon FSx will create and use a log stream in the CloudWatch Logs # `/aws/fsx/windows` log group. # # * If `AuditLogDestination` is provided and the resource does not # exist, the request will fail with a `BadRequest` error. # # * If `FileAccessAuditLogLevel` and `FileShareAccessAuditLogLevel` # are both set to `DISABLED`, you cannot specify a destination in # `AuditLogDestination`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsAuditLogCreateConfiguration AWS API Documentation # class WindowsAuditLogCreateConfiguration < Struct.new( :file_access_audit_log_level, :file_share_access_audit_log_level, :audit_log_destination) SENSITIVE = [] include Aws::Structure end # The configuration for this Microsoft Windows file system. # # @!attribute [rw] active_directory_id # The ID for an existing Amazon Web Services Managed Microsoft Active # Directory instance that the file system is joined to. # @return [String] # # @!attribute [rw] self_managed_active_directory_configuration # The configuration of the self-managed Microsoft Active Directory # (AD) directory to which the Windows File Server or ONTAP storage # virtual machine (SVM) instance is joined. # @return [Types::SelfManagedActiveDirectoryAttributes] # # @!attribute [rw] deployment_type # 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][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html # @return [String] # # @!attribute [rw] remote_administration_endpoint # 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. # @return [String] # # @!attribute [rw] preferred_subnet_id # 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][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources # @return [String] # # @!attribute [rw] preferred_file_server_ip # 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][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html # @return [String] # # @!attribute [rw] throughput_capacity # The throughput of the Amazon FSx file system, measured in megabytes # per second. # @return [Integer] # # @!attribute [rw] maintenance_operations_in_progress # The list of maintenance operations in progress for this file system. # @return [Array] # # @!attribute [rw] weekly_maintenance_start_time # 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. # @return [String] # # @!attribute [rw] daily_automatic_backup_start_time # The preferred time to take daily automatic backups, in the UTC time # zone. # @return [String] # # @!attribute [rw] automatic_backup_retention_days # The number of days to retain automatic backups. Setting this to 0 # disables automatic backups. You can retain automatic backups for a # maximum of 90 days. # @return [Integer] # # @!attribute [rw] copy_tags_to_backups # 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. # @return [Boolean] # # @!attribute [rw] aliases # An array of one or more DNS aliases that are currently associated # with the Amazon FSx file system. Aliases allow you to use existing # DNS names to access the data in your Amazon FSx file system. You can # associate up to 50 aliases with a file system at any time. You can # associate additional DNS aliases after you create the file system # using the AssociateFileSystemAliases operation. You can remove DNS # aliases from the file system after it is created using the # DisassociateFileSystemAliases operation. You only need to specify # the alias name in the request payload. For more information, see # [DNS aliases][1]. # # # # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html # @return [Array] # # @!attribute [rw] audit_log_configuration # The configuration that Amazon FSx for Windows File Server uses to # audit and log user accesses of files, folders, and file shares on # the Amazon FSx for Windows File Server file system. # @return [Types::WindowsAuditLogConfiguration] # # @!attribute [rw] disk_iops_configuration # The SSD IOPS (input/output operations per second) configuration for # an Amazon FSx for Windows file system. By default, Amazon FSx # automatically provisions 3 IOPS per GiB of storage capacity. You can # provision additional IOPS per GiB of storage, up to the maximum # limit associated with your chosen throughput capacity. # @return [Types::DiskIopsConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsFileSystemConfiguration AWS API Documentation # class WindowsFileSystemConfiguration < Struct.new( :active_directory_id, :self_managed_active_directory_configuration, :deployment_type, :remote_administration_endpoint, :preferred_subnet_id, :preferred_file_server_ip, :throughput_capacity, :maintenance_operations_in_progress, :weekly_maintenance_start_time, :daily_automatic_backup_start_time, :automatic_backup_retention_days, :copy_tags_to_backups, :aliases, :audit_log_configuration, :disk_iops_configuration) SENSITIVE = [] include Aws::Structure end end end