fsx

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 31

Documentation

Overview

Package fsx provides the client and types for making API requests to 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.

See https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01 for more information on this service.

See fsx package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/fsx/

Using the Client

To use Amazon FSx with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon FSx client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/fsx/#New

Index

Examples

Constants

View Source 
const (
	ServiceName = "Amazon FSx" // Service's name
	ServiceID   = "FSx"        // Service's identifier
	EndpointsID = "fsx"        // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeActiveDirectoryError for service response error code
	// "ActiveDirectoryError".
	//
	// An Active Directory error.
	ErrCodeActiveDirectoryError = "ActiveDirectoryError"

	// ErrCodeBackupInProgress for service response error code
	// "BackupInProgress".
	//
	// Another backup is already under way. Wait for completion before initiating
	// additional backups of this file system.
	ErrCodeBackupInProgress = "BackupInProgress"

	// ErrCodeBackupNotFound for service response error code
	// "BackupNotFound".
	//
	// No Amazon FSx backups were found based upon the supplied parameters.
	ErrCodeBackupNotFound = "BackupNotFound"

	// ErrCodeBackupRestoring for service response error code
	// "BackupRestoring".
	//
	// You can't delete a backup while it's being used to restore a file system.
	ErrCodeBackupRestoring = "BackupRestoring"

	// ErrCodeBadRequest for service response error code
	// "BadRequest".
	//
	// A generic error indicating a failure with a client request.
	ErrCodeBadRequest = "BadRequest"

	// ErrCodeDataRepositoryTaskEnded for service response error code
	// "DataRepositoryTaskEnded".
	//
	// The data repository task could not be canceled because the task has already
	// ended.
	ErrCodeDataRepositoryTaskEnded = "DataRepositoryTaskEnded"

	// ErrCodeDataRepositoryTaskExecuting for service response error code
	// "DataRepositoryTaskExecuting".
	//
	// An existing data repository task is currently executing on the file system.
	// Wait until the existing task has completed, then create the new task.
	ErrCodeDataRepositoryTaskExecuting = "DataRepositoryTaskExecuting"

	// ErrCodeDataRepositoryTaskNotFound for service response error code
	// "DataRepositoryTaskNotFound".
	//
	// The data repository task or tasks you specified could not be found.
	ErrCodeDataRepositoryTaskNotFound = "DataRepositoryTaskNotFound"

	// ErrCodeFileSystemNotFound for service response error code
	// "FileSystemNotFound".
	//
	// No Amazon FSx file systems were found based upon supplied parameters.
	ErrCodeFileSystemNotFound = "FileSystemNotFound"

	// ErrCodeIncompatibleParameterError for service response error code
	// "IncompatibleParameterError".
	//
	// The error returned when a second request is received with the same client
	// request token but different parameters settings. A client request token should
	// always uniquely identify a single request.
	ErrCodeIncompatibleParameterError = "IncompatibleParameterError"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// A generic error indicating a server-side failure.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidExportPath for service response error code
	// "InvalidExportPath".
	//
	// The path provided for data repository export isn't valid.
	ErrCodeInvalidExportPath = "InvalidExportPath"

	// ErrCodeInvalidImportPath for service response error code
	// "InvalidImportPath".
	//
	// The path provided for data repository import isn't valid.
	ErrCodeInvalidImportPath = "InvalidImportPath"

	// ErrCodeInvalidNetworkSettings for service response error code
	// "InvalidNetworkSettings".
	//
	// One or more network settings specified in the request are invalid. InvalidVpcId
	// means that the ID passed for the virtual private cloud (VPC) is invalid.
	// InvalidSubnetIds returns the list of IDs for subnets that are either invalid
	// or not part of the VPC specified. InvalidSecurityGroupIds returns the list
	// of IDs for security groups that are either invalid or not part of the VPC
	// specified.
	ErrCodeInvalidNetworkSettings = "InvalidNetworkSettings"

	// ErrCodeInvalidPerUnitStorageThroughput for service response error code
	// "InvalidPerUnitStorageThroughput".
	//
	// An invalid value for PerUnitStorageThroughput was provided. Please create
	// your file system again, using a valid value.
	ErrCodeInvalidPerUnitStorageThroughput = "InvalidPerUnitStorageThroughput"

	// ErrCodeMissingFileSystemConfiguration for service response error code
	// "MissingFileSystemConfiguration".
	//
	// A file system configuration is required for this operation.
	ErrCodeMissingFileSystemConfiguration = "MissingFileSystemConfiguration"

	// ErrCodeNotServiceResourceError for service response error code
	// "NotServiceResourceError".
	//
	// The resource specified for the tagging operation is not a resource type owned
	// by Amazon FSx. Use the API of the relevant service to perform the operation.
	ErrCodeNotServiceResourceError = "NotServiceResourceError"

	// ErrCodeResourceDoesNotSupportTagging for service response error code
	// "ResourceDoesNotSupportTagging".
	//
	// The resource specified does not support tagging.
	ErrCodeResourceDoesNotSupportTagging = "ResourceDoesNotSupportTagging"

	// ErrCodeResourceNotFound for service response error code
	// "ResourceNotFound".
	//
	// The resource specified by the Amazon Resource Name (ARN) can't be found.
	ErrCodeResourceNotFound = "ResourceNotFound"

	// ErrCodeServiceLimitExceeded for service response error code
	// "ServiceLimitExceeded".
	//
	// An error indicating that a particular service limit was exceeded. You can
	// increase some service limits by contacting AWS Support.
	ErrCodeServiceLimitExceeded = "ServiceLimitExceeded"

	// ErrCodeUnsupportedOperation for service response error code
	// "UnsupportedOperation".
	//
	// The requested operation is not supported for this resource or API.
	ErrCodeUnsupportedOperation = "UnsupportedOperation"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveDirectoryBackupAttributes added in v0.10.0 

type ActiveDirectoryBackupAttributes struct {

	// The ID of the AWS Managed Microsoft Active Directory instance to which the
	// file system is joined.
	ActiveDirectoryId *string `min:"12" type:"string"`

	// The fully qualified domain name of the self-managed AD directory.
	DomainName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.

func (ActiveDirectoryBackupAttributes) String added in v0.10.0 

func (s ActiveDirectoryBackupAttributes) String() string

String returns the string representation

type ActiveDirectoryErrorType 

type ActiveDirectoryErrorType string

The type of error relating to Microsoft Active Directory. NOT_FOUND means that no directory was found by specifying the given directory. INCOMPATIBLE_MODE means that the directory specified is not a Microsoft AD directory. WRONG_VPC means that the specified directory isn't accessible from the specified VPC. WRONG_STAGE means that the specified directory isn't currently in the ACTIVE state. 

const (
	ActiveDirectoryErrorTypeDomainNotFound         ActiveDirectoryErrorType = "DOMAIN_NOT_FOUND"
	ActiveDirectoryErrorTypeIncompatibleDomainMode ActiveDirectoryErrorType = "INCOMPATIBLE_DOMAIN_MODE"
	ActiveDirectoryErrorTypeWrongVpc               ActiveDirectoryErrorType = "WRONG_VPC"
	ActiveDirectoryErrorTypeInvalidDomainStage     ActiveDirectoryErrorType = "INVALID_DOMAIN_STAGE"
)

Enum values for ActiveDirectoryErrorType

func (ActiveDirectoryErrorType) MarshalValue 

func (enum ActiveDirectoryErrorType) MarshalValue() (string, error)

func (ActiveDirectoryErrorType) MarshalValueBuf 

func (enum ActiveDirectoryErrorType) MarshalValueBuf(b []byte) ([]byte, error)

type AdministrativeAction added in v0.24.0 

type AdministrativeAction struct {

	// Describes the type of administrative action, as follows:
	//
	//    * FILE_SYSTEM_UPDATE - A file system update administrative action initiated
	//    by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI
	//    (update-file-system). A
	//
	//    * STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase
	//    a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION
	//    task starts. Storage optimization is the process of migrating the file
	//    system data to the new, larger disks. You can track the storage migration
	//    progress using the ProgressPercent property. When STORAGE_OPTIMIZATION
	//    completes successfully, the parent FILE_SYSTEM_UPDATE action status changes
	//    to COMPLETED. For more information, see Managing Storage Capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html).
	AdministrativeActionType AdministrativeActionType `type:"string" enum:"true"`

	// Provides information about a failed administrative action.
	FailureDetails *AdministrativeActionFailureDetails `type:"structure"`

	// Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.
	ProgressPercent *int64 `type:"integer"`

	// Time that the administrative action request was received.
	RequestTime *time.Time `type:"timestamp"`

	// Describes the status of the administrative action, as follows:
	//
	//    * FAILED - Amazon FSx failed to process the administrative action successfully.
	//
	//    * IN_PROGRESS - Amazon FSx is processing the administrative action.
	//
	//    * PENDING - Amazon FSx is waiting to process the administrative action.
	//
	//    * COMPLETED - Amazon FSx has finished processing the administrative task.
	//
	//    * UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon
	//    FSx has updated the file system with the new storage capacity, and is
	//    now performing the storage optimization process. For more information,
	//    see Managing Storage Capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html).
	Status Status `type:"string" enum:"true"`

	// Describes the target StorageCapacity or ThroughputCapacity value provided
	// in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative
	// actions.
	TargetFileSystemValues *FileSystem `type:"structure"`
	// contains filtered or unexported fields
}

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

func (AdministrativeAction) String added in v0.24.0 

func (s AdministrativeAction) String() string

String returns the string representation

type AdministrativeActionFailureDetails added in v0.24.0 

type AdministrativeActionFailureDetails struct {

	// Error message providing details about the failure.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about a failed administrative action.

func (AdministrativeActionFailureDetails) String added in v0.24.0 

func (s AdministrativeActionFailureDetails) String() string

String returns the string representation

type AdministrativeActionType added in v0.24.0 

type AdministrativeActionType string

Describes the type of administrative action, as follows:

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

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts. Storage optimization is the process of migrating the file system data to the new, larger disks. You can track the storage migration progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing Storage Capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html). 

const (
	AdministrativeActionTypeFileSystemUpdate    AdministrativeActionType = "FILE_SYSTEM_UPDATE"
	AdministrativeActionTypeStorageOptimization AdministrativeActionType = "STORAGE_OPTIMIZATION"
)

Enum values for AdministrativeActionType

func (AdministrativeActionType) MarshalValue added in v0.24.0 

func (enum AdministrativeActionType) MarshalValue() (string, error)

func (AdministrativeActionType) MarshalValueBuf added in v0.24.0 

func (enum AdministrativeActionType) MarshalValueBuf(b []byte) ([]byte, error)

type Backup 

type Backup struct {

	// The ID of the backup.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// The time when a particular backup was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The configuration of the self-managed Microsoft Active Directory (AD) to
	// which the Windows File Server instance is joined.
	DirectoryInformation *ActiveDirectoryBackupAttributes `type:"structure"`

	// Details explaining any failures that occur when creating a backup.
	FailureDetails *BackupFailureDetails `type:"structure"`

	// Metadata of the file system associated with the backup. This metadata is
	// persisted even if the file system is deleted.
	//
	// FileSystem is a required field
	FileSystem *FileSystem `type:"structure" required:"true"`

	// The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this
	// backup of the Amazon FSx for Windows file system's data at rest. Amazon FSx
	// for Lustre does not support KMS encryption.
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle status of the backup.
	//
	// Lifecycle is a required field
	Lifecycle BackupLifecycle `type:"string" required:"true" enum:"true"`

	// The current percent of progress of an asynchronous task.
	ProgressPercent *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) for the backup resource.
	ResourceARN *string `min:"8" type:"string"`

	// Tags associated with a particular file system.
	Tags []Tag `min:"1" type:"list"`

	// The type of the backup.
	//
	// Type is a required field
	Type BackupType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A backup of an Amazon FSx for file system.

func (Backup) String 

func (s Backup) String() string

String returns the string representation

type BackupFailureDetails 

type BackupFailureDetails struct {

	// A message describing the backup creation failure.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

If backup creation fails, this structure contains the details of that failure.

func (BackupFailureDetails) String 

func (s BackupFailureDetails) String() string

String returns the string representation

type BackupLifecycle 

type BackupLifecycle string

The lifecycle status of the backup. 

const (
	BackupLifecycleAvailable BackupLifecycle = "AVAILABLE"
	BackupLifecycleCreating  BackupLifecycle = "CREATING"
	BackupLifecycleDeleted   BackupLifecycle = "DELETED"
	BackupLifecycleFailed    BackupLifecycle = "FAILED"
)

Enum values for BackupLifecycle

func (BackupLifecycle) MarshalValue 

func (enum BackupLifecycle) MarshalValue() (string, error)

func (BackupLifecycle) MarshalValueBuf 

func (enum BackupLifecycle) MarshalValueBuf(b []byte) ([]byte, error)

type BackupType 

type BackupType string

The type of the backup. 

const (
	BackupTypeAutomatic     BackupType = "AUTOMATIC"
	BackupTypeUserInitiated BackupType = "USER_INITIATED"
)

Enum values for BackupType

func (BackupType) MarshalValue 

func (enum BackupType) MarshalValue() (string, error)

func (BackupType) MarshalValueBuf 

func (enum BackupType) MarshalValueBuf(b []byte) ([]byte, error)

type CancelDataRepositoryTaskInput added in v0.19.0 

type CancelDataRepositoryTaskInput struct {

	// Specifies the data repository task to cancel.
	//
	// TaskId is a required field
	TaskId *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Cancels a data repository task.

func (CancelDataRepositoryTaskInput) String added in v0.19.0 

func (s CancelDataRepositoryTaskInput) String() string

String returns the string representation

func (*CancelDataRepositoryTaskInput) Validate added in v0.19.0 

func (s *CancelDataRepositoryTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelDataRepositoryTaskOutput added in v0.19.0 

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 DataRepositoryTaskLifecycle `type:"string" enum:"true"`

	// The ID of the task being canceled.
	TaskId *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (CancelDataRepositoryTaskOutput) String added in v0.19.0 

func (s CancelDataRepositoryTaskOutput) String() string

String returns the string representation

type CancelDataRepositoryTaskRequest added in v0.19.0 

type CancelDataRepositoryTaskRequest struct {
	*aws.Request
	Input *CancelDataRepositoryTaskInput
	Copy  func(*CancelDataRepositoryTaskInput) CancelDataRepositoryTaskRequest
}

CancelDataRepositoryTaskRequest is the request type for the CancelDataRepositoryTask API operation.

func (CancelDataRepositoryTaskRequest) Send added in v0.19.0 

func (r CancelDataRepositoryTaskRequest) Send(ctx context.Context) (*CancelDataRepositoryTaskResponse, error)

Send marshals and sends the CancelDataRepositoryTask API request.

type CancelDataRepositoryTaskResponse added in v0.19.0 

type CancelDataRepositoryTaskResponse struct {
	*CancelDataRepositoryTaskOutput
	// contains filtered or unexported fields
}

CancelDataRepositoryTaskResponse is the response type for the CancelDataRepositoryTask API operation.

func (*CancelDataRepositoryTaskResponse) SDKResponseMetdata added in v0.19.0 

func (r *CancelDataRepositoryTaskResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CancelDataRepositoryTask request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon FSx. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := fsx.New(myConfig)

func (*Client) CancelDataRepositoryTaskRequest added in v0.19.0 

func (c *Client) CancelDataRepositoryTaskRequest(input *CancelDataRepositoryTaskInput) CancelDataRepositoryTaskRequest

CancelDataRepositoryTaskRequest returns a request value for making API operation for Amazon FSx.

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.

    // Example sending a request using CancelDataRepositoryTaskRequest. req := client.CancelDataRepositoryTaskRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CancelDataRepositoryTask

func (*Client) CreateBackupRequest added in v0.9.0 

func (c *Client) CreateBackupRequest(input *CreateBackupInput) CreateBackupRequest

CreateBackupRequest returns a request value for making API operation for Amazon FSx.

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 an Amazon S3 data respository.

For more information, see https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-backups.html (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-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. 

// Example sending a request using CreateBackupRequest.
req := client.CreateBackupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackup

Example (Shared00)

To create a new backup

This operation creates a new backup. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.CreateBackupInput{
		FileSystemId: aws.String("fs-0498eed5fe91001ec"),
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyBackup"),
			},
		},
	}

	req := svc.CreateBackupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeUnsupportedOperation:
				fmt.Println(fsx.ErrCodeUnsupportedOperation, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeBackupInProgress:
				fmt.Println(fsx.ErrCodeBackupInProgress, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CreateDataRepositoryTaskRequest added in v0.19.0 

func (c *Client) CreateDataRepositoryTaskRequest(input *CreateDataRepositoryTaskInput) CreateDataRepositoryTaskRequest

CreateDataRepositoryTaskRequest returns a request value for making API operation for Amazon FSx.

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 Using 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 Setting the Export Prefix (https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repository.html#export-prefix). 

// Example sending a request using CreateDataRepositoryTaskRequest.
req := client.CreateDataRepositoryTaskRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateDataRepositoryTask

func (*Client) CreateFileSystemFromBackupRequest added in v0.9.0 

func (c *Client) CreateFileSystemFromBackupRequest(input *CreateFileSystemFromBackupInput) CreateFileSystemFromBackupRequest

CreateFileSystemFromBackupRequest returns a request value for making API operation for Amazon FSx.

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. 

// Example sending a request using CreateFileSystemFromBackupRequest.
req := client.CreateFileSystemFromBackupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackup

Example (Shared00)

To create a new file system from backup

This operation creates a new file system from backup. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.CreateFileSystemFromBackupInput{
		BackupId:           aws.String("backup-03e3c82e0183b7b6b"),
		ClientRequestToken: aws.String("f4c94ed7-238d-4c46-93db-48cd62ec33b7"),
		SecurityGroupIds: []string{
			"sg-edcd9784",
		},
		SubnetIds: []string{
			"subnet-1234abcd",
		},
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
		WindowsConfiguration: &fsx.CreateFileSystemWindowsConfiguration{
			ThroughputCapacity: aws.Int64(8),
		},
	}

	req := svc.CreateFileSystemFromBackupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeActiveDirectoryError:
				fmt.Println(fsx.ErrCodeActiveDirectoryError, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInvalidNetworkSettings:
				fmt.Println(fsx.ErrCodeInvalidNetworkSettings, aerr.Error())
			case fsx.ErrCodeInvalidPerUnitStorageThroughput:
				fmt.Println(fsx.ErrCodeInvalidPerUnitStorageThroughput, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) CreateFileSystemRequest added in v0.9.0 

func (c *Client) CreateFileSystemRequest(input *CreateFileSystemInput) CreateFileSystemRequest

CreateFileSystemRequest returns a request value for making API operation for Amazon FSx.

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. 

// Example sending a request using CreateFileSystemRequest.
req := client.CreateFileSystemRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystem

Example (Shared00)

To create a new file system

This operation creates a new file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.CreateFileSystemInput{
		ClientRequestToken: aws.String("a8ca07e4-61ec-4399-99f4-19853801bcd5"),
		FileSystemType:     fsx.FileSystemTypeWindows,
		KmsKeyId:           aws.String("arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6"),
		SecurityGroupIds: []string{
			"sg-edcd9784",
		},
		StorageCapacity: aws.Int64(300),
		SubnetIds: []string{
			"subnet-1234abcd",
		},
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
		WindowsConfiguration: &fsx.CreateFileSystemWindowsConfiguration{
			ActiveDirectoryId:             aws.String("d-1234abcd12"),
			AutomaticBackupRetentionDays:  aws.Int64(30),
			DailyAutomaticBackupStartTime: aws.String("05:00"),
			ThroughputCapacity:            aws.Int64(8),
			WeeklyMaintenanceStartTime:    aws.String("1:05:00"),
		},
	}

	req := svc.CreateFileSystemRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeActiveDirectoryError:
				fmt.Println(fsx.ErrCodeActiveDirectoryError, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInvalidImportPath:
				fmt.Println(fsx.ErrCodeInvalidImportPath, aerr.Error())
			case fsx.ErrCodeInvalidExportPath:
				fmt.Println(fsx.ErrCodeInvalidExportPath, aerr.Error())
			case fsx.ErrCodeInvalidNetworkSettings:
				fmt.Println(fsx.ErrCodeInvalidNetworkSettings, aerr.Error())
			case fsx.ErrCodeInvalidPerUnitStorageThroughput:
				fmt.Println(fsx.ErrCodeInvalidPerUnitStorageThroughput, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DeleteBackupRequest added in v0.9.0 

func (c *Client) DeleteBackupRequest(input *DeleteBackupInput) DeleteBackupRequest

DeleteBackupRequest returns a request value for making API operation for Amazon FSx.

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. 

// Example sending a request using DeleteBackupRequest.
req := client.DeleteBackupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackup

Example (Shared00)

To delete a backup

This operation deletes an Amazon FSx file system backup. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DeleteBackupInput{
		BackupId: aws.String("backup-03e3c82e0183b7b6b"),
	}

	req := svc.DeleteBackupRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeBackupInProgress:
				fmt.Println(fsx.ErrCodeBackupInProgress, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeBackupRestoring:
				fmt.Println(fsx.ErrCodeBackupRestoring, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DeleteFileSystemRequest added in v0.9.0 

func (c *Client) DeleteFileSystemRequest(input *DeleteFileSystemInput) DeleteFileSystemRequest

DeleteFileSystemRequest returns a request value for making API operation for Amazon FSx.

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. 

// Example sending a request using DeleteFileSystemRequest.
req := client.DeleteFileSystemRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystem

Example (Shared00)

To delete a file system

This operation deletes an Amazon FSx file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DeleteFileSystemInput{
		FileSystemId: aws.String("fs-0498eed5fe91001ec"),
	}

	req := svc.DeleteFileSystemRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeBackupsRequest added in v0.9.0 

func (c *Client) DescribeBackupsRequest(input *DescribeBackupsInput) DescribeBackupsRequest

DescribeBackupsRequest returns a request value for making API operation for Amazon FSx.

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.

    // Example sending a request using DescribeBackupsRequest. req := client.DescribeBackupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackups

Example (Shared00)

To describe Amazon FSx backups

This operation describes all of the Amazon FSx backups in an account. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DescribeBackupsInput{}

	req := svc.DescribeBackupsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) DescribeDataRepositoryTasksRequest added in v0.19.0 

func (c *Client) DescribeDataRepositoryTasksRequest(input *DescribeDataRepositoryTasksInput) DescribeDataRepositoryTasksRequest

DescribeDataRepositoryTasksRequest returns a request value for making API operation for Amazon FSx.

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. 

// Example sending a request using DescribeDataRepositoryTasksRequest.
req := client.DescribeDataRepositoryTasksRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeDataRepositoryTasks

func (*Client) DescribeFileSystemsRequest added in v0.9.0 

func (c *Client) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) DescribeFileSystemsRequest

DescribeFileSystemsRequest returns a request value for making API operation for Amazon FSx.

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.

    // Example sending a request using DescribeFileSystemsRequest. req := client.DescribeFileSystemsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystems

Example (Shared00)

To describe an Amazon FSx file system

This operation describes all of the Amazon FSx file systems in an account. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.DescribeFileSystemsInput{}

	req := svc.DescribeFileSystemsRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon FSx.

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.

    // Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResource

Example (Shared00)

To list tags for a resource

This operation lists tags for an Amazon FSx resource. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.ListTagsForResourceInput{
		ResourceARN: aws.String("arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"),
	}

	req := svc.ListTagsForResourceRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeResourceNotFound:
				fmt.Println(fsx.ErrCodeResourceNotFound, aerr.Error())
			case fsx.ErrCodeNotServiceResourceError:
				fmt.Println(fsx.ErrCodeNotServiceResourceError, aerr.Error())
			case fsx.ErrCodeResourceDoesNotSupportTagging:
				fmt.Println(fsx.ErrCodeResourceDoesNotSupportTagging, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon FSx.

Tags an Amazon FSx resource. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResource

Example (Shared00)

To tag a resource

This operation tags an Amazon FSx resource. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.TagResourceInput{
		ResourceARN: aws.String("arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"),
		Tags: []fsx.Tag{
			{
				Key:   aws.String("Name"),
				Value: aws.String("MyFileSystem"),
			},
		},
	}

	req := svc.TagResourceRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeResourceNotFound:
				fmt.Println(fsx.ErrCodeResourceNotFound, aerr.Error())
			case fsx.ErrCodeNotServiceResourceError:
				fmt.Println(fsx.ErrCodeNotServiceResourceError, aerr.Error())
			case fsx.ErrCodeResourceDoesNotSupportTagging:
				fmt.Println(fsx.ErrCodeResourceDoesNotSupportTagging, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon FSx.

This action removes a tag from an Amazon FSx resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResource

Example (Shared00)

To untag a resource

This operation untags an Amazon FSx resource. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.UntagResourceInput{
		ResourceARN: aws.String("arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"),
		TagKeys: []string{
			"Name",
		},
	}

	req := svc.UntagResourceRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeResourceNotFound:
				fmt.Println(fsx.ErrCodeResourceNotFound, aerr.Error())
			case fsx.ErrCodeNotServiceResourceError:
				fmt.Println(fsx.ErrCodeNotServiceResourceError, aerr.Error())
			case fsx.ErrCodeResourceDoesNotSupportTagging:
				fmt.Println(fsx.ErrCodeResourceDoesNotSupportTagging, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*Client) UpdateFileSystemRequest added in v0.9.0 

func (c *Client) UpdateFileSystemRequest(input *UpdateFileSystemInput) UpdateFileSystemRequest

UpdateFileSystemRequest returns a request value for making API operation for Amazon FSx.

Use this operation to update the configuration of an existing Amazon FSx file system. For an Amazon FSx for Lustre file system, you can update only the WeeklyMaintenanceStartTime. For an Amazon for Windows File Server file system, you can update the following properties:

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • SelfManagedActiveDirectoryConfiguration

  • StorageCapacity

  • ThroughputCapacity

  • WeeklyMaintenanceStartTime

You can update multiple properties in a single request. 

// Example sending a request using UpdateFileSystemRequest.
req := client.UpdateFileSystemRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystem

Example (Shared00)

To update an existing file system

This operation updates an existing file system. 

package main

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/awserr"
	"github.com/aws/aws-sdk-go-v2/aws/external"
	"github.com/aws/aws-sdk-go-v2/service/fsx"
)

func main() {
	cfg, err := external.LoadDefaultAWSConfig()
	if err != nil {
		panic("failed to load config, " + err.Error())
	}

	svc := fsx.New(cfg)
	input := &fsx.UpdateFileSystemInput{
		FileSystemId: aws.String("fs-0498eed5fe91001ec"),
		WindowsConfiguration: &fsx.UpdateFileSystemWindowsConfiguration{
			AutomaticBackupRetentionDays:  aws.Int64(10),
			DailyAutomaticBackupStartTime: aws.String("06:00"),
			WeeklyMaintenanceStartTime:    aws.String("3:06:00"),
		},
	}

	req := svc.UpdateFileSystemRequest(input)
	result, err := req.Send(context.Background())
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case fsx.ErrCodeBadRequest:
				fmt.Println(fsx.ErrCodeBadRequest, aerr.Error())
			case fsx.ErrCodeUnsupportedOperation:
				fmt.Println(fsx.ErrCodeUnsupportedOperation, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeFileSystemNotFound:
				fmt.Println(fsx.ErrCodeFileSystemNotFound, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

type CompletionReport added in v0.19.0 

type CompletionReport struct {

	// Set Enabled to True to generate a CompletionReport when the task completes.
	// If set to true, then you need to provide a report Scope, Path, and Format.
	// Set Enabled to False if you do not want a CompletionReport generated when
	// the task completes.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// Required if Enabled is set to true. Specifies the format of the CompletionReport.
	// REPORT_CSV_20191124 is the only format currently supported. When Format is
	// set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format,
	// and is delivered to {path}/task-{id}/failures.csv.
	Format ReportFormat `type:"string" enum:"true"`

	// Required if Enabled is set to true. Specifies the location of the report
	// on the file system's linked S3 data repository. An absolute path that defines
	// where the completion report will be stored in the destination location. The
	// Path you provide must be located within the file system’s ExportPath. An
	// example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report
	// provides the following information for each file in the report: FilePath,
	// FileStatus, and ErrorCode. To learn more about a file system's ExportPath,
	// see .
	Path *string `min:"3" type:"string"`

	// Required if Enabled is set to true. Specifies the scope of the CompletionReport;
	// FAILED_FILES_ONLY is the only scope currently supported. When Scope is set
	// to FAILED_FILES_ONLY, the CompletionReport only contains information about
	// files that the data repository task failed to process.
	Scope ReportScope `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

func (CompletionReport) String added in v0.19.0 

func (s CompletionReport) String() string

String returns the string representation

func (*CompletionReport) Validate added in v0.19.0 

func (s *CompletionReport) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBackupInput 

type CreateBackupInput struct {

	// 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 `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the file system to back up.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// 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 tags on the file system are copied from the file system to the
	// backup.
	Tags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The request object for the CreateBackup operation.

func (CreateBackupInput) String 

func (s CreateBackupInput) String() string

String returns the string representation

func (*CreateBackupInput) Validate 

func (s *CreateBackupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBackupOutput 

type CreateBackupOutput struct {

	// A description of the backup.
	Backup *Backup `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the CreateBackup operation.

func (CreateBackupOutput) String 

func (s CreateBackupOutput) String() string

String returns the string representation

type CreateBackupRequest 

type CreateBackupRequest struct {
	*aws.Request
	Input *CreateBackupInput
	Copy  func(*CreateBackupInput) CreateBackupRequest
}

CreateBackupRequest is the request type for the CreateBackup API operation.

func (CreateBackupRequest) Send 

func (r CreateBackupRequest) Send(ctx context.Context) (*CreateBackupResponse, error)

Send marshals and sends the CreateBackup API request.

type CreateBackupResponse added in v0.9.0 

type CreateBackupResponse struct {
	*CreateBackupOutput
	// contains filtered or unexported fields
}

CreateBackupResponse is the response type for the CreateBackup API operation.

func (*CreateBackupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateBackup request.

type CreateDataRepositoryTaskInput added in v0.19.0 

type CreateDataRepositoryTaskInput struct {

	// (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 `min:"1" type:"string" idempotencyToken:"true"`

	// The globally unique ID of the file system, assigned by Amazon FSx.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// (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 `type:"list"`

	// 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).
	//
	// Report is a required field
	Report *CompletionReport `type:"structure" required:"true"`

	// A list of Tag values, with a maximum of 50 elements.
	Tags []Tag `min:"1" type:"list"`

	// Specifies the type of data repository task to create.
	//
	// Type is a required field
	Type DataRepositoryTaskType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (CreateDataRepositoryTaskInput) String added in v0.19.0 

func (s CreateDataRepositoryTaskInput) String() string

String returns the string representation

func (*CreateDataRepositoryTaskInput) Validate added in v0.19.0 

func (s *CreateDataRepositoryTaskInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDataRepositoryTaskOutput added in v0.19.0 

type CreateDataRepositoryTaskOutput struct {

	// The description of the data repository task that you just created.
	DataRepositoryTask *DataRepositoryTask `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDataRepositoryTaskOutput) String added in v0.19.0 

func (s CreateDataRepositoryTaskOutput) String() string

String returns the string representation

type CreateDataRepositoryTaskRequest added in v0.19.0 

type CreateDataRepositoryTaskRequest struct {
	*aws.Request
	Input *CreateDataRepositoryTaskInput
	Copy  func(*CreateDataRepositoryTaskInput) CreateDataRepositoryTaskRequest
}

CreateDataRepositoryTaskRequest is the request type for the CreateDataRepositoryTask API operation.

func (CreateDataRepositoryTaskRequest) Send added in v0.19.0 

func (r CreateDataRepositoryTaskRequest) Send(ctx context.Context) (*CreateDataRepositoryTaskResponse, error)

Send marshals and sends the CreateDataRepositoryTask API request.

type CreateDataRepositoryTaskResponse added in v0.19.0 

type CreateDataRepositoryTaskResponse struct {
	*CreateDataRepositoryTaskOutput
	// contains filtered or unexported fields
}

CreateDataRepositoryTaskResponse is the response type for the CreateDataRepositoryTask API operation.

func (*CreateDataRepositoryTaskResponse) SDKResponseMetdata added in v0.19.0 

func (r *CreateDataRepositoryTaskResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDataRepositoryTask request.

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.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// 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 `min:"1" type:"string" idempotencyToken:"true"`

	// The Lustre configuration for the file system being created.
	LustreConfiguration *CreateFileSystemLustreConfiguration `type:"structure"`

	// 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 `type:"list"`

	// 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 StorageType `type:"string" enum:"true"`

	// 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.
	//
	// SubnetIds is a required field
	SubnetIds []string `type:"list" required:"true"`

	// 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 []Tag `min:"1" type:"list"`

	// The configuration for this Microsoft Windows file system.
	WindowsConfiguration *CreateFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The request object for the CreateFileSystemFromBackup operation.

func (CreateFileSystemFromBackupInput) String 

func (s CreateFileSystemFromBackupInput) String() string

String returns the string representation

func (*CreateFileSystemFromBackupInput) Validate 

func (s *CreateFileSystemFromBackupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFileSystemFromBackupOutput 

type CreateFileSystemFromBackupOutput struct {

	// A description of the file system.
	FileSystem *FileSystem `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the CreateFileSystemFromBackup operation.

func (CreateFileSystemFromBackupOutput) String 

func (s CreateFileSystemFromBackupOutput) String() string

String returns the string representation

type CreateFileSystemFromBackupRequest 

type CreateFileSystemFromBackupRequest struct {
	*aws.Request
	Input *CreateFileSystemFromBackupInput
	Copy  func(*CreateFileSystemFromBackupInput) CreateFileSystemFromBackupRequest
}

CreateFileSystemFromBackupRequest is the request type for the CreateFileSystemFromBackup API operation.

func (CreateFileSystemFromBackupRequest) Send 

func (r CreateFileSystemFromBackupRequest) Send(ctx context.Context) (*CreateFileSystemFromBackupResponse, error)

Send marshals and sends the CreateFileSystemFromBackup API request.

type CreateFileSystemFromBackupResponse added in v0.9.0 

type CreateFileSystemFromBackupResponse struct {
	*CreateFileSystemFromBackupOutput
	// contains filtered or unexported fields
}

CreateFileSystemFromBackupResponse is the response type for the CreateFileSystemFromBackup API operation.

func (*CreateFileSystemFromBackupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateFileSystemFromBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateFileSystemFromBackup request.

type CreateFileSystemInput 

type CreateFileSystemInput struct {

	// 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 `min:"1" type:"string" idempotencyToken:"true"`

	// The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
	//
	// FileSystemType is a required field
	FileSystemType FileSystemType `type:"string" required:"true" enum:"true"`

	// 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 `min:"1" type:"string"`

	// The Lustre configuration for the file system being created.
	LustreConfiguration *CreateFileSystemLustreConfiguration `type:"structure"`

	// 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 `type:"list"`

	// Sets the storage capacity of the file system that you're creating.
	//
	// For Lustre file systems:
	//
	//    * For SCRATCH_2 and PERSISTENT_1 deployment types, valid values are 1.2,
	//    2.4, and increments of 2.4 TiB.
	//
	//    * For SCRATCH_1 deployment type, valid values are 1.2, 2.4, and increments
	//    of 3.6 TiB.
	//
	// 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).
	//
	// StorageCapacity is a required field
	StorageCapacity *int64 `type:"integer" required:"true"`

	// Sets the storage type for the Amazon FSx for Windows 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 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.
	//
	// 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.
	StorageType StorageType `type:"string" enum:"true"`

	// 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.
	//
	// SubnetIds is a required field
	SubnetIds []string `type:"list" required:"true"`

	// 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 []Tag `min:"1" type:"list"`

	// The Microsoft Windows configuration for the file system being created.
	WindowsConfiguration *CreateFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

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

func (CreateFileSystemInput) String 

func (s CreateFileSystemInput) String() string

String returns the string representation

func (*CreateFileSystemInput) Validate 

func (s *CreateFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFileSystemLustreConfiguration 

type CreateFileSystemLustreConfiguration struct {

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 35 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

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

	// Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage
	// and shorter-term processing of data. The SCRATCH_2 deployment type provides
	// in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.
	//
	// This option can only be set for for PERSISTENT_1 deployments types.
	//
	// Choose PERSISTENT_1 deployment type for longer-term storage and workloads
	// and encryption of data in transit. To learn more about deployment types,
	// see FSx for Lustre Deployment Options (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html).
	//
	// Encryption of data in-transit is automatically enabled when you access a
	// SCRATCH_2 or PERSISTENT_1 file system from Amazon EC2 instances that support
	// this feature (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html).
	// (Default = SCRATCH_1)
	//
	// Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types
	// is supported when accessed from supported instance types in supported AWS
	// Regions. To learn more, Encrypting Data in Transit (https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html).
	DeploymentType LustreDeploymentType `type:"string" enum:"true"`

	// (Optional) The path in Amazon S3 where the root of your Amazon FSx file system
	// is exported. The path must use the same Amazon S3 bucket as specified in
	// ImportPath. You can provide an optional prefix to which new and changed data
	// is to be exported from your Amazon FSx for Lustre file system. If an ExportPath
	// value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp].
	// The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.
	//
	// The Amazon S3 export bucket must be the same as the import bucket specified
	// by ImportPath. If you only specify a bucket name, such as s3://import-bucket,
	// you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping
	// means that the input data in S3 is overwritten on export. If you provide
	// a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix],
	// Amazon FSx exports the contents of your file system to that export prefix
	// in the Amazon S3 bucket.
	ExportPath *string `min:"3" type:"string"`

	// (Optional) The path to the Amazon S3 bucket (including the optional prefix)
	// that you're using as the data repository for your Amazon FSx for Lustre file
	// system. The root of your FSx for Lustre file system will be mapped to the
	// root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix.
	// If you specify a prefix after the Amazon S3 bucket name, only object keys
	// with that prefix are loaded into the file system.
	ImportPath *string `min:"3" type:"string"`

	// (Optional) For files imported from a data repository, this value determines
	// the stripe count and maximum amount of data per file (in MiB) stored on a
	// single physical disk. The maximum number of disks that a single file can
	// be striped across is limited by the total number of disks that make up the
	// file system.
	//
	// The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000
	// MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
	ImportedFileChunkSize *int64 `min:"1" type:"integer"`

	// Required for the PERSISTENT_1 deployment type, describes the amount of read
	// and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system
	// throughput capacity is calculated by multiplying file system storage capacity
	// (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system,
	// provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 117 MB/s of file
	// system throughput. You pay for the amount of throughput that you provision.
	//
	// Valid values are 50, 100, 200.
	PerUnitStorageThroughput *int64 `min:"50" type:"integer"`

	// The preferred start time to perform weekly maintenance, formatted d:HH:MM
	// in the UTC time zone, where d is the weekday number, from 1 through 7, beginning
	// with Monday and ending with Sunday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The Lustre configuration for the file system being created.

func (CreateFileSystemLustreConfiguration) String 

func (s CreateFileSystemLustreConfiguration) String() string

String returns the string representation

func (*CreateFileSystemLustreConfiguration) Validate 

func (s *CreateFileSystemLustreConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFileSystemOutput 

type CreateFileSystemOutput struct {

	// The configuration of the file system that was created.
	FileSystem *FileSystem `type:"structure"`
	// contains filtered or unexported fields
}

The response object returned after the file system is created.

func (CreateFileSystemOutput) String 

func (s CreateFileSystemOutput) String() string

String returns the string representation

type CreateFileSystemRequest 

type CreateFileSystemRequest struct {
	*aws.Request
	Input *CreateFileSystemInput
	Copy  func(*CreateFileSystemInput) CreateFileSystemRequest
}

CreateFileSystemRequest is the request type for the CreateFileSystem API operation.

func (CreateFileSystemRequest) Send 

func (r CreateFileSystemRequest) Send(ctx context.Context) (*CreateFileSystemResponse, error)

Send marshals and sends the CreateFileSystem API request.

type CreateFileSystemResponse added in v0.9.0 

type CreateFileSystemResponse struct {
	*CreateFileSystemOutput
	// contains filtered or unexported fields
}

CreateFileSystemResponse is the response type for the CreateFileSystem API operation.

func (*CreateFileSystemResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateFileSystemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateFileSystem request.

type CreateFileSystemWindowsConfiguration 

type CreateFileSystemWindowsConfiguration struct {

	// The ID for an existing AWS Managed Microsoft Active Directory (AD) instance
	// that the file system should join when it's created.
	ActiveDirectoryId *string `min:"12" type:"string"`

	// The number of days to retain automatic backups. The default is to retain
	// backups for 7 days. Setting this value to 0 disables the creation of automatic
	// backups. The maximum retention period for backups is 35 days.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

	// The preferred time to take daily automatic backups, formatted HH:MM in the
	// UTC time zone.
	DailyAutomaticBackupStartTime *string `min:"5" type:"string"`

	// Specifies the file system deployment type, valid values are the following:
	//
	//    * MULTI_AZ_1 - Deploys a high availability file system that is configured
	//    for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
	//    You can only deploy a Multi-AZ file system in AWS Regions that have a
	//    minimum of three Availability Zones. Also supports HDD storage type
	//
	//    * SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured
	//    for single AZ redundancy.
	//
	//    * SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies
	//    a file system that is configured for single AZ redundancy and supports
	//    HDD storage type.
	//
	// For more information, see Availability and Durability: Single-AZ and Multi-AZ
	// File Systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html).
	DeploymentType WindowsDeploymentType `type:"string" enum:"true"`

	// Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet
	// in which you want the preferred file server to be located. For in-AWS applications,
	// we recommend that you launch your clients in the same Availability Zone (AZ)
	// as your preferred file server to reduce cross-AZ data transfer costs and
	// minimize latency.
	PreferredSubnetId *string `min:"15" type:"string"`

	// The configuration that Amazon FSx uses to join the Windows File Server instance
	// to your self-managed (including on-premises) Microsoft Active Directory (AD)
	// directory.
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration `type:"structure"`

	// The throughput of an Amazon FSx file system, measured in megabytes per second,
	// in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
	//
	// ThroughputCapacity is a required field
	ThroughputCapacity *int64 `min:"8" type:"integer" required:"true"`

	// The preferred start time to perform weekly maintenance, formatted d:HH:MM
	// in the UTC time zone, where d is the weekday number, from 1 through 7, beginning
	// with Monday and ending with Sunday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

func (CreateFileSystemWindowsConfiguration) String 

func (s CreateFileSystemWindowsConfiguration) String() string

String returns the string representation

func (*CreateFileSystemWindowsConfiguration) Validate 

func (s *CreateFileSystemWindowsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataRepositoryConfiguration 

type DataRepositoryConfiguration struct {

	// The export path to the Amazon S3 bucket (and prefix) that you are using to
	// store new and changed Lustre file system files in S3.
	ExportPath *string `min:"3" type:"string"`

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

	// 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.
	ImportedFileChunkSize *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

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

func (DataRepositoryConfiguration) String 

func (s DataRepositoryConfiguration) String() string

String returns the string representation

type DataRepositoryTask added in v0.19.0 

type DataRepositoryTask struct {

	// The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z),
	// also known as Unix time.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The time that Amazon FSx completed processing the task, populated after the
	// task is complete.
	EndTime *time.Time `type:"timestamp"`

	// Failure message describing why the task failed, it is populated only when
	// Lifecycle is set to FAILED.
	FailureDetails *DataRepositoryTaskFailureDetails `type:"structure"`

	// The globally unique ID of the file system, assigned by Amazon FSx.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// 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.
	//
	// You cannot delete an FSx for Lustre file system if there are data repository
	// tasks for the file system in the PENDING or EXECUTING states. Please retry
	// when the data repository task is finished (with a status of CANCELED, SUCCEEDED,
	// or FAILED). You can use the DescribeDataRepositoryTask action to monitor
	// the task status. Contact the FSx team if you need to delete your file system
	// immediately.
	//
	// Lifecycle is a required field
	Lifecycle DataRepositoryTaskLifecycle `type:"string" required:"true" enum:"true"`

	// An array of paths on the Amazon FSx for Lustre file system that specify the
	// data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY
	// task, the paths specify which data to export to the linked data repository.
	//
	// (Default) If Paths is not specified, Amazon FSx uses the file system root
	// directory.
	Paths []string `type:"list"`

	// Provides a report detailing the data repository task results of the files
	// processed that match the criteria specified in the report Scope parameter.
	// FSx delivers the report to the file system's linked data repository in Amazon
	// S3, using the path specified in the report Path parameter. You can specify
	// whether or not a report gets generated for a task using the Enabled parameter.
	Report *CompletionReport `type:"structure"`

	// The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify
	// AWS resources. We require an ARN when you need to specify a resource unambiguously
	// across all of AWS. For more information, see Amazon Resource Names (ARNs)
	// and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// in the AWS General Reference.
	ResourceARN *string `min:"8" type:"string"`

	// The time that Amazon FSx began processing the task.
	StartTime *time.Time `type:"timestamp"`

	// Provides the status of the number of files that the task has processed successfully
	// and failed to process.
	Status *DataRepositoryTaskStatus `type:"structure"`

	// A list of Tag values, with a maximum of 50 elements.
	Tags []Tag `min:"1" type:"list"`

	// The system-generated, unique 17-digit ID of the data repository task.
	//
	// TaskId is a required field
	TaskId *string `min:"12" type:"string" required:"true"`

	// The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently
	// supported.
	//
	// Type is a required field
	Type DataRepositoryTaskType `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and its linked data repository.

func (DataRepositoryTask) String added in v0.19.0 

func (s DataRepositoryTask) String() string

String returns the string representation

type DataRepositoryTaskFailureDetails added in v0.19.0 

type DataRepositoryTaskFailureDetails struct {

	// A detailed error message.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.

func (DataRepositoryTaskFailureDetails) String added in v0.19.0 

func (s DataRepositoryTaskFailureDetails) String() string

String returns the string representation

type DataRepositoryTaskFilter added in v0.19.0 

type DataRepositoryTaskFilter struct {

	// Name of the task property to use in filtering the tasks returned in the response.
	//
	//    * Use file-system-id to retrieve data repository tasks for specific file
	//    systems.
	//
	//    * Use task-lifecycle to retrieve data repository tasks with one or more
	//    specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING,
	//    and SUCCEEDED.
	Name DataRepositoryTaskFilterName `type:"string" enum:"true"`

	// Use Values to include the specific file system IDs and task lifecycle states
	// for the filters you are using.
	Values []string `type:"list"`
	// contains filtered or unexported fields
}

(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

func (DataRepositoryTaskFilter) String added in v0.19.0 

func (s DataRepositoryTaskFilter) String() string

String returns the string representation

type DataRepositoryTaskFilterName added in v0.19.0 

type DataRepositoryTaskFilterName string
const (
	DataRepositoryTaskFilterNameFileSystemId  DataRepositoryTaskFilterName = "file-system-id"
	DataRepositoryTaskFilterNameTaskLifecycle DataRepositoryTaskFilterName = "task-lifecycle"
)

Enum values for DataRepositoryTaskFilterName

func (DataRepositoryTaskFilterName) MarshalValue added in v0.19.0 

func (enum DataRepositoryTaskFilterName) MarshalValue() (string, error)

func (DataRepositoryTaskFilterName) MarshalValueBuf added in v0.19.0 

func (enum DataRepositoryTaskFilterName) MarshalValueBuf(b []byte) ([]byte, error)

type DataRepositoryTaskLifecycle added in v0.19.0 

type DataRepositoryTaskLifecycle string
const (
	DataRepositoryTaskLifecyclePending   DataRepositoryTaskLifecycle = "PENDING"
	DataRepositoryTaskLifecycleExecuting DataRepositoryTaskLifecycle = "EXECUTING"
	DataRepositoryTaskLifecycleFailed    DataRepositoryTaskLifecycle = "FAILED"
	DataRepositoryTaskLifecycleSucceeded DataRepositoryTaskLifecycle = "SUCCEEDED"
	DataRepositoryTaskLifecycleCanceled  DataRepositoryTaskLifecycle = "CANCELED"
	DataRepositoryTaskLifecycleCanceling DataRepositoryTaskLifecycle = "CANCELING"
)

Enum values for DataRepositoryTaskLifecycle

func (DataRepositoryTaskLifecycle) MarshalValue added in v0.19.0 

func (enum DataRepositoryTaskLifecycle) MarshalValue() (string, error)

func (DataRepositoryTaskLifecycle) MarshalValueBuf added in v0.19.0 

func (enum DataRepositoryTaskLifecycle) MarshalValueBuf(b []byte) ([]byte, error)

type DataRepositoryTaskStatus added in v0.19.0 

type DataRepositoryTaskStatus struct {

	// A running total of the number of files that the task failed to process.
	FailedCount *int64 `type:"long"`

	// The time at which the task status was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// A running total of the number of files that the task has successfully processed.
	SucceededCount *int64 `type:"long"`

	// The total number of files that the task will process. While a task is executing,
	// the sum of SucceededCount plus FailedCount may not equal TotalCount. When
	// the task is complete, TotalCount equals the sum of SucceededCount plus FailedCount.
	TotalCount *int64 `type:"long"`
	// contains filtered or unexported fields
}

Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.

func (DataRepositoryTaskStatus) String added in v0.19.0 

func (s DataRepositoryTaskStatus) String() string

String returns the string representation

type DataRepositoryTaskType added in v0.19.0 

type DataRepositoryTaskType string
const (
	DataRepositoryTaskTypeExportToRepository DataRepositoryTaskType = "EXPORT_TO_REPOSITORY"
)

Enum values for DataRepositoryTaskType

func (DataRepositoryTaskType) MarshalValue added in v0.19.0 

func (enum DataRepositoryTaskType) MarshalValue() (string, error)

func (DataRepositoryTaskType) MarshalValueBuf added in v0.19.0 

func (enum DataRepositoryTaskType) MarshalValueBuf(b []byte) ([]byte, error)

type DeleteBackupInput 

type DeleteBackupInput struct {

	// The ID of the backup you want to delete.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// 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 `min:"1" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

The request object for DeleteBackup operation.

func (DeleteBackupInput) String 

func (s DeleteBackupInput) String() string

String returns the string representation

func (*DeleteBackupInput) Validate 

func (s *DeleteBackupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupOutput 

type DeleteBackupOutput struct {

	// The ID of the backup deleted.
	BackupId *string `min:"12" type:"string"`

	// The lifecycle of the backup. Should be DELETED.
	Lifecycle BackupLifecycle `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The response object for DeleteBackup operation.

func (DeleteBackupOutput) String 

func (s DeleteBackupOutput) String() string

String returns the string representation

type DeleteBackupRequest 

type DeleteBackupRequest struct {
	*aws.Request
	Input *DeleteBackupInput
	Copy  func(*DeleteBackupInput) DeleteBackupRequest
}

DeleteBackupRequest is the request type for the DeleteBackup API operation.

func (DeleteBackupRequest) Send 

func (r DeleteBackupRequest) Send(ctx context.Context) (*DeleteBackupResponse, error)

Send marshals and sends the DeleteBackup API request.

type DeleteBackupResponse added in v0.9.0 

type DeleteBackupResponse struct {
	*DeleteBackupOutput
	// contains filtered or unexported fields
}

DeleteBackupResponse is the response type for the DeleteBackup API operation.

func (*DeleteBackupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBackup request.

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

	// 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 `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the file system you want to delete.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// The configuration object for the Amazon FSx for Lustre file system being
	// deleted in the DeleteFileSystem operation.
	LustreConfiguration *DeleteFileSystemLustreConfiguration `type:"structure"`

	// The configuration object for the Microsoft Windows file system used in the
	// DeleteFileSystem operation.
	WindowsConfiguration *DeleteFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The request object for DeleteFileSystem operation.

func (DeleteFileSystemInput) String 

func (s DeleteFileSystemInput) String() string

String returns the string representation

func (*DeleteFileSystemInput) Validate 

func (s *DeleteFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFileSystemLustreConfiguration added in v0.24.0 

type DeleteFileSystemLustreConfiguration struct {

	// Use if SkipFinalBackup is set to false, and you want to apply an array of
	// tags to the final backup. If you have set the file system property CopyTagsToBackups
	// to true, and you specify one or more FinalBackupTags when deleting a file
	// system, Amazon FSx will not copy any existing file system tags to the backup.
	FinalBackupTags []Tag `min:"1" type:"list"`

	// Set SkipFinalBackup to false if you want to take a final backup of the file
	// system you are deleting. By default, Amazon FSx will not take a final backup
	// on your behalf when the DeleteFileSystem operation is invoked. (Default =
	// true)
	SkipFinalBackup *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

func (DeleteFileSystemLustreConfiguration) String added in v0.24.0 

func (s DeleteFileSystemLustreConfiguration) String() string

String returns the string representation

func (*DeleteFileSystemLustreConfiguration) Validate added in v0.24.0 

func (s *DeleteFileSystemLustreConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFileSystemLustreResponse added in v0.24.0 

type DeleteFileSystemLustreResponse struct {

	// The ID of the final backup for this file system.
	FinalBackupId *string `min:"12" type:"string"`

	// The set of tags applied to the final backup.
	FinalBackupTags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

func (DeleteFileSystemLustreResponse) String added in v0.24.0 

func (s DeleteFileSystemLustreResponse) String() string

String returns the string representation

type DeleteFileSystemOutput 

type DeleteFileSystemOutput struct {

	// The ID of the file system being deleted.
	FileSystemId *string `min:"11" type:"string"`

	// The file system lifecycle for the deletion request. Should be DELETING.
	Lifecycle FileSystemLifecycle `type:"string" enum:"true"`

	// The response object for the Amazon FSx for Lustre file system being deleted
	// in the DeleteFileSystem operation.
	LustreResponse *DeleteFileSystemLustreResponse `type:"structure"`

	// The response object for the Microsoft Windows file system used in the DeleteFileSystem
	// operation.
	WindowsResponse *DeleteFileSystemWindowsResponse `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the DeleteFileSystem operation.

func (DeleteFileSystemOutput) String 

func (s DeleteFileSystemOutput) String() string

String returns the string representation

type DeleteFileSystemRequest 

type DeleteFileSystemRequest struct {
	*aws.Request
	Input *DeleteFileSystemInput
	Copy  func(*DeleteFileSystemInput) DeleteFileSystemRequest
}

DeleteFileSystemRequest is the request type for the DeleteFileSystem API operation.

func (DeleteFileSystemRequest) Send 

func (r DeleteFileSystemRequest) Send(ctx context.Context) (*DeleteFileSystemResponse, error)

Send marshals and sends the DeleteFileSystem API request.

type DeleteFileSystemResponse added in v0.9.0 

type DeleteFileSystemResponse struct {
	*DeleteFileSystemOutput
	// contains filtered or unexported fields
}

DeleteFileSystemResponse is the response type for the DeleteFileSystem API operation.

func (*DeleteFileSystemResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteFileSystemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteFileSystem request.

type DeleteFileSystemWindowsConfiguration 

type DeleteFileSystemWindowsConfiguration struct {

	// A set of tags for your final backup.
	FinalBackupTags []Tag `min:"1" type:"list"`

	// By default, Amazon FSx for Windows takes a final backup on your behalf when
	// the DeleteFileSystem operation is invoked. Doing this helps protect you from
	// data loss, and we highly recommend taking the final backup. If you want to
	// skip this backup, use this flag to do so.
	SkipFinalBackup *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

func (DeleteFileSystemWindowsConfiguration) String 

func (s DeleteFileSystemWindowsConfiguration) String() string

String returns the string representation

func (*DeleteFileSystemWindowsConfiguration) Validate 

func (s *DeleteFileSystemWindowsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFileSystemWindowsResponse 

type DeleteFileSystemWindowsResponse struct {

	// The ID of the final backup for this file system.
	FinalBackupId *string `min:"12" type:"string"`

	// The set of tags applied to the final backup.
	FinalBackupTags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

func (DeleteFileSystemWindowsResponse) String 

func (s DeleteFileSystemWindowsResponse) String() string

String returns the string representation

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 `type:"list"`

	// Filters structure. Supported names are file-system-id and backup-type.
	Filters []Filter `type:"list"`

	// 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 *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request object for DescribeBackups operation.

func (DescribeBackupsInput) String 

func (s DescribeBackupsInput) String() string

String returns the string representation

func (*DescribeBackupsInput) Validate 

func (s *DescribeBackupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBackupsOutput 

type DescribeBackupsOutput struct {

	// Any array of backups.
	Backups []Backup `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Response object for DescribeBackups operation.

func (DescribeBackupsOutput) String 

func (s DescribeBackupsOutput) String() string

String returns the string representation

type DescribeBackupsPaginator added in v0.9.0 

type DescribeBackupsPaginator struct {
	aws.Pager
}

DescribeBackupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeBackupsPaginator added in v0.9.0 

func NewDescribeBackupsPaginator(req DescribeBackupsRequest) DescribeBackupsPaginator

NewDescribeBackupsRequestPaginator returns a paginator for DescribeBackups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeBackupsRequest(input)
p := fsx.NewDescribeBackupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeBackupsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeBackupsPaginator) CurrentPage() *DescribeBackupsOutput

type DescribeBackupsRequest 

type DescribeBackupsRequest struct {
	*aws.Request
	Input *DescribeBackupsInput
	Copy  func(*DescribeBackupsInput) DescribeBackupsRequest
}

DescribeBackupsRequest is the request type for the DescribeBackups API operation.

func (DescribeBackupsRequest) Send 

func (r DescribeBackupsRequest) Send(ctx context.Context) (*DescribeBackupsResponse, error)

Send marshals and sends the DescribeBackups API request.

type DescribeBackupsResponse added in v0.9.0 

type DescribeBackupsResponse struct {
	*DescribeBackupsOutput
	// contains filtered or unexported fields
}

DescribeBackupsResponse is the response type for the DescribeBackups API operation.

func (*DescribeBackupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeBackupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeBackups request.

type DescribeDataRepositoryTasksInput added in v0.19.0 

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 []DataRepositoryTaskFilter `type:"list"`

	// The maximum number of resources to return in the response. This value must
	// be an integer greater than zero.
	MaxResults *int64 `min:"1" type:"integer"`

	// (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 `min:"1" type:"string"`

	// (Optional) IDs of the tasks whose descriptions you want to retrieve (String).
	TaskIds []string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeDataRepositoryTasksInput) String added in v0.19.0 

func (s DescribeDataRepositoryTasksInput) String() string

String returns the string representation

func (*DescribeDataRepositoryTasksInput) Validate added in v0.19.0 

func (s *DescribeDataRepositoryTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDataRepositoryTasksOutput added in v0.19.0 

type DescribeDataRepositoryTasksOutput struct {

	// The collection of data repository task descriptions returned.
	DataRepositoryTasks []DataRepositoryTask `type:"list"`

	// (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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDataRepositoryTasksOutput) String added in v0.19.0 

func (s DescribeDataRepositoryTasksOutput) String() string

String returns the string representation

type DescribeDataRepositoryTasksPaginator added in v0.19.0 

type DescribeDataRepositoryTasksPaginator struct {
	aws.Pager
}

DescribeDataRepositoryTasksPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeDataRepositoryTasksPaginator added in v0.19.0 

func NewDescribeDataRepositoryTasksPaginator(req DescribeDataRepositoryTasksRequest) DescribeDataRepositoryTasksPaginator

NewDescribeDataRepositoryTasksRequestPaginator returns a paginator for DescribeDataRepositoryTasks. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeDataRepositoryTasksRequest(input)
p := fsx.NewDescribeDataRepositoryTasksRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeDataRepositoryTasksPaginator) CurrentPage added in v0.19.0 

func (p *DescribeDataRepositoryTasksPaginator) CurrentPage() *DescribeDataRepositoryTasksOutput

type DescribeDataRepositoryTasksRequest added in v0.19.0 

type DescribeDataRepositoryTasksRequest struct {
	*aws.Request
	Input *DescribeDataRepositoryTasksInput
	Copy  func(*DescribeDataRepositoryTasksInput) DescribeDataRepositoryTasksRequest
}

DescribeDataRepositoryTasksRequest is the request type for the DescribeDataRepositoryTasks API operation.

func (DescribeDataRepositoryTasksRequest) Send added in v0.19.0 

func (r DescribeDataRepositoryTasksRequest) Send(ctx context.Context) (*DescribeDataRepositoryTasksResponse, error)

Send marshals and sends the DescribeDataRepositoryTasks API request.

type DescribeDataRepositoryTasksResponse added in v0.19.0 

type DescribeDataRepositoryTasksResponse struct {
	*DescribeDataRepositoryTasksOutput
	// contains filtered or unexported fields
}

DescribeDataRepositoryTasksResponse is the response type for the DescribeDataRepositoryTasks API operation.

func (*DescribeDataRepositoryTasksResponse) SDKResponseMetdata added in v0.19.0 

func (r *DescribeDataRepositoryTasksResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDataRepositoryTasks request.

type DescribeFileSystemsInput 

type DescribeFileSystemsInput struct {

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

	// 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 *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request object for DescribeFileSystems operation.

func (DescribeFileSystemsInput) String 

func (s DescribeFileSystemsInput) String() string

String returns the string representation

func (*DescribeFileSystemsInput) Validate 

func (s *DescribeFileSystemsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFileSystemsOutput 

type DescribeFileSystemsOutput struct {

	// An array of file system descriptions.
	FileSystems []FileSystem `type:"list"`

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response object for DescribeFileSystems operation.

func (DescribeFileSystemsOutput) String 

func (s DescribeFileSystemsOutput) String() string

String returns the string representation

type DescribeFileSystemsPaginator added in v0.9.0 

type DescribeFileSystemsPaginator struct {
	aws.Pager
}

DescribeFileSystemsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeFileSystemsPaginator added in v0.9.0 

func NewDescribeFileSystemsPaginator(req DescribeFileSystemsRequest) DescribeFileSystemsPaginator

NewDescribeFileSystemsRequestPaginator returns a paginator for DescribeFileSystems. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeFileSystemsRequest(input)
p := fsx.NewDescribeFileSystemsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeFileSystemsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeFileSystemsPaginator) CurrentPage() *DescribeFileSystemsOutput

type DescribeFileSystemsRequest 

type DescribeFileSystemsRequest struct {
	*aws.Request
	Input *DescribeFileSystemsInput
	Copy  func(*DescribeFileSystemsInput) DescribeFileSystemsRequest
}

DescribeFileSystemsRequest is the request type for the DescribeFileSystems API operation.

func (DescribeFileSystemsRequest) Send 

func (r DescribeFileSystemsRequest) Send(ctx context.Context) (*DescribeFileSystemsResponse, error)

Send marshals and sends the DescribeFileSystems API request.

type DescribeFileSystemsResponse added in v0.9.0 

type DescribeFileSystemsResponse struct {
	*DescribeFileSystemsOutput
	// contains filtered or unexported fields
}

DescribeFileSystemsResponse is the response type for the DescribeFileSystems API operation.

func (*DescribeFileSystemsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeFileSystemsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeFileSystems request.

type FileSystem 

type FileSystem struct {

	// A list of administrative actions for the file system that are in process
	// or waiting to be processed. Administrative actions describe changes to the
	// Windows file system that you have initiated using the UpdateFileSystem action.
	AdministrativeActions []AdministrativeAction `type:"list"`

	// The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z),
	// also known as Unix time.
	CreationTime *time.Time `type:"timestamp"`

	// The DNS name for the file system.
	DNSName *string `min:"16" type:"string"`

	// A structure providing details of any failures that occur when creating the
	// file system has failed.
	FailureDetails *FileSystemFailureDetails `type:"structure"`

	// The system-generated, unique 17-digit ID of the file system.
	FileSystemId *string `min:"11" type:"string"`

	// The type of Amazon FSx file system, either LUSTRE or WINDOWS.
	FileSystemType FileSystemType `type:"string" enum:"true"`

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

	// The lifecycle status of the file system, following are the possible values
	// and what they mean:
	//
	//    * AVAILABLE - The file system is in a healthy state, and is reachable
	//    and available for use.
	//
	//    * CREATING - Amazon FSx is creating the new file system.
	//
	//    * DELETING - Amazon FSx is deleting an existing file system.
	//
	//    * FAILED - An existing file system has experienced an unrecoverable failure.
	//    When creating a new file system, Amazon FSx was unable to create the file
	//    system.
	//
	//    * MISCONFIGURED indicates that the file system is in a failed but recoverable
	//    state.
	//
	//    * UPDATING indicates that the file system is undergoing a customer initiated
	//    update.
	Lifecycle FileSystemLifecycle `type:"string" enum:"true"`

	// The configuration for the Amazon FSx for Lustre file system.
	LustreConfiguration *LustreFileSystemConfiguration `type:"structure"`

	// The IDs of the elastic network interface from which a specific file system
	// is accessible. The elastic network interface is automatically created in
	// the same VPC that the Amazon FSx file system was created in. For more information,
	// see Elastic Network Interfaces (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html)
	// in the Amazon EC2 User Guide.
	//
	// For an Amazon FSx for Windows File Server file system, you can have one network
	// interface ID. For an Amazon FSx for Lustre file system, you can have more
	// than one.
	NetworkInterfaceIds []string `type:"list"`

	// The AWS account that created the file system. If the file system was created
	// by an AWS Identity and Access Management (IAM) user, the AWS account to which
	// the IAM user belongs is the owner.
	OwnerId *string `min:"12" type:"string"`

	// The Amazon Resource Name (ARN) for the file system resource.
	ResourceARN *string `min:"8" type:"string"`

	// The storage capacity of the file system in gigabytes (GB).
	StorageCapacity *int64 `type:"integer"`

	// The storage type of the file system. Valid values are SSD and HDD. If set
	// to SSD, the file system uses solid state drive storage. If set to HDD, the
	// file system uses hard disk drive storage.
	StorageType StorageType `type:"string" enum:"true"`

	// Specifies the IDs of the subnets that the file system is accessible from.
	// For Windows MULTI_AZ_1 file system deployment type, there are two subnet
	// IDs, one for the preferred file server and one for the standby file server.
	// The preferred file server subnet identified in the PreferredSubnetID property.
	// All other file systems have only one subnet ID.
	//
	// For Lustre file systems, and Single-AZ Windows file systems, this is the
	// ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1
	// Windows file systems, the endpoint for the file system is available in the
	// PreferredSubnetID.
	SubnetIds []string `type:"list"`

	// The tags to associate with the file system. For more information, see Tagging
	// Your Amazon EC2 Resources (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html)
	// in the Amazon EC2 User Guide.
	Tags []Tag `min:"1" type:"list"`

	// The ID of the primary VPC for the file system.
	VpcId *string `min:"12" type:"string"`

	// The configuration for this Microsoft Windows file system.
	WindowsConfiguration *WindowsFileSystemConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

A description of a specific Amazon FSx file system.

func (FileSystem) String 

func (s FileSystem) String() string

String returns the string representation

type FileSystemFailureDetails 

type FileSystemFailureDetails struct {

	// A message describing any failures that occurred during file system creation.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (FileSystemFailureDetails) String 

func (s FileSystemFailureDetails) String() string

String returns the string representation

type FileSystemLifecycle 

type FileSystemLifecycle string

The lifecycle status of the file system. 

const (
	FileSystemLifecycleAvailable     FileSystemLifecycle = "AVAILABLE"
	FileSystemLifecycleCreating      FileSystemLifecycle = "CREATING"
	FileSystemLifecycleFailed        FileSystemLifecycle = "FAILED"
	FileSystemLifecycleDeleting      FileSystemLifecycle = "DELETING"
	FileSystemLifecycleMisconfigured FileSystemLifecycle = "MISCONFIGURED"
	FileSystemLifecycleUpdating      FileSystemLifecycle = "UPDATING"
)

Enum values for FileSystemLifecycle

func (FileSystemLifecycle) MarshalValue 

func (enum FileSystemLifecycle) MarshalValue() (string, error)

func (FileSystemLifecycle) MarshalValueBuf 

func (enum FileSystemLifecycle) MarshalValueBuf(b []byte) ([]byte, error)

type FileSystemMaintenanceOperation 

type FileSystemMaintenanceOperation string

An enumeration specifying the currently ongoing maintenance operation. 

const (
	FileSystemMaintenanceOperationPatching  FileSystemMaintenanceOperation = "PATCHING"
	FileSystemMaintenanceOperationBackingUp FileSystemMaintenanceOperation = "BACKING_UP"
)

Enum values for FileSystemMaintenanceOperation

func (FileSystemMaintenanceOperation) MarshalValue 

func (enum FileSystemMaintenanceOperation) MarshalValue() (string, error)

func (FileSystemMaintenanceOperation) MarshalValueBuf 

func (enum FileSystemMaintenanceOperation) MarshalValueBuf(b []byte) ([]byte, error)

type FileSystemType 

type FileSystemType string

The type of file system. 

const (
	FileSystemTypeWindows FileSystemType = "WINDOWS"
	FileSystemTypeLustre  FileSystemType = "LUSTRE"
)

Enum values for FileSystemType

func (FileSystemType) MarshalValue 

func (enum FileSystemType) MarshalValue() (string, error)

func (FileSystemType) MarshalValueBuf 

func (enum FileSystemType) MarshalValueBuf(b []byte) ([]byte, error)

type Filter 

type Filter struct {

	// The name for this filter.
	Name FilterName `type:"string" enum:"true"`

	// The values of the filter. These are all the values for any of the applied
	// filters.
	Values []string `type:"list"`
	// contains filtered or unexported fields
}

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

func (Filter) String 

func (s Filter) String() string

String returns the string representation

type FilterName 

type FilterName string

The name for a filter. 

const (
	FilterNameFileSystemId   FilterName = "file-system-id"
	FilterNameBackupType     FilterName = "backup-type"
	FilterNameFileSystemType FilterName = "file-system-type"
)

Enum values for FilterName

func (FilterName) MarshalValue 

func (enum FilterName) MarshalValue() (string, error)

func (FilterName) MarshalValueBuf 

func (enum FilterName) MarshalValueBuf(b []byte) ([]byte, error)

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// 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 *int64 `min:"1" type:"integer"`

	// 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 `min:"1" type:"string"`

	// The ARN of the Amazon FSx resource that will have its tags listed.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request object for ListTagsForResource operation.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"string"`

	// A list of tags on the resource.
	Tags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The response object for ListTagsForResource operation.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type LustreDeploymentType added in v0.20.0 

type LustreDeploymentType string
const (
	LustreDeploymentTypeScratch1    LustreDeploymentType = "SCRATCH_1"
	LustreDeploymentTypeScratch2    LustreDeploymentType = "SCRATCH_2"
	LustreDeploymentTypePersistent1 LustreDeploymentType = "PERSISTENT_1"
)

Enum values for LustreDeploymentType

func (LustreDeploymentType) MarshalValue added in v0.20.0 

func (enum LustreDeploymentType) MarshalValue() (string, error)

func (LustreDeploymentType) MarshalValueBuf added in v0.20.0 

func (enum LustreDeploymentType) MarshalValueBuf(b []byte) ([]byte, error)

type LustreFileSystemConfiguration 

type LustreFileSystemConfiguration struct {

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 35 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

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

	// The data repository configuration object for Lustre file systems returned
	// in the response of the CreateFileSystem operation.
	DataRepositoryConfiguration *DataRepositoryConfiguration `type:"structure"`

	// The deployment type of the FSX for Lustre file system. Scratch deployment
	// type is designed for temporary storage and shorter-term processing of data.
	//
	// SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need
	// temporary storage and shorter-term processing of data. The SCRATCH_2 deployment
	// type provides in-transit encryption of data and higher burst throughput capacity
	// than SCRATCH_1.
	//
	// The PERSISTENT_1 deployment type is used for longer-term storage and workloads
	// and encryption of data in transit. To learn more about deployment types,
	// see FSx for Lustre Deployment Options (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html).
	// (Default = SCRATCH_1)
	DeploymentType LustreDeploymentType `type:"string" enum:"true"`

	// You use the MountName value when mounting the file system.
	//
	// For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2
	// and PERSISTENT_1 deployment types, this value is a string that is unique
	// within an AWS Region.
	MountName *string `min:"1" type:"string"`

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

	// The preferred start time to perform weekly maintenance, formatted d:HH:MM
	// in the UTC time zone. d is the weekday number, from 1 through 7, beginning
	// with Monday and ending with Sunday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration for the Amazon FSx for Lustre file system.

func (LustreFileSystemConfiguration) String 

func (s LustreFileSystemConfiguration) String() string

String returns the string representation

type ReportFormat added in v0.19.0 

type ReportFormat string
const (
	ReportFormatReportCsv20191124 ReportFormat = "REPORT_CSV_20191124"
)

Enum values for ReportFormat

func (ReportFormat) MarshalValue added in v0.19.0 

func (enum ReportFormat) MarshalValue() (string, error)

func (ReportFormat) MarshalValueBuf added in v0.19.0 

func (enum ReportFormat) MarshalValueBuf(b []byte) ([]byte, error)

type ReportScope added in v0.19.0 

type ReportScope string
const (
	ReportScopeFailedFilesOnly ReportScope = "FAILED_FILES_ONLY"
)

Enum values for ReportScope

func (ReportScope) MarshalValue added in v0.19.0 

func (enum ReportScope) MarshalValue() (string, error)

func (ReportScope) MarshalValueBuf added in v0.19.0 

func (enum ReportScope) MarshalValueBuf(b []byte) ([]byte, error)

type SelfManagedActiveDirectoryAttributes added in v0.10.0 

type SelfManagedActiveDirectoryAttributes struct {

	// A list of up to two IP addresses of DNS servers or domain controllers in
	// the self-managed AD directory.
	DnsIps []string `min:"1" type:"list"`

	// The fully qualified domain name of the self-managed AD directory.
	DomainName *string `min:"1" type:"string"`

	// The name of the domain group whose members have administrative privileges
	// for the FSx file system.
	FileSystemAdministratorsGroup *string `min:"1" type:"string"`

	// The fully qualified distinguished name of the organizational unit within
	// the self-managed AD directory to which the Windows File Server instance is
	// joined.
	OrganizationalUnitDistinguishedName *string `min:"1" type:"string"`

	// The user name for the service account on your self-managed AD domain that
	// FSx uses to join to your AD domain.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (SelfManagedActiveDirectoryAttributes) String added in v0.10.0 

func (s SelfManagedActiveDirectoryAttributes) String() string

String returns the string representation

type SelfManagedActiveDirectoryConfiguration added in v0.10.0 

type SelfManagedActiveDirectoryConfiguration struct {

	// A list of up to two IP addresses of DNS servers or domain controllers in
	// the self-managed AD directory. The IP addresses need to be either in the
	// same VPC CIDR range as the one in which your Amazon FSx file system is being
	// created, or in the private IP version 4 (IPv4) address ranges, as specified
	// in RFC 1918 (http://www.faqs.org/rfcs/rfc1918.html):
	//
	//    * 10.0.0.0 - 10.255.255.255 (10/8 prefix)
	//
	//    * 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
	//
	//    * 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
	//
	// DnsIps is a required field
	DnsIps []string `min:"1" type:"list" required:"true"`

	// The fully qualified domain name of the self-managed AD directory, such as
	// corp.example.com.
	//
	// DomainName is a required field
	DomainName *string `min:"1" type:"string" required:"true"`

	// (Optional) The name of the domain group whose members are granted administrative
	// privileges for the file system. Administrative privileges include taking
	// ownership of files and folders, setting audit controls (audit ACLs) on files
	// and folders, and administering the file system remotely by using the FSx
	// Remote PowerShell. The group that you specify must already exist in your
	// domain. If you don't provide one, your AD domain's Domain Admins group is
	// used.
	FileSystemAdministratorsGroup *string `min:"1" type:"string"`

	// (Optional) The fully qualified distinguished name of the organizational unit
	// within your self-managed AD directory that the Windows File Server instance
	// will join. Amazon FSx only accepts OU as the direct parent of the file system.
	// An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC
	// 2253 (https://tools.ietf.org/html/rfc2253). If none is provided, the FSx
	// file system is created in the default location of your self-managed AD directory.
	//
	// Only Organizational Unit (OU) objects can be the direct parent of the file
	// system that you're creating.
	OrganizationalUnitDistinguishedName *string `min:"1" type:"string"`

	// The password for the service account on your self-managed AD domain that
	// Amazon FSx will use to join to your AD domain.
	//
	// Password is a required field
	Password *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The user name for the service account on your self-managed AD domain that
	// Amazon FSx will use to join to your AD domain. This account must have the
	// permission to join computers to the domain in the organizational unit provided
	// in OrganizationalUnitDistinguishedName, or in the default location of your
	// AD domain.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

func (SelfManagedActiveDirectoryConfiguration) String added in v0.10.0 

func (s SelfManagedActiveDirectoryConfiguration) String() string

String returns the string representation

func (*SelfManagedActiveDirectoryConfiguration) Validate added in v0.10.0 

func (s *SelfManagedActiveDirectoryConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SelfManagedActiveDirectoryConfigurationUpdates added in v0.10.0 

type SelfManagedActiveDirectoryConfigurationUpdates struct {

	// A list of up to two IP addresses of DNS servers or domain controllers in
	// the self-managed AD directory.
	DnsIps []string `min:"1" type:"list"`

	// The password for the service account on your self-managed AD domain that
	// Amazon FSx will use to join to your AD domain.
	Password *string `min:"1" type:"string" sensitive:"true"`

	// The user name for the service account on your self-managed AD domain that
	// Amazon FSx will use to join to your AD domain. This account must have the
	// permission to join computers to the domain in the organizational unit provided
	// in OrganizationalUnitDistinguishedName.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.

func (SelfManagedActiveDirectoryConfigurationUpdates) String added in v0.10.0 

func (s SelfManagedActiveDirectoryConfigurationUpdates) String() string

String returns the string representation

func (*SelfManagedActiveDirectoryConfigurationUpdates) Validate added in v0.10.0 

func (s *SelfManagedActiveDirectoryConfigurationUpdates) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceLimit 

type ServiceLimit string

The types of limits on your service utilization. Limits include file system count, total throughput capacity, total storage, and total user-initiated backups. These limits apply for a specific account in a specific AWS Region. You can increase some of them by contacting AWS Support. 

const (
	ServiceLimitFileSystemCount           ServiceLimit = "FILE_SYSTEM_COUNT"
	ServiceLimitTotalThroughputCapacity   ServiceLimit = "TOTAL_THROUGHPUT_CAPACITY"
	ServiceLimitTotalStorage              ServiceLimit = "TOTAL_STORAGE"
	ServiceLimitTotalUserInitiatedBackups ServiceLimit = "TOTAL_USER_INITIATED_BACKUPS"
)

Enum values for ServiceLimit

func (ServiceLimit) MarshalValue 

func (enum ServiceLimit) MarshalValue() (string, error)

func (ServiceLimit) MarshalValueBuf 

func (enum ServiceLimit) MarshalValueBuf(b []byte) ([]byte, error)

type Status added in v0.24.0 

type Status string
const (
	StatusFailed            Status = "FAILED"
	StatusInProgress        Status = "IN_PROGRESS"
	StatusPending           Status = "PENDING"
	StatusCompleted         Status = "COMPLETED"
	StatusUpdatedOptimizing Status = "UPDATED_OPTIMIZING"
)

Enum values for Status

func (Status) MarshalValue added in v0.24.0 

func (enum Status) MarshalValue() (string, error)

func (Status) MarshalValueBuf added in v0.24.0 

func (enum Status) MarshalValueBuf(b []byte) ([]byte, error)

type StorageType added in v0.21.0 

type StorageType string

The storage type for your Amazon FSx file system. 

const (
	StorageTypeSsd StorageType = "SSD"
	StorageTypeHdd StorageType = "HDD"
)

Enum values for StorageType

func (StorageType) MarshalValue added in v0.21.0 

func (enum StorageType) MarshalValue() (string, error)

func (StorageType) MarshalValueBuf added in v0.21.0 

func (enum StorageType) MarshalValueBuf(b []byte) ([]byte, error)

type Tag 

type Tag struct {

	// A value that specifies the TagKey, the name of the tag. Tag keys must be
	// unique for the resource to which they are attached.
	Key *string `min:"1" type:"string"`

	// A value that specifies the TagValue, the value assigned to the corresponding
	// tag key. Tag values can be null and don't have to be unique in a tag set.
	// For example, you can have a key-value pair in a tag set of finances : April
	// and also of payroll : April.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies a key-value pair for a resource tag.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to
	// tag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`

	// 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.
	//
	// Tags is a required field
	Tags []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request object for the TagResource operation.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

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

The response object for the TagResource operation.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the Amazon FSx resource to untag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`

	// 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.
	//
	// TagKeys is a required field
	TagKeys []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request object for UntagResource action.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

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

The response object for UntagResource action.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateFileSystemInput 

type UpdateFileSystemInput struct {

	// 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 `min:"1" type:"string" idempotencyToken:"true"`

	// Identifies the file system that you are updating.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// The configuration object for Amazon FSx for Lustre file systems used in the
	// UpdateFileSystem operation.
	LustreConfiguration *UpdateFileSystemLustreConfiguration `type:"structure"`

	// Use this parameter to increase the storage capacity of an Amazon FSx for
	// Windows File Server file system. Specifies the storage capacity target value,
	// GiB, for the file system you're updating. 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 needs to have
	// at least 16 MB/s of throughput capacity. You cannot make a storage capacity
	// increase request if there is an existing storage capacity increase request
	// in progress. For more information, see Managing Storage Capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html).
	StorageCapacity *int64 `type:"integer"`

	// The configuration updates for an Amazon FSx for Windows File Server file
	// system.
	WindowsConfiguration *UpdateFileSystemWindowsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The request object for the UpdateFileSystem operation.

func (UpdateFileSystemInput) String 

func (s UpdateFileSystemInput) String() string

String returns the string representation

func (*UpdateFileSystemInput) Validate 

func (s *UpdateFileSystemInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFileSystemLustreConfiguration 

type UpdateFileSystemLustreConfiguration struct {

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 35 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

	// The preferred start time to perform weekly maintenance, formatted d:HH:MM
	// in the UTC time zone. d is the weekday number, from 1 through 7, beginning
	// with Monday and ending with Sunday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

func (UpdateFileSystemLustreConfiguration) String 

func (s UpdateFileSystemLustreConfiguration) String() string

String returns the string representation

func (*UpdateFileSystemLustreConfiguration) Validate 

func (s *UpdateFileSystemLustreConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFileSystemOutput 

type UpdateFileSystemOutput struct {

	// A description of the file system that was updated.
	FileSystem *FileSystem `type:"structure"`
	// contains filtered or unexported fields
}

The response object for the UpdateFileSystem operation.

func (UpdateFileSystemOutput) String 

func (s UpdateFileSystemOutput) String() string

String returns the string representation

type UpdateFileSystemRequest 

type UpdateFileSystemRequest struct {
	*aws.Request
	Input *UpdateFileSystemInput
	Copy  func(*UpdateFileSystemInput) UpdateFileSystemRequest
}

UpdateFileSystemRequest is the request type for the UpdateFileSystem API operation.

func (UpdateFileSystemRequest) Send 

func (r UpdateFileSystemRequest) Send(ctx context.Context) (*UpdateFileSystemResponse, error)

Send marshals and sends the UpdateFileSystem API request.

type UpdateFileSystemResponse added in v0.9.0 

type UpdateFileSystemResponse struct {
	*UpdateFileSystemOutput
	// contains filtered or unexported fields
}

UpdateFileSystemResponse is the response type for the UpdateFileSystem API operation.

func (*UpdateFileSystemResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateFileSystemResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateFileSystem request.

type UpdateFileSystemWindowsConfiguration 

type UpdateFileSystemWindowsConfiguration struct {

	// The number of days to retain automatic daily backups. Setting this to zero
	// (0) disables automatic daily backups. You can retain automatic daily backups
	// for a maximum of 35 days. For more information, see Working with Automatic
	// Daily Backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#automatic-backups).
	AutomaticBackupRetentionDays *int64 `type:"integer"`

	// The preferred time to start the daily automatic backup, in the UTC time zone,
	// for example, 02:00
	DailyAutomaticBackupStartTime *string `min:"5" type:"string"`

	// The configuration Amazon FSx uses to join the Windows File Server instance
	// to the self-managed Microsoft AD directory. You cannot make a self-managed
	// Microsoft AD update request if there is an existing self-managed Microsoft
	// AD update request in progress.
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates `type:"structure"`

	// Sets the target value for a file system's throughput capacity, in MB/s, that
	// you are updating the file system to. Valid values are 8, 16, 32, 64, 128,
	// 256, 512, 1024, 2048. You cannot make a throughput capacity update request
	// if there is an existing throughput capacity update request in progress. For
	// more information, see Managing Throughput Capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html).
	ThroughputCapacity *int64 `min:"8" type:"integer"`

	// The preferred start time to perform weekly maintenance, formatted d:HH:MM
	// in the UTC time zone. Where d is the weekday number, from 1 through 7, with
	// 1 = Monday and 7 = Sunday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.

func (UpdateFileSystemWindowsConfiguration) String 

func (s UpdateFileSystemWindowsConfiguration) String() string

String returns the string representation

func (*UpdateFileSystemWindowsConfiguration) Validate 

func (s *UpdateFileSystemWindowsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WindowsDeploymentType added in v0.17.0 

type WindowsDeploymentType string
const (
	WindowsDeploymentTypeMultiAz1  WindowsDeploymentType = "MULTI_AZ_1"
	WindowsDeploymentTypeSingleAz1 WindowsDeploymentType = "SINGLE_AZ_1"
	WindowsDeploymentTypeSingleAz2 WindowsDeploymentType = "SINGLE_AZ_2"
)

Enum values for WindowsDeploymentType

func (WindowsDeploymentType) MarshalValue added in v0.17.0 

func (enum WindowsDeploymentType) MarshalValue() (string, error)

func (WindowsDeploymentType) MarshalValueBuf added in v0.17.0 

func (enum WindowsDeploymentType) MarshalValueBuf(b []byte) ([]byte, error)

type WindowsFileSystemConfiguration 

type WindowsFileSystemConfiguration struct {

	// The ID for an existing Microsoft Active Directory instance that the file
	// system should join when it's created.
	ActiveDirectoryId *string `min:"12" type:"string"`

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 35 days.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

	// The preferred time to take daily automatic backups, in the UTC time zone.
	DailyAutomaticBackupStartTime *string `min:"5" type:"string"`

	// Specifies the file system deployment type, valid values are the following:
	//
	//    * MULTI_AZ_1 - Specifies a high availability file system that is configured
	//    for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability,
	//    and supports SSD and HDD storage.
	//
	//    * SINGLE_AZ_1 - (Default) Specifies a file system that is configured for
	//    single AZ redundancy, only supports SSD storage.
	//
	//    * SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file
	//    system that is configured for single AZ redundancy and supports SSD and
	//    HDD storage.
	//
	// For more information, see Single-AZ and Multi-AZ File Systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html).
	DeploymentType WindowsDeploymentType `type:"string" enum:"true"`

	// The list of maintenance operations in progress for this file system.
	MaintenanceOperationsInProgress []FileSystemMaintenanceOperation `type:"list"`

	// For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred,
	// file server.
	//
	// Use this IP address when mounting the file system on Linux SMB clients or
	// Windows SMB clients that are not joined to a Microsoft Active Directory.
	// Applicable for all Windows file system deployment types. This IP address
	// is temporarily unavailable when the file system is undergoing maintenance.
	// For Linux and Windows SMB clients that are joined to an Active Directory,
	// use the file system's DNSName instead. For more information on mapping and
	// mounting file shares, see Accessing File Shares (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html).
	PreferredFileServerIp *string `min:"7" type:"string"`

	// For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where
	// the preferred file server is located. Must be one of the two subnet IDs specified
	// in SubnetIds property. Amazon FSx serves traffic from this subnet except
	// in the event of a failover to the secondary file server.
	//
	// For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same
	// as that for SubnetIDs. For more information, see Availability and Durability:
	// Single-AZ and Multi-AZ File Systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources)
	PreferredSubnetId *string `min:"15" type:"string"`

	// For MULTI_AZ_1 deployment types, use this endpoint when performing administrative
	// tasks on the file system using Amazon FSx Remote PowerShell.
	//
	// For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of
	// the file system.
	//
	// This endpoint is temporarily unavailable when the file system is undergoing
	// maintenance.
	RemoteAdministrationEndpoint *string `min:"16" type:"string"`

	// The configuration of the self-managed Microsoft Active Directory (AD) directory
	// to which the Windows File Server instance is joined.
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryAttributes `type:"structure"`

	// The throughput of an Amazon FSx file system, measured in megabytes per second.
	ThroughputCapacity *int64 `min:"8" type:"integer"`

	// The preferred start time to perform weekly maintenance, formatted d:HH:MM
	// in the UTC time zone. d is the weekday number, from 1 through 7, beginning
	// with Monday and ending with Sunday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration for this Microsoft Windows file system.

func (WindowsFileSystemConfiguration) String 

func (s WindowsFileSystemConfiguration) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package fsxiface provides an interface to enable mocking the Amazon FSx service client for testing your code.
 Package fsxiface provides an interface to enable mocking the Amazon FSx service client for testing your code.

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.