Class: Aws::FSx::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::FSx::Client

Includes:

ClientStubs

Defined in:

gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb

Overview

An API client for FSx. To construct a client, you need to configure a :region and :credentials.

client = Aws::FSx::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations

• #associate_file_system_aliases(params = {}) ⇒ Types::AssociateFileSystemAliasesResponse

  Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system.

• #cancel_data_repository_task(params = {}) ⇒ Types::CancelDataRepositoryTaskResponse

  Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state.

• #copy_backup(params = {}) ⇒ Types::CopyBackupResponse

  Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy).

• #create_backup(params = {}) ⇒ Types::CreateBackupResponse

  Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

• #create_data_repository_association(params = {}) ⇒ Types::CreateDataRepositoryAssociationResponse

  Creates an Amazon FSx for Lustre data repository association (DRA).

• #create_data_repository_task(params = {}) ⇒ Types::CreateDataRepositoryTaskResponse

  Creates an Amazon FSx for Lustre data repository task.

• #create_file_system(params = {}) ⇒ Types::CreateFileSystemResponse

  Creates a new, empty Amazon FSx file system.

• #create_file_system_from_backup(params = {}) ⇒ Types::CreateFileSystemFromBackupResponse

  Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

• #create_snapshot(params = {}) ⇒ Types::CreateSnapshotResponse

  Creates a snapshot of an existing Amazon FSx for OpenZFS volume.

• #create_storage_virtual_machine(params = {}) ⇒ Types::CreateStorageVirtualMachineResponse

  Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

• #create_volume(params = {}) ⇒ Types::CreateVolumeResponse

  Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

• #create_volume_from_backup(params = {}) ⇒ Types::CreateVolumeFromBackupResponse

  Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.

• #delete_backup(params = {}) ⇒ Types::DeleteBackupResponse

  Deletes an Amazon FSx backup.

• #delete_data_repository_association(params = {}) ⇒ Types::DeleteDataRepositoryAssociationResponse

  Deletes a data repository association on an Amazon FSx for Lustre file system.

• #delete_file_system(params = {}) ⇒ Types::DeleteFileSystemResponse

  Deletes a file system.

• #delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResponse

  Deletes an Amazon FSx for OpenZFS snapshot.

• #delete_storage_virtual_machine(params = {}) ⇒ Types::DeleteStorageVirtualMachineResponse

  Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM).

• #delete_volume(params = {}) ⇒ Types::DeleteVolumeResponse

  Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

• #describe_backups(params = {}) ⇒ Types::DescribeBackupsResponse

  Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup.

• #describe_data_repository_associations(params = {}) ⇒ Types::DescribeDataRepositoryAssociationsResponse

  Returns the description of specific Amazon FSx for Lustre data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request.

• #describe_data_repository_tasks(params = {}) ⇒ Types::DescribeDataRepositoryTasksResponse

  Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request.

• #describe_file_system_aliases(params = {}) ⇒ Types::DescribeFileSystemAliasesResponse

  Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system.

• #describe_file_systems(params = {}) ⇒ Types::DescribeFileSystemsResponse

  Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system.

• #describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResponse

  Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided.

• #describe_storage_virtual_machines(params = {}) ⇒ Types::DescribeStorageVirtualMachinesResponse

  Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).

• #describe_volumes(params = {}) ⇒ Types::DescribeVolumesResponse

  Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.

• #disassociate_file_system_aliases(params = {}) ⇒ Types::DisassociateFileSystemAliasesResponse

  Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system.

• #list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

  Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

• #release_file_system_nfs_v3_locks(params = {}) ⇒ Types::ReleaseFileSystemNfsV3LocksResponse

  Releases the file system lock from an Amazon FSx for OpenZFS file system.

• #restore_volume_from_snapshot(params = {}) ⇒ Types::RestoreVolumeFromSnapshotResponse

  Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

• #tag_resource(params = {}) ⇒ Struct

  Tags an Amazon FSx resource.

• #untag_resource(params = {}) ⇒ Struct

  This action removes a tag from an Amazon FSx resource.

• #update_data_repository_association(params = {}) ⇒ Types::UpdateDataRepositoryAssociationResponse

  Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system.

• #update_file_system(params = {}) ⇒ Types::UpdateFileSystemResponse

  Use this operation to update the configuration of an existing Amazon FSx file system.

• #update_snapshot(params = {}) ⇒ Types::UpdateSnapshotResponse

  Updates the name of an Amazon FSx for OpenZFS snapshot.

• #update_storage_virtual_machine(params = {}) ⇒ Types::UpdateStorageVirtualMachineResponse

  Updates an Amazon FSx for ONTAP storage virtual machine (SVM).

• #update_volume(params = {}) ⇒ Types::UpdateVolumeResponse

  Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

Instance Method Summary

• #initialize(options) ⇒ Client constructor

  A new instance of Client.

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash)

Options Hash (options):

• :credentials (required, Aws::CredentialProvider) —

  Your AWS credentials. This can be an instance of any one of the following classes:

  • Aws::Credentials - Used for configuring static, non-refreshing credentials.

  • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

  • Aws::AssumeRoleCredentials - Used when you need to assume a role.

  • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

  • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

  • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

  • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

  • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

  • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

  When :credentials are not configured directly, the following locations will be searched for credentials:

  • Aws.config[:credentials]
  • The :access_key_id, :secret_access_key, and :session_token options.
  • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
  • ~/.aws/credentials
  • ~/.aws/config
  • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
• :region (required, String) —

  The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

  • Aws.config[:region]
  • ENV['AWS_REGION']
  • ENV['AMAZON_REGION']
  • ENV['AWS_DEFAULT_REGION']
  • ~/.aws/credentials
  • ~/.aws/config
• :access_key_id (String)
• :active_endpoint_cache (Boolean) — default: false —

  When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

• :adaptive_retry_wait_to_fill (Boolean) — default: true —

  Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

• :client_side_monitoring (Boolean) — default: false —

  When true, client-side metrics will be collected for all API requests from this client.

• :client_side_monitoring_client_id (String) — default: "" —

  Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

• :client_side_monitoring_host (String) — default: "127.0.0.1" —

  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_port (Integer) — default: 31000 —

  Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

• :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

  Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

• :convert_params (Boolean) — default: true —

  When true, an attempt is made to coerce request parameters into the required types.

• :correct_clock_skew (Boolean) — default: true —

  Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

• :defaults_mode (String) — default: "legacy" —

  See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

• :disable_host_prefix_injection (Boolean) — default: false —

  Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

• :endpoint (String) —

  The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

• :endpoint_cache_max_entries (Integer) — default: 1000 —

  Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

• :endpoint_cache_max_threads (Integer) — default: 10 —

  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

• :endpoint_cache_poll_interval (Integer) — default: 60 —

  When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

• :endpoint_discovery (Boolean) — default: false —

  When set to true, endpoint discovery will be enabled for operations when available.

• :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

  The log formatter.

• :log_level (Symbol) — default: :info —

  The log level to send messages to the :logger at.

• :logger (Logger) —

  The Logger instance to send log messages to. If this option is not set, logging will be disabled.

• :max_attempts (Integer) — default: 3 —

  An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

• :profile (String) — default: "default" —

  Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

• :retry_backoff (Proc) —

  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

• :retry_base_delay (Float) — default: 0.3 —

  The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

• :retry_jitter (Symbol) — default: :none —

  A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

  @see https://www.awsarchitectureblog.com/2015/03/backoff.html

• :retry_limit (Integer) — default: 3 —

  The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

• :retry_max_delay (Integer) — default: 0 —

  The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

• :retry_mode (String) — default: "legacy" —

  Specifies which retry algorithm to use. Values are:

  • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

  • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

  • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

• :secret_access_key (String)
• :session_token (String)
• :simple_json (Boolean) — default: false —

  Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

• :stub_responses (Boolean) — default: false —

  Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

  Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

• :use_dualstack_endpoint (Boolean) —

  When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

• :use_fips_endpoint (Boolean) —

  When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

• :validate_params (Boolean) — default: true —

  When true, request parameters are validated before sending the request.

• :http_proxy (URI::HTTP, String) —

  A proxy to send requests through. Formatted like 'http://proxy.com:123'.

• :http_open_timeout (Float) — default: 15 —

  The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

• :http_read_timeout (Float) — default: 60 —

  The default number of seconds to wait for response data. This value can safely be set per-request on the session.

• :http_idle_timeout (Float) — default: 5 —

  The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

• :http_continue_timeout (Float) — default: 1 —

  The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

• :ssl_timeout (Float) — default: nil —

  Sets the SSL timeout in seconds.

• :http_wire_trace (Boolean) — default: false —

  When true, HTTP debug output will be sent to the :logger.

• :ssl_verify_peer (Boolean) — default: true —

  When true, SSL peer certificates are verified when establishing a connection.

• :ssl_ca_bundle (String) —

  Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

• :ssl_ca_directory (String) —

  Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 358

def initialize(*args)
  super
end

Instance Method Details

#associate_file_system_aliases(params = {}) ⇒ Types::AssociateFileSystemAliasesResponse

Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

The system response shows 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.

Examples:

Request syntax with placeholder values

resp = client.associate_file_system_aliases({
  client_request_token: "ClientRequestToken",
  file_system_id: "FileSystemId", # required
  aliases: ["AlternateDNSName"], # required
})

Response structure

resp.aliases #=> Array
resp.aliases[0].name #=> String
resp.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_request_token (String) — default: Optional —

  An idempotency token for resource creation, in a string of up to 64 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.**

• :file_system_id (required, String) —

  Specifies the file system with which you want to associate one or more DNS aliases.

• :aliases (required, Array<String>) —

  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.

Returns:

• (Types::AssociateFileSystemAliasesResponse) —

  Returns a response object which responds to the following methods:

  • #aliases => Array<Types::Alias>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 439

def associate_file_system_aliases(params = {}, options = {})
  req = build_request(:associate_file_system_aliases, params)
  req.send_request(options)
end

#cancel_data_repository_task(params = {}) ⇒ Types::CancelDataRepositoryTaskResponse

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.

• Any files that FSx has already exported are not reverted.

• FSx continues to export any files that are "in-flight" when the cancel operation is received.

• FSx does not export any files that have not yet been exported.

Examples:

Request syntax with placeholder values

resp = client.cancel_data_repository_task({
  task_id: "TaskId", # required
})

Response structure

resp.lifecycle #=> String, one of "PENDING", "EXECUTING", "FAILED", "SUCCEEDED", "CANCELED", "CANCELING"
resp.task_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :task_id (required, String) —

  Specifies the data repository task to cancel.

Returns:

• (Types::CancelDataRepositoryTaskResponse) —

  Returns a response object which responds to the following methods:

  • #lifecycle => String
  • #task_id => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 478

def cancel_data_repository_task(params = {}, options = {})
  req = build_request(:cancel_data_repository_task, params)
  req.send_request(options)
end

#copy_backup(params = {}) ⇒ Types::CopyBackupResponse

Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.

You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

You can also use backup copies to clone your file dataset to another Region or within the same Region.

You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).

For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.

Examples:

Example: To copy a backup

# This operation copies an Amazon FSx backup.

resp = client.copy_backup({
  source_backup_id: "backup-03e3c82e0183b7b6b", 
  source_region: "us-east-2", 
})

resp.to_h outputs the following:
{
  backup: {
    backup_id: "backup-0a3364eded1014b28", 
    creation_time: Time.parse(1617954808.068), 
    file_system: {
      file_system_id: "fs-0498eed5fe91001ec", 
      file_system_type: "LUSTRE", 
      lustre_configuration: {
        automatic_backup_retention_days: 0, 
        deployment_type: "PERSISTENT_1", 
        per_unit_storage_throughput: 50, 
        weekly_maintenance_start_time: "1:05:00", 
      }, 
      resource_arn: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66", 
      storage_capacity: 2400, 
      storage_type: "SSD", 
    }, 
    kms_key_id: "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a", 
    lifecycle: "COPYING", 
    owner_id: "123456789012", 
    resource_arn: "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28", 
    tags: [
      {
        key: "Name", 
        value: "MyBackup", 
      }, 
    ], 
    type: "USER_INITIATED", 
  }, 
}

Request syntax with placeholder values

resp = client.copy_backup({
  client_request_token: "ClientRequestToken",
  source_backup_id: "SourceBackupId", # required
  source_region: "Region",
  kms_key_id: "KmsKeyId",
  copy_tags: false,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure

resp.backup.backup_id #=> String
resp.backup.lifecycle #=> String, one of "AVAILABLE", "CREATING", "TRANSFERRING", "DELETED", "FAILED", "PENDING", "COPYING"
resp.backup.failure_details.message #=> String
resp.backup.type #=> String, one of "AUTOMATIC", "USER_INITIATED", "AWS_BACKUP"
resp.backup.progress_percent #=> Integer
resp.backup.creation_time #=> Time
resp.backup.kms_key_id #=> String
resp.backup.resource_arn #=> String
resp.backup.tags #=> Array
resp.backup.tags[0].key #=> String
resp.backup.tags[0].value #=> String
resp.backup.file_system.owner_id #=> String
resp.backup.file_system.creation_time #=> Time
resp.backup.file_system.file_system_id #=> String
resp.backup.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.backup.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.backup.file_system.failure_details.message #=> String
resp.backup.file_system.storage_capacity #=> Integer
resp.backup.file_system.storage_type #=> String, one of "SSD", "HDD"
resp.backup.file_system.vpc_id #=> String
resp.backup.file_system.subnet_ids #=> Array
resp.backup.file_system.subnet_ids[0] #=> String
resp.backup.file_system.network_interface_ids #=> Array
resp.backup.file_system.network_interface_ids[0] #=> String
resp.backup.file_system.dns_name #=> String
resp.backup.file_system.kms_key_id #=> String
resp.backup.file_system.resource_arn #=> String
resp.backup.file_system.tags #=> Array
resp.backup.file_system.tags[0].key #=> String
resp.backup.file_system.tags[0].value #=> String
resp.backup.file_system.windows_configuration.active_directory_id #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.backup.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.backup.file_system.windows_configuration.remote_administration_endpoint #=> String
resp.backup.file_system.windows_configuration.preferred_subnet_id #=> String
resp.backup.file_system.windows_configuration.preferred_file_server_ip #=> String
resp.backup.file_system.windows_configuration.throughput_capacity #=> Integer
resp.backup.file_system.windows_configuration.maintenance_operations_in_progress #=> Array
resp.backup.file_system.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.backup.file_system.windows_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.windows_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.windows_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.windows_configuration.copy_tags_to_backups #=> Boolean
resp.backup.file_system.windows_configuration.aliases #=> Array
resp.backup.file_system.windows_configuration.aliases[0].name #=> String
resp.backup.file_system.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.backup.file_system.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.file_system.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.file_system.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.backup.file_system.lustre_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.backup.file_system.lustre_configuration.data_repository_configuration.import_path #=> String
resp.backup.file_system.lustre_configuration.data_repository_configuration.export_path #=> String
resp.backup.file_system.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.backup.file_system.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.backup.file_system.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.backup.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.backup.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.backup.file_system.lustre_configuration.mount_name #=> String
resp.backup.file_system.lustre_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.lustre_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.lustre_configuration.copy_tags_to_backups #=> Boolean
resp.backup.file_system.lustre_configuration.drive_cache_type #=> String, one of "NONE", "READ"
resp.backup.file_system.lustre_configuration.data_compression_type #=> String, one of "NONE", "LZ4"
resp.backup.file_system.lustre_configuration.log_configuration.level #=> String, one of "DISABLED", "WARN_ONLY", "ERROR_ONLY", "WARN_ERROR"
resp.backup.file_system.lustre_configuration.log_configuration.destination #=> String
resp.backup.file_system.lustre_configuration.root_squash_configuration.root_squash #=> String
resp.backup.file_system.lustre_configuration.root_squash_configuration.no_squash_nids #=> Array
resp.backup.file_system.lustre_configuration.root_squash_configuration.no_squash_nids[0] #=> String
resp.backup.file_system.administrative_actions #=> Array
resp.backup.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.backup.file_system.administrative_actions[0].progress_percent #=> Integer
resp.backup.file_system.administrative_actions[0].request_time #=> Time
resp.backup.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.backup.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
resp.backup.file_system.administrative_actions[0].failure_details.message #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
resp.backup.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.backup.file_system.administrative_actions[0].target_volume_values.name #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.backup.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.tags #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.parent_volume_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.volume_path #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_reservation_gi_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_quota_gi_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.record_size_ki_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.data_compression_type #=> String, one of "NONE", "ZSTD", "LZ4"
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.copy_tags_to_snapshots #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.snapshot_arn #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.copy_strategy #=> String, one of "CLONE", "FULL_COPY"
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.read_only #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].clients #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options[0] #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].type #=> String, one of "USER", "GROUP"
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].id #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].storage_capacity_quota_gi_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_snapshot_values.resource_arn #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.snapshot_id #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.name #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.volume_id #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.creation_time #=> Time
resp.backup.file_system.administrative_actions[0].target_snapshot_values.lifecycle #=> String, one of "PENDING", "CREATING", "DELETING", "AVAILABLE"
resp.backup.file_system.administrative_actions[0].target_snapshot_values.lifecycle_transition_reason.message #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.tags #=> Array
resp.backup.file_system.administrative_actions[0].target_snapshot_values.tags[0].key #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.tags[0].value #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
resp.backup.file_system.ontap_configuration.endpoint_ip_address_range #=> String
resp.backup.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
resp.backup.file_system.ontap_configuration.endpoints.management.dns_name #=> String
resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
resp.backup.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.file_system.ontap_configuration.preferred_subnet_id #=> String
resp.backup.file_system.ontap_configuration.route_table_ids #=> Array
resp.backup.file_system.ontap_configuration.route_table_ids[0] #=> String
resp.backup.file_system.ontap_configuration.throughput_capacity #=> Integer
resp.backup.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.file_system_type_version #=> String
resp.backup.file_system.open_zfs_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.open_zfs_configuration.copy_tags_to_backups #=> Boolean
resp.backup.file_system.open_zfs_configuration.copy_tags_to_volumes #=> Boolean
resp.backup.file_system.open_zfs_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.open_zfs_configuration.deployment_type #=> String, one of "SINGLE_AZ_1"
resp.backup.file_system.open_zfs_configuration.throughput_capacity #=> Integer
resp.backup.file_system.open_zfs_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.open_zfs_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.file_system.open_zfs_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.file_system.open_zfs_configuration.root_volume_id #=> String
resp.backup.directory_information.domain_name #=> String
resp.backup.directory_information.active_directory_id #=> String
resp.backup.directory_information.resource_arn #=> String
resp.backup.owner_id #=> String
resp.backup.source_backup_id #=> String
resp.backup.source_backup_region #=> String
resp.backup.resource_type #=> String, one of "FILE_SYSTEM", "VOLUME"
resp.backup.volume.creation_time #=> Time
resp.backup.volume.file_system_id #=> String
resp.backup.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.backup.volume.name #=> String
resp.backup.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.backup.volume.ontap_configuration.junction_path #=> String
resp.backup.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.backup.volume.ontap_configuration.size_in_megabytes #=> Integer
resp.backup.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.backup.volume.ontap_configuration.storage_virtual_machine_id #=> String
resp.backup.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.backup.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.backup.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.backup.volume.ontap_configuration.uuid #=> String
resp.backup.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.backup.volume.resource_arn #=> String
resp.backup.volume.tags #=> Array
resp.backup.volume.tags[0].key #=> String
resp.backup.volume.tags[0].value #=> String
resp.backup.volume.volume_id #=> String
resp.backup.volume.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.backup.volume.lifecycle_transition_reason.message #=> String
resp.backup.volume.administrative_actions #=> Array
resp.backup.volume.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.backup.volume.administrative_actions[0].progress_percent #=> Integer
resp.backup.volume.administrative_actions[0].request_time #=> Time
resp.backup.volume.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.backup.volume.administrative_actions[0].target_file_system_values.owner_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.creation_time #=> Time
resp.backup.volume.administrative_actions[0].target_file_system_values.file_system_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.backup.volume.administrative_actions[0].target_file_system_values.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.backup.volume.administrative_actions[0].target_file_system_values.failure_details.message #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.storage_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.storage_type #=> String, one of "SSD", "HDD"
resp.backup.volume.administrative_actions[0].target_file_system_values.vpc_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.subnet_ids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.subnet_ids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.network_interface_ids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.network_interface_ids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.dns_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.kms_key_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.resource_arn #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.tags #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.tags[0].key #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.tags[0].value #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.active_directory_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.remote_administration_endpoint #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.preferred_subnet_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.preferred_file_server_ip #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.throughput_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.copy_tags_to_backups #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.import_path #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.export_path #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.mount_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.copy_tags_to_backups #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.drive_cache_type #=> String, one of "NONE", "READ"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_compression_type #=> String, one of "NONE", "LZ4"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.log_configuration.level #=> String, one of "DISABLED", "WARN_ONLY", "ERROR_ONLY", "WARN_ERROR"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.log_configuration.destination #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.root_squash #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.no_squash_nids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.no_squash_nids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoint_ip_address_range #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.dns_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.dns_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.ip_addresses #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.preferred_subnet_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.route_table_ids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.route_table_ids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.throughput_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.file_system_type_version #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.copy_tags_to_backups #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.copy_tags_to_volumes #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.deployment_type #=> String, one of "SINGLE_AZ_1"
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.throughput_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.root_volume_id #=> String
resp.backup.volume.administrative_actions[0].failure_details.message #=> String
resp.backup.volume.administrative_actions[0].target_volume_values #=> Types::Volume
resp.backup.volume.administrative_actions[0].target_snapshot_values.resource_arn #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.snapshot_id #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.name #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.volume_id #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.creation_time #=> Time
resp.backup.volume.administrative_actions[0].target_snapshot_values.lifecycle #=> String, one of "PENDING", "CREATING", "DELETING", "AVAILABLE"
resp.backup.volume.administrative_actions[0].target_snapshot_values.lifecycle_transition_reason.message #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.tags #=> Array
resp.backup.volume.administrative_actions[0].target_snapshot_values.tags[0].key #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.tags[0].value #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.volume.open_zfs_configuration.parent_volume_id #=> String
resp.backup.volume.open_zfs_configuration.volume_path #=> String
resp.backup.volume.open_zfs_configuration.storage_capacity_reservation_gi_b #=> Integer
resp.backup.volume.open_zfs_configuration.storage_capacity_quota_gi_b #=> Integer
resp.backup.volume.open_zfs_configuration.record_size_ki_b #=> Integer
resp.backup.volume.open_zfs_configuration.data_compression_type #=> String, one of "NONE", "ZSTD", "LZ4"
resp.backup.volume.open_zfs_configuration.copy_tags_to_snapshots #=> Boolean
resp.backup.volume.open_zfs_configuration.origin_snapshot.snapshot_arn #=> String
resp.backup.volume.open_zfs_configuration.origin_snapshot.copy_strategy #=> String, one of "CLONE", "FULL_COPY"
resp.backup.volume.open_zfs_configuration.read_only #=> Boolean
resp.backup.volume.open_zfs_configuration.nfs_exports #=> Array
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations #=> Array
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations[0].clients #=> String
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations[0].options #=> Array
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations[0].options[0] #=> String
resp.backup.volume.open_zfs_configuration.user_and_group_quotas #=> Array
resp.backup.volume.open_zfs_configuration.user_and_group_quotas[0].type #=> String, one of "USER", "GROUP"
resp.backup.volume.open_zfs_configuration.user_and_group_quotas[0].id #=> Integer
resp.backup.volume.open_zfs_configuration.user_and_group_quotas[0].storage_capacity_quota_gi_b #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_request_token (String) — default: Optional —

  An idempotency token for resource creation, in a string of up to 64 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.**

• :source_backup_id (required, String) —

  The ID of the source backup. Specifies the ID of the backup that's being copied.

• :source_region (String) —

  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).

• :kms_key_id (String) —

  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 in the Key Management Service API Reference.

• :copy_tags (Boolean) —

  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.

• :tags (Array<Types::Tag>) —

  A list of Tag values, with a maximum of 50 elements.

Returns:

• (Types::CopyBackupResponse) —

  Returns a response object which responds to the following methods:

  • #backup => Types::Backup

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 968

def copy_backup(params = {}, options = {})
  req = build_request(:copy_backup, params)
  req.send_request(options)
end

#create_backup(params = {}) ⇒ Types::CreateBackupResponse

Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

• A Persistent deployment type

• Are not linked to a data repository

For more information about backups, see the following:

• For Amazon FSx for Lustre, see Working with FSx for Lustre backups.

• For Amazon FSx for Windows, see Working with FSx for Windows backups.

• For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.

• For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups.

If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

• Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Examples:

Example: To create a new backup

# This operation creates a new backup.

resp = client.create_backup({
  file_system_id: "fs-0498eed5fe91001ec", 
  tags: [
    {
      key: "Name", 
      value: "MyBackup", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  backup: {
    backup_id: "backup-03e3c82e0183b7b6b", 
    creation_time: Time.parse("1481841524.0"), 
    file_system: {
      file_system_id: "fs-0498eed5fe91001ec", 
      owner_id: "012345678912", 
      storage_capacity: 300, 
      windows_configuration: {
        active_directory_id: "d-1234abcd12", 
        automatic_backup_retention_days: 30, 
        daily_automatic_backup_start_time: "05:00", 
        weekly_maintenance_start_time: "1:05:00", 
      }, 
    }, 
    lifecycle: "CREATING", 
    progress_percent: 0, 
    resource_arn: "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b", 
    tags: [
      {
        key: "Name", 
        value: "MyBackup", 
      }, 
    ], 
    type: "USER_INITIATED", 
  }, 
}

Request syntax with placeholder values

resp = client.create_backup({
  file_system_id: "FileSystemId",
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  volume_id: "VolumeId",
})

Response structure

resp.backup.backup_id #=> String
resp.backup.lifecycle #=> String, one of "AVAILABLE", "CREATING", "TRANSFERRING", "DELETED", "FAILED", "PENDING", "COPYING"
resp.backup.failure_details.message #=> String
resp.backup.type #=> String, one of "AUTOMATIC", "USER_INITIATED", "AWS_BACKUP"
resp.backup.progress_percent #=> Integer
resp.backup.creation_time #=> Time
resp.backup.kms_key_id #=> String
resp.backup.resource_arn #=> String
resp.backup.tags #=> Array
resp.backup.tags[0].key #=> String
resp.backup.tags[0].value #=> String
resp.backup.file_system.owner_id #=> String
resp.backup.file_system.creation_time #=> Time
resp.backup.file_system.file_system_id #=> String
resp.backup.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.backup.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.backup.file_system.failure_details.message #=> String
resp.backup.file_system.storage_capacity #=> Integer
resp.backup.file_system.storage_type #=> String, one of "SSD", "HDD"
resp.backup.file_system.vpc_id #=> String
resp.backup.file_system.subnet_ids #=> Array
resp.backup.file_system.subnet_ids[0] #=> String
resp.backup.file_system.network_interface_ids #=> Array
resp.backup.file_system.network_interface_ids[0] #=> String
resp.backup.file_system.dns_name #=> String
resp.backup.file_system.kms_key_id #=> String
resp.backup.file_system.resource_arn #=> String
resp.backup.file_system.tags #=> Array
resp.backup.file_system.tags[0].key #=> String
resp.backup.file_system.tags[0].value #=> String
resp.backup.file_system.windows_configuration.active_directory_id #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.backup.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.backup.file_system.windows_configuration.remote_administration_endpoint #=> String
resp.backup.file_system.windows_configuration.preferred_subnet_id #=> String
resp.backup.file_system.windows_configuration.preferred_file_server_ip #=> String
resp.backup.file_system.windows_configuration.throughput_capacity #=> Integer
resp.backup.file_system.windows_configuration.maintenance_operations_in_progress #=> Array
resp.backup.file_system.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.backup.file_system.windows_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.windows_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.windows_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.windows_configuration.copy_tags_to_backups #=> Boolean
resp.backup.file_system.windows_configuration.aliases #=> Array
resp.backup.file_system.windows_configuration.aliases[0].name #=> String
resp.backup.file_system.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.backup.file_system.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.file_system.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.file_system.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.backup.file_system.lustre_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.backup.file_system.lustre_configuration.data_repository_configuration.import_path #=> String
resp.backup.file_system.lustre_configuration.data_repository_configuration.export_path #=> String
resp.backup.file_system.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.backup.file_system.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.backup.file_system.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.backup.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.backup.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.backup.file_system.lustre_configuration.mount_name #=> String
resp.backup.file_system.lustre_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.lustre_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.lustre_configuration.copy_tags_to_backups #=> Boolean
resp.backup.file_system.lustre_configuration.drive_cache_type #=> String, one of "NONE", "READ"
resp.backup.file_system.lustre_configuration.data_compression_type #=> String, one of "NONE", "LZ4"
resp.backup.file_system.lustre_configuration.log_configuration.level #=> String, one of "DISABLED", "WARN_ONLY", "ERROR_ONLY", "WARN_ERROR"
resp.backup.file_system.lustre_configuration.log_configuration.destination #=> String
resp.backup.file_system.lustre_configuration.root_squash_configuration.root_squash #=> String
resp.backup.file_system.lustre_configuration.root_squash_configuration.no_squash_nids #=> Array
resp.backup.file_system.lustre_configuration.root_squash_configuration.no_squash_nids[0] #=> String
resp.backup.file_system.administrative_actions #=> Array
resp.backup.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.backup.file_system.administrative_actions[0].progress_percent #=> Integer
resp.backup.file_system.administrative_actions[0].request_time #=> Time
resp.backup.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.backup.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
resp.backup.file_system.administrative_actions[0].failure_details.message #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
resp.backup.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.backup.file_system.administrative_actions[0].target_volume_values.name #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.backup.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.tags #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.parent_volume_id #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.volume_path #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_reservation_gi_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_quota_gi_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.record_size_ki_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.data_compression_type #=> String, one of "NONE", "ZSTD", "LZ4"
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.copy_tags_to_snapshots #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.snapshot_arn #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.copy_strategy #=> String, one of "CLONE", "FULL_COPY"
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.read_only #=> Boolean
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].clients #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options[0] #=> String
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas #=> Array
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].type #=> String, one of "USER", "GROUP"
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].id #=> Integer
resp.backup.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].storage_capacity_quota_gi_b #=> Integer
resp.backup.file_system.administrative_actions[0].target_snapshot_values.resource_arn #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.snapshot_id #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.name #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.volume_id #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.creation_time #=> Time
resp.backup.file_system.administrative_actions[0].target_snapshot_values.lifecycle #=> String, one of "PENDING", "CREATING", "DELETING", "AVAILABLE"
resp.backup.file_system.administrative_actions[0].target_snapshot_values.lifecycle_transition_reason.message #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.tags #=> Array
resp.backup.file_system.administrative_actions[0].target_snapshot_values.tags[0].key #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.tags[0].value #=> String
resp.backup.file_system.administrative_actions[0].target_snapshot_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
resp.backup.file_system.ontap_configuration.endpoint_ip_address_range #=> String
resp.backup.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
resp.backup.file_system.ontap_configuration.endpoints.management.dns_name #=> String
resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
resp.backup.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.file_system.ontap_configuration.preferred_subnet_id #=> String
resp.backup.file_system.ontap_configuration.route_table_ids #=> Array
resp.backup.file_system.ontap_configuration.route_table_ids[0] #=> String
resp.backup.file_system.ontap_configuration.throughput_capacity #=> Integer
resp.backup.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.file_system_type_version #=> String
resp.backup.file_system.open_zfs_configuration.automatic_backup_retention_days #=> Integer
resp.backup.file_system.open_zfs_configuration.copy_tags_to_backups #=> Boolean
resp.backup.file_system.open_zfs_configuration.copy_tags_to_volumes #=> Boolean
resp.backup.file_system.open_zfs_configuration.daily_automatic_backup_start_time #=> String
resp.backup.file_system.open_zfs_configuration.deployment_type #=> String, one of "SINGLE_AZ_1"
resp.backup.file_system.open_zfs_configuration.throughput_capacity #=> Integer
resp.backup.file_system.open_zfs_configuration.weekly_maintenance_start_time #=> String
resp.backup.file_system.open_zfs_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.file_system.open_zfs_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.file_system.open_zfs_configuration.root_volume_id #=> String
resp.backup.directory_information.domain_name #=> String
resp.backup.directory_information.active_directory_id #=> String
resp.backup.directory_information.resource_arn #=> String
resp.backup.owner_id #=> String
resp.backup.source_backup_id #=> String
resp.backup.source_backup_region #=> String
resp.backup.resource_type #=> String, one of "FILE_SYSTEM", "VOLUME"
resp.backup.volume.creation_time #=> Time
resp.backup.volume.file_system_id #=> String
resp.backup.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.backup.volume.name #=> String
resp.backup.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.backup.volume.ontap_configuration.junction_path #=> String
resp.backup.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.backup.volume.ontap_configuration.size_in_megabytes #=> Integer
resp.backup.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.backup.volume.ontap_configuration.storage_virtual_machine_id #=> String
resp.backup.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.backup.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.backup.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.backup.volume.ontap_configuration.uuid #=> String
resp.backup.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.backup.volume.resource_arn #=> String
resp.backup.volume.tags #=> Array
resp.backup.volume.tags[0].key #=> String
resp.backup.volume.tags[0].value #=> String
resp.backup.volume.volume_id #=> String
resp.backup.volume.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.backup.volume.lifecycle_transition_reason.message #=> String
resp.backup.volume.administrative_actions #=> Array
resp.backup.volume.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.backup.volume.administrative_actions[0].progress_percent #=> Integer
resp.backup.volume.administrative_actions[0].request_time #=> Time
resp.backup.volume.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.backup.volume.administrative_actions[0].target_file_system_values.owner_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.creation_time #=> Time
resp.backup.volume.administrative_actions[0].target_file_system_values.file_system_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.backup.volume.administrative_actions[0].target_file_system_values.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.backup.volume.administrative_actions[0].target_file_system_values.failure_details.message #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.storage_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.storage_type #=> String, one of "SSD", "HDD"
resp.backup.volume.administrative_actions[0].target_file_system_values.vpc_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.subnet_ids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.subnet_ids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.network_interface_ids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.network_interface_ids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.dns_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.kms_key_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.resource_arn #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.tags #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.tags[0].key #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.tags[0].value #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.active_directory_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.remote_administration_endpoint #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.preferred_subnet_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.preferred_file_server_ip #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.throughput_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.copy_tags_to_backups #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.backup.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.import_path #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.export_path #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.mount_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.copy_tags_to_backups #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.drive_cache_type #=> String, one of "NONE", "READ"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_compression_type #=> String, one of "NONE", "LZ4"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.log_configuration.level #=> String, one of "DISABLED", "WARN_ONLY", "ERROR_ONLY", "WARN_ERROR"
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.log_configuration.destination #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.root_squash #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.no_squash_nids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.no_squash_nids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoint_ip_address_range #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.dns_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.dns_name #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.ip_addresses #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.preferred_subnet_id #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.route_table_ids #=> Array
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.route_table_ids[0] #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.throughput_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.ontap_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.file_system_type_version #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.automatic_backup_retention_days #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.copy_tags_to_backups #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.copy_tags_to_volumes #=> Boolean
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.daily_automatic_backup_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.deployment_type #=> String, one of "SINGLE_AZ_1"
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.throughput_capacity #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.weekly_maintenance_start_time #=> String
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.disk_iops_configuration.iops #=> Integer
resp.backup.volume.administrative_actions[0].target_file_system_values.open_zfs_configuration.root_volume_id #=> String
resp.backup.volume.administrative_actions[0].failure_details.message #=> String
resp.backup.volume.administrative_actions[0].target_volume_values #=> Types::Volume
resp.backup.volume.administrative_actions[0].target_snapshot_values.resource_arn #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.snapshot_id #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.name #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.volume_id #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.creation_time #=> Time
resp.backup.volume.administrative_actions[0].target_snapshot_values.lifecycle #=> String, one of "PENDING", "CREATING", "DELETING", "AVAILABLE"
resp.backup.volume.administrative_actions[0].target_snapshot_values.lifecycle_transition_reason.message #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.tags #=> Array
resp.backup.volume.administrative_actions[0].target_snapshot_values.tags[0].key #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.tags[0].value #=> String
resp.backup.volume.administrative_actions[0].target_snapshot_values.administrative_actions #=> Types::AdministrativeActions
resp.backup.volume.open_zfs_configuration.parent_volume_id #=> String
resp.backup.volume.open_zfs_configuration.volume_path #=> String
resp.backup.volume.open_zfs_configuration.storage_capacity_reservation_gi_b #=> Integer
resp.backup.volume.open_zfs_configuration.storage_capacity_quota_gi_b #=> Integer
resp.backup.volume.open_zfs_configuration.record_size_ki_b #=> Integer
resp.backup.volume.open_zfs_configuration.data_compression_type #=> String, one of "NONE", "ZSTD", "LZ4"
resp.backup.volume.open_zfs_configuration.copy_tags_to_snapshots #=> Boolean
resp.backup.volume.open_zfs_configuration.origin_snapshot.snapshot_arn #=> String
resp.backup.volume.open_zfs_configuration.origin_snapshot.copy_strategy #=> String, one of "CLONE", "FULL_COPY"
resp.backup.volume.open_zfs_configuration.read_only #=> Boolean
resp.backup.volume.open_zfs_configuration.nfs_exports #=> Array
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations #=> Array
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations[0].clients #=> String
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations[0].options #=> Array
resp.backup.volume.open_zfs_configuration.nfs_exports[0].client_configurations[0].options[0] #=> String
resp.backup.volume.open_zfs_configuration.user_and_group_quotas #=> Array
resp.backup.volume.open_zfs_configuration.user_and_group_quotas[0].type #=> String, one of "USER", "GROUP"
resp.backup.volume.open_zfs_configuration.user_and_group_quotas[0].id #=> Integer
resp.backup.volume.open_zfs_configuration.user_and_group_quotas[0].storage_capacity_quota_gi_b #=> Integer

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :file_system_id (String) —

  The ID of the file system to back up.

• :client_request_token (String) — default: Optional —

  A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the 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.**

• :tags (Array<Types::Tag>) — default: 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.

• :volume_id (String) — default: Optional —

  The ID of the FSx for ONTAP volume to back up.

Returns:

• (Types::CreateBackupResponse) —

  Returns a response object which responds to the following methods:

  • #backup => Types::Backup

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1444

def create_backup(params = {}, options = {})
  req = build_request(:create_backup, params)
  req.send_request(options)
end

#create_data_repository_association(params = {}) ⇒ Types::CreateDataRepositoryAssociationResponse

Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported only for file systems with the Persistent_2 deployment type.

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

Examples:

Request syntax with placeholder values

resp = client.create_data_repository_association({
  file_system_id: "FileSystemId", # required
  file_system_path: "Namespace", # required
  data_repository_path: "ArchivePath", # required
  batch_import_meta_data_on_create: false,
  imported_file_chunk_size: 1,
  s3: {
    auto_import_policy: {
      events: ["NEW"], # accepts NEW, CHANGED, DELETED
    },
    auto_export_policy: {
      events: ["NEW"], # accepts NEW, CHANGED, DELETED
    },
  },
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure

resp.association.association_id #=> String
resp.association.resource_arn #=> String
resp.association.file_system_id #=> String
resp.association.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.association.failure_details.message #=> String
resp.association.file_system_path #=> String
resp.association.data_repository_path #=> String
resp.association.batch_import_meta_data_on_create #=> Boolean
resp.association.imported_file_chunk_size #=> Integer
resp.association.s3.auto_import_policy.events #=> Array
resp.association.s3.auto_import_policy.events[0] #=> String, one of "NEW", "CHANGED", "DELETED"
resp.association.s3.auto_export_policy.events #=> Array
resp.association.s3.auto_export_policy.events[0] #=> String, one of "NEW", "CHANGED", "DELETED"
resp.association.tags #=> Array
resp.association.tags[0].key #=> String
resp.association.tags[0].value #=> String
resp.association.creation_time #=> Time

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :file_system_id (required, String) —

  The globally unique ID of the file system, assigned by Amazon FSx.

• :file_system_path (required, String) —

  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 1 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.

• :data_repository_path (required, String) —

  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://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

• :batch_import_meta_data_on_create (Boolean) —

  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.

• :imported_file_chunk_size (Integer) —

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

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

• :s3 (Types::S3DataRepositoryConfiguration) —

  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.

• :client_request_token (String) — default: Optional —

  An idempotency token for resource creation, in a string of up to 64 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.**

• :tags (Array<Types::Tag>) —

  A list of Tag values, with a maximum of 50 elements.

Returns:

• (Types::CreateDataRepositoryAssociationResponse) —

  Returns a response object which responds to the following methods:

  • #association => Types::DataRepositoryAssociation

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1585

def create_data_repository_association(params = {}, options = {})
  req = build_request(:create_data_repository_association, params)
  req.send_request(options)
end

#create_data_repository_task(params = {}) ⇒ Types::CreateDataRepositoryTaskResponse

Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

Examples:

Request syntax with placeholder values

resp = client.create_data_repository_task({
  type: "EXPORT_TO_REPOSITORY", # required, accepts EXPORT_TO_REPOSITORY, IMPORT_METADATA_FROM_REPOSITORY
  paths: ["DataRepositoryTaskPath"],
  file_system_id: "FileSystemId", # required
  report: { # required
    enabled: false, # required
    path: "ArchivePath",
    format: "REPORT_CSV_20191124", # accepts REPORT_CSV_20191124
    scope: "FAILED_FILES_ONLY", # accepts FAILED_FILES_ONLY
  },
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure

resp.data_repository_task.task_id #=> String
resp.data_repository_task.lifecycle #=> String, one of "PENDING", "EXECUTING", "FAILED", "SUCCEEDED", "CANCELED", "CANCELING"
resp.data_repository_task.type #=> String, one of "EXPORT_TO_REPOSITORY", "IMPORT_METADATA_FROM_REPOSITORY"
resp.data_repository_task.creation_time #=> Time
resp.data_repository_task.start_time #=> Time
resp.data_repository_task.end_time #=> Time
resp.data_repository_task.resource_arn #=> String
resp.data_repository_task.tags #=> Array
resp.data_repository_task.tags[0].key #=> String
resp.data_repository_task.tags[0].value #=> String
resp.data_repository_task.file_system_id #=> String
resp.data_repository_task.paths #=> Array
resp.data_repository_task.paths[0] #=> String
resp.data_repository_task.failure_details.message #=> String
resp.data_repository_task.status.total_count #=> Integer
resp.data_repository_task.status.succeeded_count #=> Integer
resp.data_repository_task.status.failed_count #=> Integer
resp.data_repository_task.status.last_updated_time #=> Time
resp.data_repository_task.report.enabled #=> Boolean
resp.data_repository_task.report.path #=> String
resp.data_repository_task.report.format #=> String, one of "REPORT_CSV_20191124"
resp.data_repository_task.report.scope #=> String, one of "FAILED_FILES_ONLY"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :type (required, String) —

  Specifies the type of data repository task to create.

• :paths (Array<String>) — default: Optional —

  The path or paths on the Amazon FSx file system to use when the data repository task is processed. 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. If a path that you provide isn't valid, the task fails.

• :file_system_id (required, String) —

  The globally unique ID of the file system, assigned by Amazon FSx.

• :report (required, Types::CompletionReport) —

  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.

• :client_request_token (String) — default: Optional —

  An idempotency token for resource creation, in a string of up to 64 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.**

• :tags (Array<Types::Tag>) —

  A list of Tag values, with a maximum of 50 elements.

Returns:

• (Types::CreateDataRepositoryTaskResponse) —

  Returns a response object which responds to the following methods:

  • #data_repository_task => Types::DataRepositoryTask

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 1699

def create_data_repository_task(params = {}, options = {})
  req = build_request(:create_data_repository_task, params)
  req.send_request(options)
end

#create_file_system(params = {}) ⇒ Types::CreateFileSystemResponse

Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

• Amazon FSx for Lustre

• Amazon FSx for NetApp ONTAP

• Amazon FSx for OpenZFS

• Amazon FSx for Windows File Server

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system 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 file system, the client receives success as long as the parameters are the same.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

• Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the file system in JSON format.

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system 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 file system, the client receives a success message as long as the parameters are the same.

The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Examples:

Example: To create a new file system

# This operation creates a new Amazon FSx for Windows File Server file system.

resp = client.create_file_system({
  client_request_token: "a8ca07e4-61ec-4399-99f4-19853801bcd5", 
  file_system_type: "WINDOWS", 
  kms_key_id: "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff", 
  security_group_ids: [
    "sg-edcd9784", 
  ], 
  storage_capacity: 3200, 
  storage_type: "HDD", 
  subnet_ids: [
    "subnet-1234abcd", 
  ], 
  tags: [
    {
      key: "Name", 
      value: "MyFileSystem", 
    }, 
  ], 
  windows_configuration: {
    active_directory_id: "d-1234abcd12", 
    aliases: [
      "accounting.corp.example.com", 
    ], 
    automatic_backup_retention_days: 30, 
    daily_automatic_backup_start_time: "05:00", 
    throughput_capacity: 32, 
    weekly_maintenance_start_time: "1:05:00", 
  }, 
})

resp.to_h outputs the following:
{
  file_system: {
    creation_time: Time.parse("1481841524.0"), 
    dns_name: "fs-0123456789abcdef0.fsx.com", 
    file_system_id: "fs-0123456789abcdef0", 
    kms_key_id: "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff", 
    lifecycle: "CREATING", 
    owner_id: "012345678912", 
    resource_arn: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0123456789abcdef0", 
    storage_capacity: 3200, 
    storage_type: "HDD", 
    subnet_ids: [
      "subnet-1234abcd", 
    ], 
    tags: [
      {
        key: "Name", 
        value: "MyFileSystem", 
      }, 
    ], 
    vpc_id: "vpc-ab1234cd", 
    windows_configuration: {
      active_directory_id: "d-1234abcd12", 
      aliases: [
        {
          lifecycle: "CREATING", 
          name: "accounting.corp.example.com", 
        }, 
      ], 
      automatic_backup_retention_days: 30, 
      daily_automatic_backup_start_time: "05:00", 
      throughput_capacity: 32, 
      weekly_maintenance_start_time: "1:05:00", 
    }, 
  }, 
}

Request syntax with placeholder values

resp = client.create_file_system({
  client_request_token: "ClientRequestToken",
  file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE, ONTAP, OPENZFS
  storage_capacity: 1, # required
  storage_type: "SSD", # accepts SSD, HDD
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  kms_key_id: "KmsKeyId",
  windows_configuration: {
    active_directory_id: "DirectoryId",
    self_managed_active_directory_configuration: {
      domain_name: "ActiveDirectoryFullyQualifiedName", # required
      organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
      file_system_administrators_group: "FileSystemAdministratorsGroupName",
      user_name: "DirectoryUserName", # required
      password: "DirectoryPassword", # required
      dns_ips: ["IpAddress"], # required
    },
    deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
    preferred_subnet_id: "SubnetId",
    throughput_capacity: 1, # required
    weekly_maintenance_start_time: "WeeklyTime",
    daily_automatic_backup_start_time: "DailyTime",
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    aliases: ["AlternateDNSName"],
    audit_log_configuration: {
      file_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
      file_share_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
      audit_log_destination: "GeneralARN",
    },
  },
  lustre_configuration: {
    weekly_maintenance_start_time: "WeeklyTime",
    import_path: "ArchivePath",
    export_path: "ArchivePath",
    imported_file_chunk_size: 1,
    deployment_type: "SCRATCH_1", # accepts SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2
    auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED, NEW_CHANGED_DELETED
    per_unit_storage_throughput: 1,
    daily_automatic_backup_start_time: "DailyTime",
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    drive_cache_type: "NONE", # accepts NONE, READ
    data_compression_type: "NONE", # accepts NONE, LZ4
    log_configuration: {
      level: "DISABLED", # required, accepts DISABLED, WARN_ONLY, ERROR_ONLY, WARN_ERROR
      destination: "GeneralARN",
    },
    root_squash_configuration: {
      root_squash: "LustreRootSquash",
      no_squash_nids: ["LustreNoSquashNid"],
    },
  },
  ontap_configuration: {
    automatic_backup_retention_days: 1,
    daily_automatic_backup_start_time: "DailyTime",
    deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1, SINGLE_AZ_1
    endpoint_ip_address_range: "IpAddressRange",
    fsx_admin_password: "AdminPassword",
    disk_iops_configuration: {
      mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
      iops: 1,
    },
    preferred_subnet_id: "SubnetId",
    route_table_ids: ["RouteTableId"],
    throughput_capacity: 1, # required
    weekly_maintenance_start_time: "WeeklyTime",
  },
  file_system_type_version: "FileSystemTypeVersion",
  open_zfs_configuration: {
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    copy_tags_to_volumes: false,
    daily_automatic_backup_start_time: "DailyTime",
    deployment_type: "SINGLE_AZ_1", # required, accepts SINGLE_AZ_1
    throughput_capacity: 1, # required
    weekly_maintenance_start_time: "WeeklyTime",
    disk_iops_configuration: {
      mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
      iops: 1,
    },
    root_volume_configuration: {
      record_size_ki_b: 1,
      data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
      nfs_exports: [
        {
          client_configurations: [ # required
            {
              clients: "OpenZFSClients", # required
              options: ["OpenZFSNfsExportOption"], # required
            },
          ],
        },
      ],
      user_and_group_quotas: [
        {
          type: "USER", # required, accepts USER, GROUP
          id: 1, # required
          storage_capacity_quota_gi_b: 1, # required
        },
      ],
      copy_tags_to_snapshots: false,
      read_only: false,
    },
  },
})

Response structure

resp.file_system.owner_id #=> String
resp.file_system.creation_time #=> Time
resp.file_system.file_system_id #=> String
resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.file_system.failure_details.message #=> String
resp.file_system.storage_capacity #=> Integer
resp.file_system.storage_type #=> String, one of "SSD", "HDD"
resp.file_system.vpc_id #=> String
resp.file_system.subnet_ids #=> Array
resp.file_system.subnet_ids[0] #=> String
resp.file_system.network_interface_ids #=> Array
resp.file_system.network_interface_ids[0] #=> String
resp.file_system.dns_name #=> String
resp.file_system.kms_key_id #=> String
resp.file_system.resource_arn #=> String
resp.file_system.tags #=> Array
resp.file_system.tags[0].key #=> String
resp.file_system.tags[0].value #=> String
resp.file_system.windows_configuration.active_directory_id #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.file_system.windows_configuration.remote_administration_endpoint #=> String
resp.file_system.windows_configuration.preferred_subnet_id #=> String
resp.file_system.windows_configuration.preferred_file_server_ip #=> String
resp.file_system.windows_configuration.throughput_capacity #=> Integer
resp.file_system.windows_configuration.maintenance_operations_in_progress #=> Array
resp.file_system.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.file_system.windows_configuration.weekly_maintenance_start_time #=> String
resp.file_system.windows_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.windows_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.windows_configuration.copy_tags_to_backups #=> Boolean
resp.file_system.windows_configuration.aliases #=> Array
resp.file_system.windows_configuration.aliases[0].name #=> String
resp.file_system.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.file_system.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.file_system.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.file_system.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.file_system.lustre_configuration.weekly_maintenance_start_time #=> String
resp.file_system.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.file_system.lustre_configuration.data_repository_configuration.import_path #=> String
resp.file_system.lustre_configuration.data_repository_configuration.export_path #=> String
resp.file_system.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.file_system.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.file_system.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.file_system.lustre_configuration.mount_name #=> String
resp.file_system.lustre_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.lustre_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.lustre_configuration.copy_tags_to_backups #=> Boolean
resp.file_system.lustre_configuration.drive_cache_type #=> String, one of "NONE", "READ"
resp.file_system.lustre_configuration.data_compression_type #=> String, one of "NONE", "LZ4"
resp.file_system.lustre_configuration.log_configuration.level #=> String, one of "DISABLED", "WARN_ONLY", "ERROR_ONLY", "WARN_ERROR"
resp.file_system.lustre_configuration.log_configuration.destination #=> String
resp.file_system.lustre_configuration.root_squash_configuration.root_squash #=> String
resp.file_system.lustre_configuration.root_squash_configuration.no_squash_nids #=> Array
resp.file_system.lustre_configuration.root_squash_configuration.no_squash_nids[0] #=> String
resp.file_system.administrative_actions #=> Array
resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.file_system.administrative_actions[0].progress_percent #=> Integer
resp.file_system.administrative_actions[0].request_time #=> Time
resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
resp.file_system.administrative_actions[0].failure_details.message #=> String
resp.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
resp.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.file_system.administrative_actions[0].target_volume_values.name #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
resp.file_system.administrative_actions[0].target_volume_values.tags #=> Array
resp.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
resp.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
resp.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
resp.file_system.administrative_actions[0].target_volume_values.administrative_actions #=> Types::AdministrativeActions
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.parent_volume_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.volume_path #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_reservation_gi_b #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_quota_gi_b #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.record_size_ki_b #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.data_compression_type #=> String, one of "NONE", "ZSTD", "LZ4"
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.copy_tags_to_snapshots #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.snapshot_arn #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.copy_strategy #=> String, one of "CLONE", "FULL_COPY"
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.read_only #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].clients #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options[0] #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].type #=> String, one of "USER", "GROUP"
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].id #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].storage_capacity_quota_gi_b #=> Integer
resp.file_system.administrative_actions[0].target_snapshot_values.resource_arn #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.snapshot_id #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.name #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.volume_id #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.creation_time #=> Time
resp.file_system.administrative_actions[0].target_snapshot_values.lifecycle #=> String, one of "PENDING", "CREATING", "DELETING", "AVAILABLE"
resp.file_system.administrative_actions[0].target_snapshot_values.lifecycle_transition_reason.message #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.tags #=> Array
resp.file_system.administrative_actions[0].target_snapshot_values.tags[0].key #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.tags[0].value #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.administrative_actions #=> Types::AdministrativeActions
resp.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
resp.file_system.ontap_configuration.endpoint_ip_address_range #=> String
resp.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
resp.file_system.ontap_configuration.endpoints.management.dns_name #=> String
resp.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
resp.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
resp.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
resp.file_system.ontap_configuration.preferred_subnet_id #=> String
resp.file_system.ontap_configuration.route_table_ids #=> Array
resp.file_system.ontap_configuration.route_table_ids[0] #=> String
resp.file_system.ontap_configuration.throughput_capacity #=> Integer
resp.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
resp.file_system.file_system_type_version #=> String
resp.file_system.open_zfs_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.open_zfs_configuration.copy_tags_to_backups #=> Boolean
resp.file_system.open_zfs_configuration.copy_tags_to_volumes #=> Boolean
resp.file_system.open_zfs_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.open_zfs_configuration.deployment_type #=> String, one of "SINGLE_AZ_1"
resp.file_system.open_zfs_configuration.throughput_capacity #=> Integer
resp.file_system.open_zfs_configuration.weekly_maintenance_start_time #=> String
resp.file_system.open_zfs_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.file_system.open_zfs_configuration.disk_iops_configuration.iops #=> Integer
resp.file_system.open_zfs_configuration.root_volume_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_request_token (String) —

  A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the 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.**

• :file_system_type (required, String) —

  The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.

• :storage_capacity (required, Integer) —

  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 is from 1024 GiB up to 196,608 GiB (192 TiB).

  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).

• :storage_type (String) —

  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 in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.

• :subnet_ids (required, Array<String>) —

  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 in the Amazon FSx for Windows User Guide and Availability and durability 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.

• :security_group_ids (Array<String>) —

  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.

• :tags (Array<Types::Tag>) —

  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.

• :kms_key_id (String) —

  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 in the Key Management Service API Reference.

• :windows_configuration (Types::CreateFileSystemWindowsConfiguration) —

  The Microsoft Windows configuration for the file system that's being created.

• :lustre_configuration (Types::CreateFileSystemLustreConfiguration) —

  The Lustre configuration for the file system being created.

  The following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

  • AutoImportPolicy

  • ExportPath

  • ImportedChunkSize

  • ImportPath

• :ontap_configuration (Types::CreateFileSystemOntapConfiguration) —

  The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

• :file_system_type_version (String) — default: Optional —

  For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10 and 2.12:

  • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.

  • 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.

  Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.

  If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

• :open_zfs_configuration (Types::CreateFileSystemOpenZFSConfiguration) —

  The OpenZFS configuration for the file system that's being created.

Returns:

• (Types::CreateFileSystemResponse) —

  Returns a response object which responds to the following methods:

  • #file_system => Types::FileSystem

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2285

def create_file_system(params = {}, options = {})
  req = build_request(:create_file_system, params)
  req.send_request(options)
end

#create_file_system_from_backup(params = {}) ⇒ Types::CreateFileSystemFromBackupResponse

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

• Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the file system.

Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system 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 file system, the client receives a success message as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Examples:

Example: To create a new file system from backup

# This operation creates a new file system from backup.

resp = client.create_file_system_from_backup({
  backup_id: "backup-03e3c82e0183b7b6b", 
  client_request_token: "f4c94ed7-238d-4c46-93db-48cd62ec33b7", 
  security_group_ids: [
    "sg-edcd9784", 
  ], 
  subnet_ids: [
    "subnet-1234abcd", 
  ], 
  tags: [
    {
      key: "Name", 
      value: "MyFileSystem", 
    }, 
  ], 
  windows_configuration: {
    throughput_capacity: 8, 
  }, 
})

resp.to_h outputs the following:
{
  file_system: {
    creation_time: Time.parse("1481841524.0"), 
    dns_name: "fs-0498eed5fe91001ec.fsx.com", 
    file_system_id: "fs-0498eed5fe91001ec", 
    kms_key_id: "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", 
    lifecycle: "CREATING", 
    owner_id: "012345678912", 
    resource_arn: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", 
    storage_capacity: 300, 
    subnet_ids: [
      "subnet-1234abcd", 
    ], 
    tags: [
      {
        key: "Name", 
        value: "MyFileSystem", 
      }, 
    ], 
    vpc_id: "vpc-ab1234cd", 
    windows_configuration: {
      active_directory_id: "d-1234abcd12", 
      automatic_backup_retention_days: 30, 
      daily_automatic_backup_start_time: "05:00", 
      throughput_capacity: 8, 
      weekly_maintenance_start_time: "1:05:00", 
    }, 
  }, 
}

Request syntax with placeholder values

resp = client.create_file_system_from_backup({
  backup_id: "BackupId", # required
  client_request_token: "ClientRequestToken",
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  windows_configuration: {
    active_directory_id: "DirectoryId",
    self_managed_active_directory_configuration: {
      domain_name: "ActiveDirectoryFullyQualifiedName", # required
      organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
      file_system_administrators_group: "FileSystemAdministratorsGroupName",
      user_name: "DirectoryUserName", # required
      password: "DirectoryPassword", # required
      dns_ips: ["IpAddress"], # required
    },
    deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
    preferred_subnet_id: "SubnetId",
    throughput_capacity: 1, # required
    weekly_maintenance_start_time: "WeeklyTime",
    daily_automatic_backup_start_time: "DailyTime",
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    aliases: ["AlternateDNSName"],
    audit_log_configuration: {
      file_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
      file_share_access_audit_log_level: "DISABLED", # required, accepts DISABLED, SUCCESS_ONLY, FAILURE_ONLY, SUCCESS_AND_FAILURE
      audit_log_destination: "GeneralARN",
    },
  },
  lustre_configuration: {
    weekly_maintenance_start_time: "WeeklyTime",
    import_path: "ArchivePath",
    export_path: "ArchivePath",
    imported_file_chunk_size: 1,
    deployment_type: "SCRATCH_1", # accepts SCRATCH_1, SCRATCH_2, PERSISTENT_1, PERSISTENT_2
    auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED, NEW_CHANGED_DELETED
    per_unit_storage_throughput: 1,
    daily_automatic_backup_start_time: "DailyTime",
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    drive_cache_type: "NONE", # accepts NONE, READ
    data_compression_type: "NONE", # accepts NONE, LZ4
    log_configuration: {
      level: "DISABLED", # required, accepts DISABLED, WARN_ONLY, ERROR_ONLY, WARN_ERROR
      destination: "GeneralARN",
    },
    root_squash_configuration: {
      root_squash: "LustreRootSquash",
      no_squash_nids: ["LustreNoSquashNid"],
    },
  },
  storage_type: "SSD", # accepts SSD, HDD
  kms_key_id: "KmsKeyId",
  file_system_type_version: "FileSystemTypeVersion",
  open_zfs_configuration: {
    automatic_backup_retention_days: 1,
    copy_tags_to_backups: false,
    copy_tags_to_volumes: false,
    daily_automatic_backup_start_time: "DailyTime",
    deployment_type: "SINGLE_AZ_1", # required, accepts SINGLE_AZ_1
    throughput_capacity: 1, # required
    weekly_maintenance_start_time: "WeeklyTime",
    disk_iops_configuration: {
      mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
      iops: 1,
    },
    root_volume_configuration: {
      record_size_ki_b: 1,
      data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
      nfs_exports: [
        {
          client_configurations: [ # required
            {
              clients: "OpenZFSClients", # required
              options: ["OpenZFSNfsExportOption"], # required
            },
          ],
        },
      ],
      user_and_group_quotas: [
        {
          type: "USER", # required, accepts USER, GROUP
          id: 1, # required
          storage_capacity_quota_gi_b: 1, # required
        },
      ],
      copy_tags_to_snapshots: false,
      read_only: false,
    },
  },
})

Response structure

resp.file_system.owner_id #=> String
resp.file_system.creation_time #=> Time
resp.file_system.file_system_id #=> String
resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.file_system.failure_details.message #=> String
resp.file_system.storage_capacity #=> Integer
resp.file_system.storage_type #=> String, one of "SSD", "HDD"
resp.file_system.vpc_id #=> String
resp.file_system.subnet_ids #=> Array
resp.file_system.subnet_ids[0] #=> String
resp.file_system.network_interface_ids #=> Array
resp.file_system.network_interface_ids[0] #=> String
resp.file_system.dns_name #=> String
resp.file_system.kms_key_id #=> String
resp.file_system.resource_arn #=> String
resp.file_system.tags #=> Array
resp.file_system.tags[0].key #=> String
resp.file_system.tags[0].value #=> String
resp.file_system.windows_configuration.active_directory_id #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.file_system.windows_configuration.remote_administration_endpoint #=> String
resp.file_system.windows_configuration.preferred_subnet_id #=> String
resp.file_system.windows_configuration.preferred_file_server_ip #=> String
resp.file_system.windows_configuration.throughput_capacity #=> Integer
resp.file_system.windows_configuration.maintenance_operations_in_progress #=> Array
resp.file_system.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.file_system.windows_configuration.weekly_maintenance_start_time #=> String
resp.file_system.windows_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.windows_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.windows_configuration.copy_tags_to_backups #=> Boolean
resp.file_system.windows_configuration.aliases #=> Array
resp.file_system.windows_configuration.aliases[0].name #=> String
resp.file_system.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.file_system.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.file_system.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.file_system.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.file_system.lustre_configuration.weekly_maintenance_start_time #=> String
resp.file_system.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.file_system.lustre_configuration.data_repository_configuration.import_path #=> String
resp.file_system.lustre_configuration.data_repository_configuration.export_path #=> String
resp.file_system.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.file_system.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.file_system.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.file_system.lustre_configuration.mount_name #=> String
resp.file_system.lustre_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.lustre_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.lustre_configuration.copy_tags_to_backups #=> Boolean
resp.file_system.lustre_configuration.drive_cache_type #=> String, one of "NONE", "READ"
resp.file_system.lustre_configuration.data_compression_type #=> String, one of "NONE", "LZ4"
resp.file_system.lustre_configuration.log_configuration.level #=> String, one of "DISABLED", "WARN_ONLY", "ERROR_ONLY", "WARN_ERROR"
resp.file_system.lustre_configuration.log_configuration.destination #=> String
resp.file_system.lustre_configuration.root_squash_configuration.root_squash #=> String
resp.file_system.lustre_configuration.root_squash_configuration.no_squash_nids #=> Array
resp.file_system.lustre_configuration.root_squash_configuration.no_squash_nids[0] #=> String
resp.file_system.administrative_actions #=> Array
resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.file_system.administrative_actions[0].progress_percent #=> Integer
resp.file_system.administrative_actions[0].request_time #=> Time
resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
resp.file_system.administrative_actions[0].failure_details.message #=> String
resp.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
resp.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.file_system.administrative_actions[0].target_volume_values.name #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
resp.file_system.administrative_actions[0].target_volume_values.tags #=> Array
resp.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
resp.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
resp.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
resp.file_system.administrative_actions[0].target_volume_values.administrative_actions #=> Types::AdministrativeActions
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.parent_volume_id #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.volume_path #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_reservation_gi_b #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_quota_gi_b #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.record_size_ki_b #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.data_compression_type #=> String, one of "NONE", "ZSTD", "LZ4"
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.copy_tags_to_snapshots #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.snapshot_arn #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.copy_strategy #=> String, one of "CLONE", "FULL_COPY"
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.read_only #=> Boolean
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].clients #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options[0] #=> String
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas #=> Array
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].type #=> String, one of "USER", "GROUP"
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].id #=> Integer
resp.file_system.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].storage_capacity_quota_gi_b #=> Integer
resp.file_system.administrative_actions[0].target_snapshot_values.resource_arn #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.snapshot_id #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.name #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.volume_id #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.creation_time #=> Time
resp.file_system.administrative_actions[0].target_snapshot_values.lifecycle #=> String, one of "PENDING", "CREATING", "DELETING", "AVAILABLE"
resp.file_system.administrative_actions[0].target_snapshot_values.lifecycle_transition_reason.message #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.tags #=> Array
resp.file_system.administrative_actions[0].target_snapshot_values.tags[0].key #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.tags[0].value #=> String
resp.file_system.administrative_actions[0].target_snapshot_values.administrative_actions #=> Types::AdministrativeActions
resp.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
resp.file_system.ontap_configuration.endpoint_ip_address_range #=> String
resp.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
resp.file_system.ontap_configuration.endpoints.management.dns_name #=> String
resp.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
resp.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
resp.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
resp.file_system.ontap_configuration.preferred_subnet_id #=> String
resp.file_system.ontap_configuration.route_table_ids #=> Array
resp.file_system.ontap_configuration.route_table_ids[0] #=> String
resp.file_system.ontap_configuration.throughput_capacity #=> Integer
resp.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
resp.file_system.file_system_type_version #=> String
resp.file_system.open_zfs_configuration.automatic_backup_retention_days #=> Integer
resp.file_system.open_zfs_configuration.copy_tags_to_backups #=> Boolean
resp.file_system.open_zfs_configuration.copy_tags_to_volumes #=> Boolean
resp.file_system.open_zfs_configuration.daily_automatic_backup_start_time #=> String
resp.file_system.open_zfs_configuration.deployment_type #=> String, one of "SINGLE_AZ_1"
resp.file_system.open_zfs_configuration.throughput_capacity #=> Integer
resp.file_system.open_zfs_configuration.weekly_maintenance_start_time #=> String
resp.file_system.open_zfs_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.file_system.open_zfs_configuration.disk_iops_configuration.iops #=> Integer
resp.file_system.open_zfs_configuration.root_volume_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :backup_id (required, String) —

  The ID of the source backup. Specifies the backup that you are copying.

• :client_request_token (String) —

  A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the 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.**

• :subnet_ids (required, Array<String>) —

  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.

• :security_group_ids (Array<String>) —

  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.

• :tags (Array<Types::Tag>) —

  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.

• :windows_configuration (Types::CreateFileSystemWindowsConfiguration) —

  The configuration for this Microsoft Windows file system.

• :lustre_configuration (Types::CreateFileSystemLustreConfiguration) —

  The Lustre configuration for the file system being created.

  The following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

  • AutoImportPolicy

  • ExportPath

  • ImportedChunkSize

  • ImportPath

• :storage_type (String) —

  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.

• :kms_key_id (String) —

  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 in the Key Management Service API Reference.

• :file_system_type_version (String) —

  Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10 and 2.12.

  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.

• :open_zfs_configuration (Types::CreateFileSystemOpenZFSConfiguration) —

  The OpenZFS configuration for the file system that's being created.

Returns:

• (Types::CreateFileSystemFromBackupResponse) —

  Returns a response object which responds to the following methods:

  • #file_system => Types::FileSystem

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2766

def create_file_system_from_backup(params = {}, options = {})
  req = build_request(:create_file_system_from_backup, params)
  req.send_request(options)
end

#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResponse

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:

• Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the snapshot.

By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.

The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.

Examples:

Request syntax with placeholder values

resp = client.create_snapshot({
  client_request_token: "ClientRequestToken",
  name: "SnapshotName", # required
  volume_id: "VolumeId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure

resp.snapshot.resource_arn #=> String
resp.snapshot.snapshot_id #=> String
resp.snapshot.name #=> String
resp.snapshot.volume_id #=> String
resp.snapshot.creation_time #=> Time
resp.snapshot.lifecycle #=> String, one of "PENDING", "CREATING", "DELETING", "AVAILABLE"
resp.snapshot.lifecycle_transition_reason.message #=> String
resp.snapshot.tags #=> Array
resp.snapshot.tags[0].key #=> String
resp.snapshot.tags[0].value #=> String
resp.snapshot.administrative_actions #=> Array
resp.snapshot.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.snapshot.administrative_actions[0].progress_percent #=> Integer
resp.snapshot.administrative_actions[0].request_time #=> Time
resp.snapshot.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.snapshot.administrative_actions[0].target_file_system_values.owner_id #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.creation_time #=> Time
resp.snapshot.administrative_actions[0].target_file_system_values.file_system_id #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.snapshot.administrative_actions[0].target_file_system_values.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.snapshot.administrative_actions[0].target_file_system_values.failure_details.message #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.storage_capacity #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.storage_type #=> String, one of "SSD", "HDD"
resp.snapshot.administrative_actions[0].target_file_system_values.vpc_id #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.subnet_ids #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.subnet_ids[0] #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.network_interface_ids #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.network_interface_ids[0] #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.dns_name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.kms_key_id #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.resource_arn #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.tags #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.tags[0].key #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.tags[0].value #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.active_directory_id #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.remote_administration_endpoint #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.preferred_subnet_id #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.preferred_file_server_ip #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.throughput_capacity #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.weekly_maintenance_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.daily_automatic_backup_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.automatic_backup_retention_days #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.copy_tags_to_backups #=> Boolean
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.aliases #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.snapshot.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.weekly_maintenance_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.import_path #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.export_path #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.mount_name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.daily_automatic_backup_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.automatic_backup_retention_days #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.copy_tags_to_backups #=> Boolean
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.drive_cache_type #=> String, one of "NONE", "READ"
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.data_compression_type #=> String, one of "NONE", "LZ4"
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.log_configuration.level #=> String, one of "DISABLED", "WARN_ONLY", "ERROR_ONLY", "WARN_ERROR"
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.log_configuration.destination #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.root_squash #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.no_squash_nids #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.lustre_configuration.root_squash_configuration.no_squash_nids[0] #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.administrative_actions #=> Types::AdministrativeActions
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.automatic_backup_retention_days #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.daily_automatic_backup_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.endpoint_ip_address_range #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.dns_name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.dns_name #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.ip_addresses #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.disk_iops_configuration.iops #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.preferred_subnet_id #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.route_table_ids #=> Array
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.route_table_ids[0] #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.throughput_capacity #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.ontap_configuration.weekly_maintenance_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.file_system_type_version #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.automatic_backup_retention_days #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.copy_tags_to_backups #=> Boolean
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.copy_tags_to_volumes #=> Boolean
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.daily_automatic_backup_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.deployment_type #=> String, one of "SINGLE_AZ_1"
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.throughput_capacity #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.weekly_maintenance_start_time #=> String
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.disk_iops_configuration.iops #=> Integer
resp.snapshot.administrative_actions[0].target_file_system_values.open_zfs_configuration.root_volume_id #=> String
resp.snapshot.administrative_actions[0].failure_details.message #=> String
resp.snapshot.administrative_actions[0].target_volume_values.creation_time #=> Time
resp.snapshot.administrative_actions[0].target_volume_values.file_system_id #=> String
resp.snapshot.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.snapshot.administrative_actions[0].target_volume_values.name #=> String
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
resp.snapshot.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.snapshot.administrative_actions[0].target_volume_values.resource_arn #=> String
resp.snapshot.administrative_actions[0].target_volume_values.tags #=> Array
resp.snapshot.administrative_actions[0].target_volume_values.tags[0].key #=> String
resp.snapshot.administrative_actions[0].target_volume_values.tags[0].value #=> String
resp.snapshot.administrative_actions[0].target_volume_values.volume_id #=> String
resp.snapshot.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.snapshot.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
resp.snapshot.administrative_actions[0].target_volume_values.administrative_actions #=> Types::AdministrativeActions
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.parent_volume_id #=> String
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.volume_path #=> String
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_reservation_gi_b #=> Integer
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.storage_capacity_quota_gi_b #=> Integer
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.record_size_ki_b #=> Integer
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.data_compression_type #=> String, one of "NONE", "ZSTD", "LZ4"
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.copy_tags_to_snapshots #=> Boolean
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.snapshot_arn #=> String
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.origin_snapshot.copy_strategy #=> String, one of "CLONE", "FULL_COPY"
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.read_only #=> Boolean
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports #=> Array
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations #=> Array
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].clients #=> String
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options #=> Array
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.nfs_exports[0].client_configurations[0].options[0] #=> String
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas #=> Array
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].type #=> String, one of "USER", "GROUP"
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].id #=> Integer
resp.snapshot.administrative_actions[0].target_volume_values.open_zfs_configuration.user_and_group_quotas[0].storage_capacity_quota_gi_b #=> Integer
resp.snapshot.administrative_actions[0].target_snapshot_values #=> Types::Snapshot

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :client_request_token (String) — default: Optional —

  An idempotency token for resource creation, in a string of up to 64 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.**

• :name (required, String) —

  The name of the snapshot.

• :volume_id (required, String) —

  The ID of the volume that you are taking a snapshot of.

• :tags (Array<Types::Tag>) —

  A list of Tag values, with a maximum of 50 elements.

Returns:

• (Types::CreateSnapshotResponse) —

  Returns a response object which responds to the following methods:

  • #snapshot => Types::Snapshot

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 2997

def create_snapshot(params = {}, options = {})
  req = build_request(:create_snapshot, params)
  req.send_request(options)
end

#create_storage_virtual_machine(params = {}) ⇒ Types::CreateStorageVirtualMachineResponse

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

Examples:

Request syntax with placeholder values

resp = client.create_storage_virtual_machine({
  active_directory_configuration: {
    net_bios_name: "NetBiosAlias", # required
    self_managed_active_directory_configuration: {
      domain_name: "ActiveDirectoryFullyQualifiedName", # required
      organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
      file_system_administrators_group: "FileSystemAdministratorsGroupName",
      user_name: "DirectoryUserName", # required
      password: "DirectoryPassword", # required
      dns_ips: ["IpAddress"], # required
    },
  },
  client_request_token: "ClientRequestToken",
  file_system_id: "FileSystemId", # required
  name: "StorageVirtualMachineName", # required
  svm_admin_password: "AdminPassword",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  root_volume_security_style: "UNIX", # accepts UNIX, NTFS, MIXED
})

Response structure

resp.storage_virtual_machine.active_directory_configuration.net_bios_name #=> String
resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.storage_virtual_machine.creation_time #=> Time
resp.storage_virtual_machine.endpoints.iscsi.dns_name #=> String
resp.storage_virtual_machine.endpoints.iscsi.ip_addresses #=> Array
resp.storage_virtual_machine.endpoints.iscsi.ip_addresses[0] #=> String
resp.storage_virtual_machine.endpoints.management.dns_name #=> String
resp.storage_virtual_machine.endpoints.management.ip_addresses #=> Array
resp.storage_virtual_machine.endpoints.management.ip_addresses[0] #=> String
resp.storage_virtual_machine.endpoints.nfs.dns_name #=> String
resp.storage_virtual_machine.endpoints.nfs.ip_addresses #=> Array
resp.storage_virtual_machine.endpoints.nfs.ip_addresses[0] #=> String
resp.storage_virtual_machine.endpoints.smb.dns_name #=> String
resp.storage_virtual_machine.endpoints.smb.ip_addresses #=> Array
resp.storage_virtual_machine.endpoints.smb.ip_addresses[0] #=> String
resp.storage_virtual_machine.file_system_id #=> String
resp.storage_virtual_machine.lifecycle #=> String, one of "CREATED", "CREATING", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
resp.storage_virtual_machine.name #=> String
resp.storage_virtual_machine.resource_arn #=> String
resp.storage_virtual_machine.storage_virtual_machine_id #=> String
resp.storage_virtual_machine.subtype #=> String, one of "DEFAULT", "DP_DESTINATION", "SYNC_DESTINATION", "SYNC_SOURCE"
resp.storage_virtual_machine.uuid #=> String
resp.storage_virtual_machine.tags #=> Array
resp.storage_virtual_machine.tags[0].key #=> String
resp.storage_virtual_machine.tags[0].value #=> String
resp.storage_virtual_machine.lifecycle_transition_reason.message #=> String
resp.storage_virtual_machine.root_volume_security_style #=> String, one of "UNIX", "NTFS", "MIXED"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :active_directory_configuration (Types::CreateSvmActiveDirectoryConfiguration) —

  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 client accessing the file system.

• :client_request_token (String) — default: Optional —

  An idempotency token for resource creation, in a string of up to 64 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.**

• :file_system_id (required, String) —

  The globally unique ID of the file system, assigned by Amazon FSx.

• :name (required, String) —

  The name of the SVM.

• :svm_admin_password (String) —

  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.

• :tags (Array<Types::Tag>) —

  A list of Tag values, with a maximum of 50 elements.

• :root_volume_security_style (String) —

  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 Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.

  • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

Returns:

• (Types::CreateStorageVirtualMachineResponse) —

  Returns a response object which responds to the following methods:

  • #storage_virtual_machine => Types::StorageVirtualMachine

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/client.rb', line 3119

def create_storage_virtual_machine(params = {}, options = {})
  req = build_request(:create_storage_virtual_machine, params)
  req.send_request(options)
end

#create_volume(params = {}) ⇒ Types::CreateVolumeResponse

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

Examples:

Request syntax with placeholder values

resp = client.create_volume({
  client_request_token: "ClientRequestToken",
  volume_type: "ONTAP", # required, accepts ONTAP, OPENZFS
  name: "VolumeName", # required
  ontap_configuration: {
    junction_path: "JunctionPath", # required
    security_style: "UNIX", # accepts UNIX, NTFS, MIXED
    size_in_megabytes: 1, # required
    storage_efficiency_enabled: false, # required
    storage_virtual_machine_id: "StorageVirtualMachineId", # required
    tiering_policy: {
      cooling_period: 1,
      name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  open_zfs_configuration: {
    parent_volume_id: "VolumeId", # required
    storage_capacity_reservation_gi_b: 1,
    storage_capacity_quota_gi_b: 1,
    record_size_ki_b: 1,
    data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
    copy_tags_to_snapshots: false,
    origin_snapshot: {
      snapshot_arn: "ResourceARN", # required
      copy_strategy: "CLONE", # required, accepts CLONE, FULL_COPY
    },
    read_only: false,
    nfs_exports: [
      {
        client_configurations: [ # required
          {
            clients: "OpenZFSClients", # required
            options: ["OpenZFSNfsExportOption"], # required
          },
        ],
      },
    ],
    user_and_group_quotas: [
      {
        type: "USER", # required, accepts USER, GROUP
        id: 1, # required
        storage_capacity_quota_gi_b: 1, # required
      },
    ],
  },
})

Response structure

resp.volume.creation_time #=> Time
resp.volume.file_system_id #=> String
resp.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE"
resp.volume.name #=> String
resp.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
resp.volume.ontap_configuration.junction_path #=> String
resp.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
resp.volume.ontap_configuration.size_in_megabytes #=> Integer
resp.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
resp.volume.ontap_configuration.storage_virtual_machine_id #=> String
resp.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
resp.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
resp.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
resp.volume.ontap_configuration.uuid #=> String
resp.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
resp.volume.resource_arn #=> String
resp.volume.tags #=> Array
resp.volume.tags[0].key #=> String
resp.volume.tags[0].value #=> String
resp.volume.volume_id #=> String
resp.volume.volume_type #=> String, one of "ONTAP", "OPENZFS"
resp.volume.lifecycle_transition_reason.message #=> String
resp.volume.administrative_actions #=> Array
resp.volume.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION", "FILE_SYSTEM_ALIAS_ASSOCIATION", "FILE_SYSTEM_ALIAS_DISASSOCIATION", "VOLUME_UPDATE", "SNAPSHOT_UPDATE", "RELEASE_NFS_V3_LOCKS"
resp.volume.administrative_actions[0].progress_percent #=> Integer
resp.volume.administrative_actions[0].request_time #=> Time
resp.volume.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
resp.volume.administrative_actions[0].target_file_system_values.owner_id #=> String
resp.volume.administrative_actions[0].target_file_system_values.creation_time #=> Time
resp.volume.administrative_actions[0].target_file_system_values.file_system_id #=> String
resp.volume.administrative_actions[0].target_file_system_values.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS"
resp.volume.administrative_actions[0].target_file_system_values.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE"
resp.volume.administrative_actions[0].target_file_system_values.failure_details.message #=> String
resp.volume.administrative_actions[0].target_file_system_values.storage_capacity #=> Integer
resp.volume.administrative_actions[0].target_file_system_values.storage_type #=> String, one of "SSD", "HDD"
resp.volume.administrative_actions[0].target_file_system_values.vpc_id #=> String
resp.volume.administrative_actions[0].target_file_system_values.subnet_ids #=> Array
resp.volume.administrative_actions[0].target_file_system_values.subnet_ids[0] #=> String
resp.volume.administrative_actions[0].target_file_system_values.network_interface_ids #=> Array
resp.volume.administrative_actions[0].target_file_system_values.network_interface_ids[0] #=> String
resp.volume.administrative_actions[0].target_file_system_values.dns_name #=> String
resp.volume.administrative_actions[0].target_file_system_values.kms_key_id #=> String
resp.volume.administrative_actions[0].target_file_system_values.resource_arn #=> String
resp.volume.administrative_actions[0].target_file_system_values.tags #=> Array
resp.volume.administrative_actions[0].target_file_system_values.tags[0].key #=> String
resp.volume.administrative_actions[0].target_file_system_values.tags[0].value #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.active_directory_id #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.domain_name #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.remote_administration_endpoint #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.preferred_subnet_id #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.preferred_file_server_ip #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.throughput_capacity #=> Integer
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress #=> Array
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.maintenance_operations_in_progress[0] #=> String, one of "PATCHING", "BACKING_UP"
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.weekly_maintenance_start_time #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.daily_automatic_backup_start_time #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.automatic_backup_retention_days #=> Integer
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.copy_tags_to_backups #=> Boolean
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases #=> Array
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].name #=> String
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.aliases[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED"
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.file_share_access_audit_log_level #=> String, one of "DISABLED", "SUCCESS_ONLY", "FAILURE_ONLY", "SUCCESS_AND_FAILURE"
resp.volume.administrative_actions[0].target_file_system_values.windows_configuration.audit_log_configuration.audit_log_destination #=> String
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.weekly_maintenance_start_time #=> String
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.lifecycle #=> String, one of "CREATING", "AVAILABLE", "MISCONFIGURED", "UPDATING", "DELETING", "FAILED"
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.import_path #=> String
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.export_path #=> String
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.imported_file_chunk_size #=> Integer
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.auto_import_policy #=> String, one of "NONE", "NEW", "NEW_CHANGED", "NEW_CHANGED_DELETED"
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.data_repository_configuration.failure_details.message #=> String
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1", "PERSISTENT_2"
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.per_unit_storage_throughput #=> Integer
resp.volume.administrative_actions[0].target_file_system_values.lustre_configuration.mount_name #=> String
resp.volume.administrative_actions[0].