fsx

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 19, 2021 License: Apache-2.0 Imports: 29 Imported by: 31

Documentation

Overview

Package fsx provides the API client, operations, and parameter types for Amazon FSx.

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-03-01"
View Source 
const ServiceID = "FSx"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

Types

type AssociateFileSystemAliasesInput added in v0.30.0 

type AssociateFileSystemAliasesInput struct {

	// 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.
	//
	// This member is required.
	Aliases []string

	// Specifies the file system with which you want to associate one or more DNS
	// aliases.
	//
	// This member is required.
	FileSystemId *string

	// (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 AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string
}

The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.

type AssociateFileSystemAliasesOutput added in v0.30.0 

type AssociateFileSystemAliasesOutput struct {

	// An array of the DNS aliases that Amazon FSx is associating with the file system.
	Aliases []types.Alias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The system generated response showing the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. It can take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE.

type CancelDataRepositoryTaskInput 

type CancelDataRepositoryTaskInput struct {

	// Specifies the data repository task to cancel.
	//
	// This member is required.
	TaskId *string
}

Cancels a data repository task.

type CancelDataRepositoryTaskOutput 

type CancelDataRepositoryTaskOutput struct {

	// The lifecycle status of the data repository task, as follows:
	//
	// * PENDING -
	// Amazon FSx has not started the task.
	//
	// * EXECUTING - Amazon FSx is processing the
	// task.
	//
	// * FAILED - Amazon FSx was not able to complete the task. For example,
	// there may be files the task failed to process. The
	// DataRepositoryTaskFailureDetails property provides more information about task
	// failures.
	//
	// * SUCCEEDED - FSx completed the task successfully.
	//
	// * CANCELED -
	// Amazon FSx canceled the task and it did not complete.
	//
	// * CANCELING - FSx is in
	// process of canceling the task.
	Lifecycle types.DataRepositoryTaskLifecycle

	// The ID of the task being canceled.
	TaskId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon FSx.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateFileSystemAliases added in v0.30.0 

func (c *Client) AssociateFileSystemAliases(ctx context.Context, params *AssociateFileSystemAliasesInput, optFns ...func(*Options)) (*AssociateFileSystemAliasesOutput, error)

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 systen 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 (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) and Walkthrough 5: Using DNS aliases to access your file system (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html), 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.

func (*Client) CancelDataRepositoryTask 

func (c *Client) CancelDataRepositoryTask(ctx context.Context, params *CancelDataRepositoryTaskInput, optFns ...func(*Options)) (*CancelDataRepositoryTaskOutput, error)

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.

func (*Client) CreateBackup 

func (c *Client) CreateBackup(ctx context.Context, params *CreateBackupInput, optFns ...func(*Options)) (*CreateBackupOutput, error)

Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system. For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:

* a Persistent deployment type

* is not linked to a data respository.

For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html). For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html). 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 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.

func (*Client) CreateDataRepositoryTask 

func (c *Client) CreateDataRepositoryTask(ctx context.Context, params *CreateDataRepositoryTaskInput, optFns ...func(*Options)) (*CreateDataRepositoryTaskOutput, error)

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 repository. 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 its 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 (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html). To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket (https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-fs-linked-data-repo.html).

func (*Client) CreateFileSystem 

func (c *Client) CreateFileSystem(ctx context.Context, params *CreateFileSystemInput, optFns ...func(*Options)) (*CreateFileSystemOutput, error)

Creates a new, empty Amazon FSx file system. 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 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.

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

func (*Client) CreateFileSystemFromBackup 

func (c *Client) CreateFileSystemFromBackup(ctx context.Context, params *CreateFileSystemFromBackupInput, optFns ...func(*Options)) (*CreateFileSystemFromBackupOutput, error)

Creates a new Amazon FSx 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 client request token specified by the file system exists and 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 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 success 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.

func (*Client) DeleteBackup 

func (c *Client) DeleteBackup(ctx context.Context, params *DeleteBackupInput, optFns ...func(*Options)) (*DeleteBackupOutput, error)

Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone. The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls. The data in a deleted backup is also deleted and can't be recovered by any means.

func (*Client) DeleteFileSystem 

func (c *Client) DeleteFileSystem(ctx context.Context, params *DeleteFileSystemInput, optFns ...func(*Options)) (*DeleteFileSystemOutput, error)

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted. The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error. Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state. The data in a deleted file system is also deleted and can't be recovered by any means.

func (*Client) DescribeBackups 

func (c *Client) DescribeBackups(ctx context.Context, params *DescribeBackupsInput, optFns ...func(*Options)) (*DescribeBackupsOutput, error)

Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind:

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

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

func (*Client) DescribeDataRepositoryTasks 

func (c *Client) DescribeDataRepositoryTasks(ctx context.Context, params *DescribeDataRepositoryTasksInput, optFns ...func(*Options)) (*DescribeDataRepositoryTasksOutput, error)

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. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

func (*Client) DescribeFileSystemAliases added in v0.30.0 

func (c *Client) DescribeFileSystemAliases(ctx context.Context, params *DescribeFileSystemAliasesInput, optFns ...func(*Options)) (*DescribeFileSystemAliasesOutput, error)

Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.

func (*Client) DescribeFileSystems 

func (c *Client) DescribeFileSystems(ctx context.Context, params *DescribeFileSystemsInput, optFns ...func(*Options)) (*DescribeFileSystemsOutput, error)

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind:

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

* The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

func (*Client) DisassociateFileSystemAliases added in v0.30.0 

func (c *Client) DisassociateFileSystemAliases(ctx context.Context, params *DisassociateFileSystemAliasesInput, optFns ...func(*Options)) (*DisassociateFileSystemAliasesOutput, error)

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. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html). The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server. When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this action, keep the following in mind:

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

* The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tags an Amazon FSx resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

This action removes a tag from an Amazon FSx resource.

func (*Client) UpdateFileSystem 

func (c *Client) UpdateFileSystem(ctx context.Context, params *UpdateFileSystemInput, optFns ...func(*Options)) (*UpdateFileSystemOutput, error)

Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties:

* AutomaticBackupRetentionDays

* DailyAutomaticBackupStartTime

* SelfManagedActiveDirectoryConfiguration

* StorageCapacity

* ThroughputCapacity

* WeeklyMaintenanceStartTime

For Amazon FSx for Lustre file systems, you can update the following properties:

* AutoImportPolicy

* AutomaticBackupRetentionDays

* DailyAutomaticBackupStartTime

* StorageCapacity

* WeeklyMaintenanceStartTime

type CreateBackupInput 

type CreateBackupInput struct {

	// The ID of the file system to back up.
	//
	// This member is required.
	FileSystemId *string

	// (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure
	// idempotent creation. This string is automatically filled on your behalf when you
	// use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string

	// (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 action, no existing file system tags are copied from the file
	// system to the backup.
	Tags []types.Tag
}

The request object for the CreateBackup operation.

type CreateBackupOutput 

type CreateBackupOutput struct {

	// A description of the backup.
	Backup *types.Backup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for the CreateBackup operation.

type CreateDataRepositoryTaskInput 

type CreateDataRepositoryTaskInput struct {

	// The globally unique ID of the file system, assigned by Amazon FSx.
	//
	// This member is required.
	FileSystemId *string

	// 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
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html).
	//
	// This member is required.
	Report *types.CompletionReport

	// Specifies the type of data repository task to create.
	//
	// This member is required.
	Type types.DataRepositoryTaskType

	// (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 AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string

	// (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.
	Paths []string

	// A list of Tag values, with a maximum of 50 elements.
	Tags []types.Tag
}

type CreateDataRepositoryTaskOutput 

type CreateDataRepositoryTaskOutput struct {

	// The description of the data repository task that you just created.
	DataRepositoryTask *types.DataRepositoryTask

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateFileSystemFromBackupInput 

type CreateFileSystemFromBackupInput struct {

	// The ID of the backup. Specifies the backup to use if you're creating a file
	// system from an existing backup.
	//
	// This member is required.
	BackupId *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. For Windows SINGLE_AZ_1 and
	// SINGLE_AZ_2 deployment types and Lustre file systems, provide exactly one subnet
	// ID. The file server is launched in that subnet's Availability Zone.
	//
	// This member is required.
	SubnetIds []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
	// AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string

	// The Lustre configuration for the file system being created.
	LustreConfiguration *types.CreateFileSystemLustreConfiguration

	// 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.
	SecurityGroupIds []string

	// Sets the storage type for the Windows file system you're creating from a backup.
	// Valid values are SSD and HDD.
	//
	// * Set to SSD to use solid state drive storage.
	// Supported on all Windows deployment types.
	//
	// * Set to HDD to use hard disk drive
	// storage. Supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment
	// types.
	//
	// 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 only if the
	// original SSD file system had a storage capacity of at least 2000 GiB.
	StorageType types.StorageType

	// 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.
	Tags []types.Tag

	// The configuration for this Microsoft Windows file system.
	WindowsConfiguration *types.CreateFileSystemWindowsConfiguration
}

The request object for the CreateFileSystemFromBackup operation.

type CreateFileSystemFromBackupOutput 

type CreateFileSystemFromBackupOutput struct {

	// A description of the file system.
	FileSystem *types.FileSystem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for the CreateFileSystemFromBackup operation.

type CreateFileSystemInput 

type CreateFileSystemInput struct {

	// The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
	//
	// This member is required.
	FileSystemType types.FileSystemType

	// Sets the storage capacity of the file system that you're creating. For Lustre
	// file systems:
	//
	// * For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid
	// values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
	//
	// * For PERSISTENT 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.
	//
	// For Windows file systems:
	//
	// * If StorageType=SSD, valid values are
	// 32 GiB - 65,536 GiB (64 TiB).
	//
	// * If StorageType=HDD, valid values are 2000 GiB -
	// 65,536 GiB (64 TiB).
	//
	// This member is required.
	StorageCapacity *int32

	// 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. For Windows SINGLE_AZ_1 and
	// SINGLE_AZ_2 file system deployment types and Lustre file systems, provide
	// exactly one subnet ID. The file server is launched in that subnet's Availability
	// Zone.
	//
	// This member is required.
	SubnetIds []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
	// AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string

	// The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file
	// system's data for Amazon FSx for Windows File Server file systems and Amazon FSx
	// for Lustre PERSISTENT_1 file systems at rest. In either case, if not specified,
	// the Amazon FSx managed key is used. The Amazon FSx for Lustre SCRATCH_1 and
	// SCRATCH_2 file systems are always encrypted at rest using Amazon FSx managed
	// keys. For more information, see Encrypt
	// (https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the
	// AWS Key Management Service API Reference.
	KmsKeyId *string

	// The Lustre configuration for the file system being created.
	LustreConfiguration *types.CreateFileSystemLustreConfiguration

	// 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.
	SecurityGroupIds []string

	// Sets the storage type for the file system you're creating. Valid values are SSD
	// and HDD.
	//
	// * Set to SSD to use solid state drive storage. SSD is supported on all
	// Windows and Lustre 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 Lustre file system deployment
	// types.
	//
	// Default value is SSD. For more information, see  Storage Type Options
	// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options)
	// in the Amazon FSx for Windows User Guide and Multiple Storage Options
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options)
	// in the Amazon FSx for Lustre User Guide.
	StorageType types.StorageType

	// The tags to apply to the file system being created. The key value of the Name
	// tag appears in the console as the file system name.
	Tags []types.Tag

	// The Microsoft Windows configuration for the file system being created.
	WindowsConfiguration *types.CreateFileSystemWindowsConfiguration
}

The request object used to create a new Amazon FSx file system.

type CreateFileSystemOutput 

type CreateFileSystemOutput struct {

	// The configuration of the file system that was created.
	FileSystem *types.FileSystem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object returned after the file system is created.

type DeleteBackupInput 

type DeleteBackupInput struct {

	// The ID of the backup you want to delete.
	//
	// This member is required.
	BackupId *string

	// A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent
	// deletion. This is automatically filled on your behalf when using the AWS CLI or
	// SDK.
	ClientRequestToken *string
}

The request object for DeleteBackup operation.

type DeleteBackupOutput 

type DeleteBackupOutput struct {

	// The ID of the backup deleted.
	BackupId *string

	// The lifecycle of the backup. Should be DELETED.
	Lifecycle types.BackupLifecycle

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for DeleteBackup operation.

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

	// The ID of the file system you want to delete.
	//
	// This member is required.
	FileSystemId *string

	// A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent
	// deletion. This is automatically filled on your behalf when using the AWS CLI or
	// SDK.
	ClientRequestToken *string

	// The configuration object for the Amazon FSx for Lustre file system being deleted
	// in the DeleteFileSystem operation.
	LustreConfiguration *types.DeleteFileSystemLustreConfiguration

	// The configuration object for the Microsoft Windows file system used in the
	// DeleteFileSystem operation.
	WindowsConfiguration *types.DeleteFileSystemWindowsConfiguration
}

The request object for DeleteFileSystem operation.

type DeleteFileSystemOutput 

type DeleteFileSystemOutput struct {

	// The ID of the file system being deleted.
	FileSystemId *string

	// The file system lifecycle for the deletion request. Should be DELETING.
	Lifecycle types.FileSystemLifecycle

	// The response object for the Amazon FSx for Lustre file system being deleted in
	// the DeleteFileSystem operation.
	LustreResponse *types.DeleteFileSystemLustreResponse

	// The response object for the Microsoft Windows file system used in the
	// DeleteFileSystem operation.
	WindowsResponse *types.DeleteFileSystemWindowsResponse

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for the DeleteFileSystem operation.

type DescribeBackupsAPIClient added in v0.30.0 

type DescribeBackupsAPIClient interface {
	DescribeBackups(context.Context, *DescribeBackupsInput, ...func(*Options)) (*DescribeBackupsOutput, error)
}

DescribeBackupsAPIClient is a client that implements the DescribeBackups operation.

type DescribeBackupsInput 

type DescribeBackupsInput struct {

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

	// Filters structure. Supported names are file-system-id and backup-type.
	Filters []types.Filter

	// Maximum number of backups to return in the response (integer). This parameter
	// value must be greater than 0. The number of items that Amazon FSx returns is the
	// minimum of the MaxResults parameter specified in the request and the service's
	// internal maximum number of items per page.
	MaxResults *int32

	// Opaque pagination token returned from a previous DescribeBackups operation
	// (String). If a token present, the action continues the list from where the
	// returning call left off.
	NextToken *string
}

The request object for DescribeBackups operation.

type DescribeBackupsOutput 

type DescribeBackupsOutput struct {

	// Any array of backups.
	Backups []types.Backup

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response object for DescribeBackups operation.

type DescribeBackupsPaginator added in v0.30.0 

type DescribeBackupsPaginator struct {
	// contains filtered or unexported fields
}

DescribeBackupsPaginator is a paginator for DescribeBackups

func NewDescribeBackupsPaginator added in v0.30.0 

func NewDescribeBackupsPaginator(client DescribeBackupsAPIClient, params *DescribeBackupsInput, optFns ...func(*DescribeBackupsPaginatorOptions)) *DescribeBackupsPaginator

NewDescribeBackupsPaginator returns a new DescribeBackupsPaginator

func (*DescribeBackupsPaginator) HasMorePages added in v0.30.0 

func (p *DescribeBackupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeBackupsPaginator) NextPage added in v0.30.0 

func (p *DescribeBackupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBackupsOutput, error)

NextPage retrieves the next DescribeBackups page.

type DescribeBackupsPaginatorOptions added in v0.30.0 

type DescribeBackupsPaginatorOptions struct {
	// Maximum number of backups to return in the response (integer). This parameter
	// value must be greater than 0. The number of items that Amazon FSx returns is the
	// minimum of the MaxResults parameter specified in the request and the service's
	// internal maximum number of items per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeBackupsPaginatorOptions is the paginator options for DescribeBackups

type DescribeDataRepositoryTasksAPIClient added in v0.30.0 

type DescribeDataRepositoryTasksAPIClient interface {
	DescribeDataRepositoryTasks(context.Context, *DescribeDataRepositoryTasksInput, ...func(*Options)) (*DescribeDataRepositoryTasksOutput, error)
}

DescribeDataRepositoryTasksAPIClient is a client that implements the DescribeDataRepositoryTasks operation.

type DescribeDataRepositoryTasksInput 

type DescribeDataRepositoryTasksInput struct {

	// (Optional) You can use filters to narrow the DescribeDataRepositoryTasks
	// response to include just tasks for specific file systems, or tasks in a specific
	// lifecycle state.
	Filters []types.DataRepositoryTaskFilter

	// The maximum number of resources to return in the response. This value must be an
	// integer greater than zero.
	MaxResults *int32

	// (Optional) Opaque pagination token returned from a previous operation (String).
	// If present, this token indicates from what point you can continue processing the
	// request, where the previous NextToken value left off.
	NextToken *string

	// (Optional) IDs of the tasks whose descriptions you want to retrieve (String).
	TaskIds []string
}

type DescribeDataRepositoryTasksOutput 

type DescribeDataRepositoryTasksOutput struct {

	// The collection of data repository task descriptions returned.
	DataRepositoryTasks []types.DataRepositoryTask

	// (Optional) Opaque pagination token returned from a previous operation (String).
	// If present, this token indicates from what point you can continue processing the
	// request, where the previous NextToken value left off.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeDataRepositoryTasksPaginator added in v0.30.0 

type DescribeDataRepositoryTasksPaginator struct {
	// contains filtered or unexported fields
}

DescribeDataRepositoryTasksPaginator is a paginator for DescribeDataRepositoryTasks

func NewDescribeDataRepositoryTasksPaginator added in v0.30.0 

func NewDescribeDataRepositoryTasksPaginator(client DescribeDataRepositoryTasksAPIClient, params *DescribeDataRepositoryTasksInput, optFns ...func(*DescribeDataRepositoryTasksPaginatorOptions)) *DescribeDataRepositoryTasksPaginator

NewDescribeDataRepositoryTasksPaginator returns a new DescribeDataRepositoryTasksPaginator

func (*DescribeDataRepositoryTasksPaginator) HasMorePages added in v0.30.0 

func (p *DescribeDataRepositoryTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeDataRepositoryTasksPaginator) NextPage added in v0.30.0 

func (p *DescribeDataRepositoryTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDataRepositoryTasksOutput, error)

NextPage retrieves the next DescribeDataRepositoryTasks page.

type DescribeDataRepositoryTasksPaginatorOptions added in v0.30.0 

type DescribeDataRepositoryTasksPaginatorOptions struct {
	// The maximum number of resources to return in the response. This value must be an
	// integer greater than zero.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeDataRepositoryTasksPaginatorOptions is the paginator options for DescribeDataRepositoryTasks

type DescribeFileSystemAliasesAPIClient added in v0.30.0 

type DescribeFileSystemAliasesAPIClient interface {
	DescribeFileSystemAliases(context.Context, *DescribeFileSystemAliasesInput, ...func(*Options)) (*DescribeFileSystemAliasesOutput, error)
}

DescribeFileSystemAliasesAPIClient is a client that implements the DescribeFileSystemAliases operation.

type DescribeFileSystemAliasesInput added in v0.30.0 

type DescribeFileSystemAliasesInput struct {

	// The ID of the file system to return the associated DNS aliases for (String).
	//
	// This member is required.
	FileSystemId *string

	// (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 AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string

	// Maximum number of DNS aliases to return in the response (integer). This
	// parameter value must be greater than 0. The number of items that Amazon FSx
	// returns is the minimum of the MaxResults parameter specified in the request and
	// the service's internal maximum number of items per page.
	MaxResults *int32

	// Opaque pagination token returned from a previous DescribeFileSystemAliases
	// operation (String). If a token is included in the request, the action continues
	// the list from where the previous returning call left off.
	NextToken *string
}

The request object for DescribeFileSystemAliases operation.

type DescribeFileSystemAliasesOutput added in v0.30.0 

type DescribeFileSystemAliasesOutput struct {

	// An array of one or more DNS aliases currently associated with the specified file
	// system.
	Aliases []types.Alias

	// Present if there are more DNS aliases than returned in the response (String).
	// You can use the NextToken value in a later request to fetch additional
	// descriptions.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for DescribeFileSystemAliases operation.

type DescribeFileSystemAliasesPaginator added in v0.30.0 

type DescribeFileSystemAliasesPaginator struct {
	// contains filtered or unexported fields
}

DescribeFileSystemAliasesPaginator is a paginator for DescribeFileSystemAliases

func NewDescribeFileSystemAliasesPaginator added in v0.30.0 

func NewDescribeFileSystemAliasesPaginator(client DescribeFileSystemAliasesAPIClient, params *DescribeFileSystemAliasesInput, optFns ...func(*DescribeFileSystemAliasesPaginatorOptions)) *DescribeFileSystemAliasesPaginator

NewDescribeFileSystemAliasesPaginator returns a new DescribeFileSystemAliasesPaginator

func (*DescribeFileSystemAliasesPaginator) HasMorePages added in v0.30.0 

func (p *DescribeFileSystemAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeFileSystemAliasesPaginator) NextPage added in v0.30.0 

func (p *DescribeFileSystemAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeFileSystemAliasesOutput, error)

NextPage retrieves the next DescribeFileSystemAliases page.

type DescribeFileSystemAliasesPaginatorOptions added in v0.30.0 

type DescribeFileSystemAliasesPaginatorOptions struct {
	// Maximum number of DNS aliases to return in the response (integer). This
	// parameter value must be greater than 0. The number of items that Amazon FSx
	// returns is the minimum of the MaxResults parameter specified in the request and
	// the service's internal maximum number of items per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeFileSystemAliasesPaginatorOptions is the paginator options for DescribeFileSystemAliases

type DescribeFileSystemsAPIClient added in v0.30.0 

type DescribeFileSystemsAPIClient interface {
	DescribeFileSystems(context.Context, *DescribeFileSystemsInput, ...func(*Options)) (*DescribeFileSystemsOutput, error)
}

DescribeFileSystemsAPIClient is a client that implements the DescribeFileSystems operation.

type DescribeFileSystemsInput 

type DescribeFileSystemsInput struct {

	// IDs of the file systems whose descriptions you want to retrieve (String).
	FileSystemIds []string

	// Maximum number of file systems to return in the response (integer). This
	// parameter value must be greater than 0. The number of items that Amazon FSx
	// returns is the minimum of the MaxResults parameter specified in the request and
	// the service's internal maximum number of items per page.
	MaxResults *int32

	// Opaque pagination token returned from a previous DescribeFileSystems operation
	// (String). If a token present, the action continues the list from where the
	// returning call left off.
	NextToken *string
}

The request object for DescribeFileSystems operation.

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// An array of file system descriptions.
	FileSystems []types.FileSystem

	// Present if there are more file systems than returned in the response (String).
	// You can use the NextToken value in the later request to fetch the descriptions.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for DescribeFileSystems operation.

type DescribeFileSystemsPaginator added in v0.30.0 

type DescribeFileSystemsPaginator struct {
	// contains filtered or unexported fields
}

DescribeFileSystemsPaginator is a paginator for DescribeFileSystems

func NewDescribeFileSystemsPaginator added in v0.30.0 

func NewDescribeFileSystemsPaginator(client DescribeFileSystemsAPIClient, params *DescribeFileSystemsInput, optFns ...func(*DescribeFileSystemsPaginatorOptions)) *DescribeFileSystemsPaginator

NewDescribeFileSystemsPaginator returns a new DescribeFileSystemsPaginator

func (*DescribeFileSystemsPaginator) HasMorePages added in v0.30.0 

func (p *DescribeFileSystemsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeFileSystemsPaginator) NextPage added in v0.30.0 

func (p *DescribeFileSystemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeFileSystemsOutput, error)

NextPage retrieves the next DescribeFileSystems page.

type DescribeFileSystemsPaginatorOptions added in v0.30.0 

type DescribeFileSystemsPaginatorOptions struct {
	// Maximum number of file systems to return in the response (integer). This
	// parameter value must be greater than 0. The number of items that Amazon FSx
	// returns is the minimum of the MaxResults parameter specified in the request and
	// the service's internal maximum number of items per page.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeFileSystemsPaginatorOptions is the paginator options for DescribeFileSystems

type DisassociateFileSystemAliasesInput added in v0.30.0 

type DisassociateFileSystemAliasesInput struct {

	// An array of one or more DNS alias names to disassociate, or remove, from the
	// file system.
	//
	// This member is required.
	Aliases []string

	// Specifies the file system from which to disassociate the DNS aliases.
	//
	// This member is required.
	FileSystemId *string

	// (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 AWS Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string
}

The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.

type DisassociateFileSystemAliasesOutput added in v0.30.0 

type DisassociateFileSystemAliasesOutput struct {

	// An array of one or more DNS aliases that Amazon FSx is attempting to
	// disassociate from the file system.
	Aliases []types.Alias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the Amazon FSx resource that will have its tags listed.
	//
	// This member is required.
	ResourceARN *string

	// Maximum number of tags to return in the response (integer). This parameter value
	// must be greater than 0. The number of items that Amazon FSx returns is the
	// minimum of the MaxResults parameter specified in the request and the service's
	// internal maximum number of items per page.
	MaxResults *int32

	// Opaque pagination token returned from a previous ListTagsForResource operation
	// (String). If a token present, the action continues the list from where the
	// returning call left off.
	NextToken *string
}

The request object for ListTagsForResource operation.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

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

	// A list of tags on the resource.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for ListTagsForResource operation.

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.
	//
	// This member is required.
	ResourceARN *string

	// A list of tags for the resource. If a tag with a given key already exists, the
	// value is replaced by the one specified in this parameter.
	//
	// This member is required.
	Tags []types.Tag
}

The request object for the TagResource operation.

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for the TagResource operation.

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the Amazon FSx resource to untag.
	//
	// This member is required.
	ResourceARN *string

	// A list of keys of tags on the resource to untag. In case the tag key doesn't
	// exist, the call will still succeed to be idempotent.
	//
	// This member is required.
	TagKeys []string
}

The request object for UntagResource action.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for UntagResource action.

type UpdateFileSystemInput 

type UpdateFileSystemInput struct {

	// Identifies the file system that you are updating.
	//
	// This member is required.
	FileSystemId *string

	// A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent
	// updates. This string is automatically filled on your behalf when you use the AWS
	// Command Line Interface (AWS CLI) or an AWS SDK.
	ClientRequestToken *string

	// The configuration object for Amazon FSx for Lustre file systems used in the
	// UpdateFileSystem operation.
	LustreConfiguration *types.UpdateFileSystemLustreConfiguration

	// Use this parameter to increase the storage capacity of an Amazon FSx file
	// system. Specifies the storage capacity target value, GiB, to increase the
	// storage capacity for the file system that you're updating. You cannot make a
	// storage capacity increase request if there is an existing storage capacity
	// increase request in progress. For Windows file systems, the storage capacity
	// target value must be at least 10 percent (%) greater than the current storage
	// capacity value. In order to increase storage capacity, the file system must have
	// at least 16 MB/s of throughput capacity. For Lustre file systems, the storage
	// capacity target value can be the following:
	//
	// * For SCRATCH_2 and PERSISTENT_1
	// SSD deployment types, valid values are in multiples of 2400 GiB. The value must
	// be greater than the current storage capacity.
	//
	// * For PERSISTENT HDD file
	// systems, valid values are multiples of 6000 GiB for 12 MB/s/TiB file systems and
	// multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater
	// than the current storage capacity.
	//
	// * For SCRATCH_1 file systems, you cannot
	// increase the storage capacity.
	//
	// For more information, see Managing storage
	// capacity
	// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html)
	// in the Amazon FSx for Windows File Server User Guide and Managing storage and
	// throughput capacity
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html)
	// in the Amazon FSx for Lustre User Guide.
	StorageCapacity *int32

	// The configuration updates for an Amazon FSx for Windows File Server file system.
	WindowsConfiguration *types.UpdateFileSystemWindowsConfiguration
}

The request object for the UpdateFileSystem operation.

type UpdateFileSystemOutput 

type UpdateFileSystemOutput struct {

	// A description of the file system that was updated.
	FileSystem *types.FileSystem

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response object for the UpdateFileSystem operation.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.