...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/fsx"
Overview
Examples
Constants

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 contact 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 FSx for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/fsx/#New

The stub package, fsxiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type ActiveDirectoryBackupAttributes
func (s *ActiveDirectoryBackupAttributes) SetActiveDirectoryId(v string) *ActiveDirectoryBackupAttributes
func (s *ActiveDirectoryBackupAttributes) SetDomainName(v string) *ActiveDirectoryBackupAttributes
type Backup
func (s *Backup) SetBackupId(v string) *Backup
func (s *Backup) SetCreationTime(v time.Time) *Backup
func (s *Backup) SetDirectoryInformation(v *ActiveDirectoryBackupAttributes) *Backup
func (s *Backup) SetFailureDetails(v *BackupFailureDetails) *Backup
func (s *Backup) SetFileSystem(v *FileSystem) *Backup
func (s *Backup) SetKmsKeyId(v string) *Backup
func (s *Backup) SetLifecycle(v string) *Backup
func (s *Backup) SetProgressPercent(v int64) *Backup
func (s *Backup) SetResourceARN(v string) *Backup
func (s *Backup) SetTags(v []*Tag) *Backup
func (s *Backup) SetType(v string) *Backup
type BackupFailureDetails
func (s *BackupFailureDetails) SetMessage(v string) *BackupFailureDetails
type CreateBackupInput
func (s *CreateBackupInput) SetClientRequestToken(v string) *CreateBackupInput
func (s *CreateBackupInput) SetFileSystemId(v string) *CreateBackupInput
func (s *CreateBackupInput) SetTags(v []*Tag) *CreateBackupInput
type CreateBackupOutput
func (s *CreateBackupOutput) SetBackup(v *Backup) *CreateBackupOutput
type CreateFileSystemFromBackupInput
func (s *CreateFileSystemFromBackupInput) SetBackupId(v string) *CreateFileSystemFromBackupInput
func (s *CreateFileSystemFromBackupInput) SetClientRequestToken(v string) *CreateFileSystemFromBackupInput
func (s *CreateFileSystemFromBackupInput) SetSecurityGroupIds(v []*string) *CreateFileSystemFromBackupInput
func (s *CreateFileSystemFromBackupInput) SetSubnetIds(v []*string) *CreateFileSystemFromBackupInput
func (s *CreateFileSystemFromBackupInput) SetTags(v []*Tag) *CreateFileSystemFromBackupInput
func (s *CreateFileSystemFromBackupInput) SetWindowsConfiguration(v *CreateFileSystemWindowsConfiguration) *CreateFileSystemFromBackupInput
type CreateFileSystemFromBackupOutput
func (s *CreateFileSystemFromBackupOutput) SetFileSystem(v *FileSystem) *CreateFileSystemFromBackupOutput
type CreateFileSystemInput
func (s *CreateFileSystemInput) SetClientRequestToken(v string) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetFileSystemType(v string) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetKmsKeyId(v string) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetLustreConfiguration(v *CreateFileSystemLustreConfiguration) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetSecurityGroupIds(v []*string) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetStorageCapacity(v int64) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetSubnetIds(v []*string) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetTags(v []*Tag) *CreateFileSystemInput
func (s *CreateFileSystemInput) SetWindowsConfiguration(v *CreateFileSystemWindowsConfiguration) *CreateFileSystemInput
type CreateFileSystemLustreConfiguration
func (s *CreateFileSystemLustreConfiguration) SetExportPath(v string) *CreateFileSystemLustreConfiguration
func (s *CreateFileSystemLustreConfiguration) SetImportPath(v string) *CreateFileSystemLustreConfiguration
func (s *CreateFileSystemLustreConfiguration) SetImportedFileChunkSize(v int64) *CreateFileSystemLustreConfiguration
func (s *CreateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime(v string) *CreateFileSystemLustreConfiguration
type CreateFileSystemOutput
func (s *CreateFileSystemOutput) SetFileSystem(v *FileSystem) *CreateFileSystemOutput
type CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetActiveDirectoryId(v string) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetAutomaticBackupRetentionDays(v int64) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetCopyTagsToBackups(v bool) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetDailyAutomaticBackupStartTime(v string) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetDeploymentType(v string) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetPreferredSubnetId(v string) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetSelfManagedActiveDirectoryConfiguration(v *SelfManagedActiveDirectoryConfiguration) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetThroughputCapacity(v int64) *CreateFileSystemWindowsConfiguration
func (s *CreateFileSystemWindowsConfiguration) SetWeeklyMaintenanceStartTime(v string) *CreateFileSystemWindowsConfiguration
type DataRepositoryConfiguration
func (s *DataRepositoryConfiguration) SetExportPath(v string) *DataRepositoryConfiguration
func (s *DataRepositoryConfiguration) SetImportPath(v string) *DataRepositoryConfiguration
func (s *DataRepositoryConfiguration) SetImportedFileChunkSize(v int64) *DataRepositoryConfiguration
type DeleteBackupInput
func (s *DeleteBackupInput) SetBackupId(v string) *DeleteBackupInput
func (s *DeleteBackupInput) SetClientRequestToken(v string) *DeleteBackupInput
type DeleteBackupOutput
func (s *DeleteBackupOutput) SetBackupId(v string) *DeleteBackupOutput
func (s *DeleteBackupOutput) SetLifecycle(v string) *DeleteBackupOutput
type DeleteFileSystemInput
func (s *DeleteFileSystemInput) SetClientRequestToken(v string) *DeleteFileSystemInput
func (s *DeleteFileSystemInput) SetFileSystemId(v string) *DeleteFileSystemInput
func (s *DeleteFileSystemInput) SetWindowsConfiguration(v *DeleteFileSystemWindowsConfiguration) *DeleteFileSystemInput
type DeleteFileSystemOutput
func (s *DeleteFileSystemOutput) SetFileSystemId(v string) *DeleteFileSystemOutput
func (s *DeleteFileSystemOutput) SetLifecycle(v string) *DeleteFileSystemOutput
func (s *DeleteFileSystemOutput) SetWindowsResponse(v *DeleteFileSystemWindowsResponse) *DeleteFileSystemOutput
type DeleteFileSystemWindowsConfiguration
func (s *DeleteFileSystemWindowsConfiguration) SetFinalBackupTags(v []*Tag) *DeleteFileSystemWindowsConfiguration
func (s *DeleteFileSystemWindowsConfiguration) SetSkipFinalBackup(v bool) *DeleteFileSystemWindowsConfiguration
type DeleteFileSystemWindowsResponse
func (s *DeleteFileSystemWindowsResponse) SetFinalBackupId(v string) *DeleteFileSystemWindowsResponse
func (s *DeleteFileSystemWindowsResponse) SetFinalBackupTags(v []*Tag) *DeleteFileSystemWindowsResponse
type DescribeBackupsInput
func (s *DescribeBackupsInput) SetBackupIds(v []*string) *DescribeBackupsInput
func (s *DescribeBackupsInput) SetFilters(v []*Filter) *DescribeBackupsInput
func (s *DescribeBackupsInput) SetMaxResults(v int64) *DescribeBackupsInput
func (s *DescribeBackupsInput) SetNextToken(v string) *DescribeBackupsInput
type DescribeBackupsOutput
func (s *DescribeBackupsOutput) SetBackups(v []*Backup) *DescribeBackupsOutput
func (s *DescribeBackupsOutput) SetNextToken(v string) *DescribeBackupsOutput
type DescribeFileSystemsInput
func (s *DescribeFileSystemsInput) SetFileSystemIds(v []*string) *DescribeFileSystemsInput
func (s *DescribeFileSystemsInput) SetMaxResults(v int64) *DescribeFileSystemsInput
func (s *DescribeFileSystemsInput) SetNextToken(v string) *DescribeFileSystemsInput
type DescribeFileSystemsOutput
func (s *DescribeFileSystemsOutput) SetFileSystems(v []*FileSystem) *DescribeFileSystemsOutput
func (s *DescribeFileSystemsOutput) SetNextToken(v string) *DescribeFileSystemsOutput
type FSx
type FileSystem
func (s *FileSystem) SetCreationTime(v time.Time) *FileSystem
func (s *FileSystem) SetDNSName(v string) *FileSystem
func (s *FileSystem) SetFailureDetails(v *FileSystemFailureDetails) *FileSystem
func (s *FileSystem) SetFileSystemId(v string) *FileSystem
func (s *FileSystem) SetFileSystemType(v string) *FileSystem
func (s *FileSystem) SetKmsKeyId(v string) *FileSystem
func (s *FileSystem) SetLifecycle(v string) *FileSystem
func (s *FileSystem) SetLustreConfiguration(v *LustreFileSystemConfiguration) *FileSystem
func (s *FileSystem) SetNetworkInterfaceIds(v []*string) *FileSystem
func (s *FileSystem) SetOwnerId(v string) *FileSystem
func (s *FileSystem) SetResourceARN(v string) *FileSystem
func (s *FileSystem) SetStorageCapacity(v int64) *FileSystem
func (s *FileSystem) SetSubnetIds(v []*string) *FileSystem
func (s *FileSystem) SetTags(v []*Tag) *FileSystem
func (s *FileSystem) SetVpcId(v string) *FileSystem
func (s *FileSystem) SetWindowsConfiguration(v *WindowsFileSystemConfiguration) *FileSystem
type FileSystemFailureDetails
func (s *FileSystemFailureDetails) SetMessage(v string) *FileSystemFailureDetails
type Filter
func (s *Filter) SetName(v string) *Filter
func (s *Filter) SetValues(v []*string) *Filter
type ListTagsForResourceInput
func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput
func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput
func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput
type ListTagsForResourceOutput
func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput
func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput
type LustreFileSystemConfiguration
func (s *LustreFileSystemConfiguration) SetDataRepositoryConfiguration(v *DataRepositoryConfiguration) *LustreFileSystemConfiguration
func (s *LustreFileSystemConfiguration) SetWeeklyMaintenanceStartTime(v string) *LustreFileSystemConfiguration
type SelfManagedActiveDirectoryAttributes
func (s *SelfManagedActiveDirectoryAttributes) SetDnsIps(v []*string) *SelfManagedActiveDirectoryAttributes
func (s *SelfManagedActiveDirectoryAttributes) SetDomainName(v string) *SelfManagedActiveDirectoryAttributes
func (s *SelfManagedActiveDirectoryAttributes) SetFileSystemAdministratorsGroup(v string) *SelfManagedActiveDirectoryAttributes
func (s *SelfManagedActiveDirectoryAttributes) SetOrganizationalUnitDistinguishedName(v string) *SelfManagedActiveDirectoryAttributes
func (s *SelfManagedActiveDirectoryAttributes) SetUserName(v string) *SelfManagedActiveDirectoryAttributes
type SelfManagedActiveDirectoryConfiguration
func (s *SelfManagedActiveDirectoryConfiguration) SetDnsIps(v []*string) *SelfManagedActiveDirectoryConfiguration
func (s *SelfManagedActiveDirectoryConfiguration) SetDomainName(v string) *SelfManagedActiveDirectoryConfiguration
func (s *SelfManagedActiveDirectoryConfiguration) SetFileSystemAdministratorsGroup(v string) *SelfManagedActiveDirectoryConfiguration
func (s *SelfManagedActiveDirectoryConfiguration) SetOrganizationalUnitDistinguishedName(v string) *SelfManagedActiveDirectoryConfiguration
func (s *SelfManagedActiveDirectoryConfiguration) SetPassword(v string) *SelfManagedActiveDirectoryConfiguration
func (s *SelfManagedActiveDirectoryConfiguration) SetUserName(v string) *SelfManagedActiveDirectoryConfiguration
type SelfManagedActiveDirectoryConfigurationUpdates
func (s *SelfManagedActiveDirectoryConfigurationUpdates) SetDnsIps(v []*string) *SelfManagedActiveDirectoryConfigurationUpdates
func (s *SelfManagedActiveDirectoryConfigurationUpdates) SetPassword(v string) *SelfManagedActiveDirectoryConfigurationUpdates
func (s *SelfManagedActiveDirectoryConfigurationUpdates) SetUserName(v string) *SelfManagedActiveDirectoryConfigurationUpdates
type Tag
func (s *Tag) SetKey(v string) *Tag
func (s *Tag) SetValue(v string) *Tag
type TagResourceInput
func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput
func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput
type TagResourceOutput
type UntagResourceInput
func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
type UntagResourceOutput
type UpdateFileSystemInput
func (s *UpdateFileSystemInput) SetClientRequestToken(v string) *UpdateFileSystemInput
func (s *UpdateFileSystemInput) SetFileSystemId(v string) *UpdateFileSystemInput
func (s *UpdateFileSystemInput) SetLustreConfiguration(v *UpdateFileSystemLustreConfiguration) *UpdateFileSystemInput
func (s *UpdateFileSystemInput) SetWindowsConfiguration(v *UpdateFileSystemWindowsConfiguration) *UpdateFileSystemInput
type UpdateFileSystemLustreConfiguration
func (s *UpdateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime(v string) *UpdateFileSystemLustreConfiguration
type UpdateFileSystemOutput
func (s *UpdateFileSystemOutput) SetFileSystem(v *FileSystem) *UpdateFileSystemOutput
type UpdateFileSystemWindowsConfiguration
func (s *UpdateFileSystemWindowsConfiguration) SetAutomaticBackupRetentionDays(v int64) *UpdateFileSystemWindowsConfiguration
func (s *UpdateFileSystemWindowsConfiguration) SetDailyAutomaticBackupStartTime(v string) *UpdateFileSystemWindowsConfiguration
func (s *UpdateFileSystemWindowsConfiguration) SetSelfManagedActiveDirectoryConfiguration(v *SelfManagedActiveDirectoryConfigurationUpdates) *UpdateFileSystemWindowsConfiguration
func (s *UpdateFileSystemWindowsConfiguration) SetWeeklyMaintenanceStartTime(v string) *UpdateFileSystemWindowsConfiguration
type WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetActiveDirectoryId(v string) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetAutomaticBackupRetentionDays(v int64) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetCopyTagsToBackups(v bool) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetDailyAutomaticBackupStartTime(v string) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetDeploymentType(v string) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetMaintenanceOperationsInProgress(v []*string) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetPreferredFileServerIp(v string) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetPreferredSubnetId(v string) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetRemoteAdministrationEndpoint(v string) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetSelfManagedActiveDirectoryConfiguration(v *SelfManagedActiveDirectoryAttributes) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetThroughputCapacity(v int64) *WindowsFileSystemConfiguration
func (s *WindowsFileSystemConfiguration) SetWeeklyMaintenanceStartTime(v string) *WindowsFileSystemConfiguration

Constants ▾

const (
    // ActiveDirectoryErrorTypeDomainNotFound is a ActiveDirectoryErrorType enum value
    ActiveDirectoryErrorTypeDomainNotFound = "DOMAIN_NOT_FOUND"

    // ActiveDirectoryErrorTypeIncompatibleDomainMode is a ActiveDirectoryErrorType enum value
    ActiveDirectoryErrorTypeIncompatibleDomainMode = "INCOMPATIBLE_DOMAIN_MODE"

    // ActiveDirectoryErrorTypeWrongVpc is a ActiveDirectoryErrorType enum value
    ActiveDirectoryErrorTypeWrongVpc = "WRONG_VPC"

    // ActiveDirectoryErrorTypeInvalidDomainStage is a ActiveDirectoryErrorType enum value
    ActiveDirectoryErrorTypeInvalidDomainStage = "INVALID_DOMAIN_STAGE"
)

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 (
    // BackupLifecycleAvailable is a BackupLifecycle enum value
    BackupLifecycleAvailable = "AVAILABLE"

    // BackupLifecycleCreating is a BackupLifecycle enum value
    BackupLifecycleCreating = "CREATING"

    // BackupLifecycleDeleted is a BackupLifecycle enum value
    BackupLifecycleDeleted = "DELETED"

    // BackupLifecycleFailed is a BackupLifecycle enum value
    BackupLifecycleFailed = "FAILED"
)

The lifecycle status of the backup.

const (
    // BackupTypeAutomatic is a BackupType enum value
    BackupTypeAutomatic = "AUTOMATIC"

    // BackupTypeUserInitiated is a BackupType enum value
    BackupTypeUserInitiated = "USER_INITIATED"
)

The type of the backup.

const (
    // FileSystemLifecycleAvailable is a FileSystemLifecycle enum value
    FileSystemLifecycleAvailable = "AVAILABLE"

    // FileSystemLifecycleCreating is a FileSystemLifecycle enum value
    FileSystemLifecycleCreating = "CREATING"

    // FileSystemLifecycleFailed is a FileSystemLifecycle enum value
    FileSystemLifecycleFailed = "FAILED"

    // FileSystemLifecycleDeleting is a FileSystemLifecycle enum value
    FileSystemLifecycleDeleting = "DELETING"

    // FileSystemLifecycleMisconfigured is a FileSystemLifecycle enum value
    FileSystemLifecycleMisconfigured = "MISCONFIGURED"

    // FileSystemLifecycleUpdating is a FileSystemLifecycle enum value
    FileSystemLifecycleUpdating = "UPDATING"
)

The lifecycle status of the file system.

const (
    // FileSystemMaintenanceOperationPatching is a FileSystemMaintenanceOperation enum value
    FileSystemMaintenanceOperationPatching = "PATCHING"

    // FileSystemMaintenanceOperationBackingUp is a FileSystemMaintenanceOperation enum value
    FileSystemMaintenanceOperationBackingUp = "BACKING_UP"
)

An enumeration specifying the currently ongoing maintenance operation.

const (
    // FileSystemTypeWindows is a FileSystemType enum value
    FileSystemTypeWindows = "WINDOWS"

    // FileSystemTypeLustre is a FileSystemType enum value
    FileSystemTypeLustre = "LUSTRE"
)

The type of file system.

const (
    // FilterNameFileSystemId is a FilterName enum value
    FilterNameFileSystemId = "file-system-id"

    // FilterNameBackupType is a FilterName enum value
    FilterNameBackupType = "backup-type"
)

The name for a filter.

const (
    // ServiceLimitFileSystemCount is a ServiceLimit enum value
    ServiceLimitFileSystemCount = "FILE_SYSTEM_COUNT"

    // ServiceLimitTotalThroughputCapacity is a ServiceLimit enum value
    ServiceLimitTotalThroughputCapacity = "TOTAL_THROUGHPUT_CAPACITY"

    // ServiceLimitTotalStorage is a ServiceLimit enum value
    ServiceLimitTotalStorage = "TOTAL_STORAGE"

    // ServiceLimitTotalUserInitiatedBackups is a ServiceLimit enum value
    ServiceLimitTotalUserInitiatedBackups = "TOTAL_USER_INITIATED_BACKUPS"
)

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 (
    // WindowsDeploymentTypeMultiAz1 is a WindowsDeploymentType enum value
    WindowsDeploymentTypeMultiAz1 = "MULTI_AZ_1"

    // WindowsDeploymentTypeSingleAz1 is a WindowsDeploymentType enum value
    WindowsDeploymentTypeSingleAz1 = "SINGLE_AZ_1"
)
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"

    // 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"

    // ErrCodeMissingFileSystemConfiguration for service response error code
    // "MissingFileSystemConfiguration".
    //
    // 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".
    //
    // An error occured.
    ErrCodeUnsupportedOperation = "UnsupportedOperation"
)
const (
    ServiceName = "FSx" // Name of service.
    EndpointsID = "fsx" // ID to lookup a service endpoint with.
    ServiceID   = "FSx" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type ActiveDirectoryBackupAttributes

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

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

func (ActiveDirectoryBackupAttributes) GoString

func (s ActiveDirectoryBackupAttributes) GoString() string

GoString returns the string representation

func (*ActiveDirectoryBackupAttributes) SetActiveDirectoryId

func (s *ActiveDirectoryBackupAttributes) SetActiveDirectoryId(v string) *ActiveDirectoryBackupAttributes

SetActiveDirectoryId sets the ActiveDirectoryId field's value.

func (*ActiveDirectoryBackupAttributes) SetDomainName

func (s *ActiveDirectoryBackupAttributes) SetDomainName(v string) *ActiveDirectoryBackupAttributes

SetDomainName sets the DomainName field's value.

func (ActiveDirectoryBackupAttributes) String

func (s ActiveDirectoryBackupAttributes) String() string

String returns the string representation

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's data.
    KmsKeyId *string `min:"1" type:"string"`

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

    // 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 *string `type:"string" required:"true" enum:"BackupType"`
    // contains filtered or unexported fields
}

A backup of an Amazon FSx for Windows File Server file system. You can create a new file system from a backup to protect against data loss.

func (Backup) GoString

func (s Backup) GoString() string

GoString returns the string representation

func (*Backup) SetBackupId

func (s *Backup) SetBackupId(v string) *Backup

SetBackupId sets the BackupId field's value.

func (*Backup) SetCreationTime

func (s *Backup) SetCreationTime(v time.Time) *Backup

SetCreationTime sets the CreationTime field's value.

func (*Backup) SetDirectoryInformation

func (s *Backup) SetDirectoryInformation(v *ActiveDirectoryBackupAttributes) *Backup

SetDirectoryInformation sets the DirectoryInformation field's value.

func (*Backup) SetFailureDetails

func (s *Backup) SetFailureDetails(v *BackupFailureDetails) *Backup

SetFailureDetails sets the FailureDetails field's value.

func (*Backup) SetFileSystem

func (s *Backup) SetFileSystem(v *FileSystem) *Backup

SetFileSystem sets the FileSystem field's value.

func (*Backup) SetKmsKeyId

func (s *Backup) SetKmsKeyId(v string) *Backup

SetKmsKeyId sets the KmsKeyId field's value.

func (*Backup) SetLifecycle

func (s *Backup) SetLifecycle(v string) *Backup

SetLifecycle sets the Lifecycle field's value.

func (*Backup) SetProgressPercent

func (s *Backup) SetProgressPercent(v int64) *Backup

SetProgressPercent sets the ProgressPercent field's value.

func (*Backup) SetResourceARN

func (s *Backup) SetResourceARN(v string) *Backup

SetResourceARN sets the ResourceARN field's value.

func (*Backup) SetTags

func (s *Backup) SetTags(v []*Tag) *Backup

SetTags sets the Tags field's value.

func (*Backup) SetType

func (s *Backup) SetType(v string) *Backup

SetType sets the Type field's value.

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

func (s BackupFailureDetails) GoString() string

GoString returns the string representation

func (*BackupFailureDetails) SetMessage

func (s *BackupFailureDetails) SetMessage(v string) *BackupFailureDetails

SetMessage sets the Message field's value.

func (BackupFailureDetails) String

func (s BackupFailureDetails) String() string

String returns the string representation

type CreateBackupInput

type CreateBackupInput struct {

    // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
    // ensure idempotent creation. This string is automatically filled on your behalf
    // when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
    ClientRequestToken *string `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.
    Tags []*Tag `min:"1" type:"list"`
    // contains filtered or unexported fields
}

The request object for the CreateBackup operation.

func (CreateBackupInput) GoString

func (s CreateBackupInput) GoString() string

GoString returns the string representation

func (*CreateBackupInput) SetClientRequestToken

func (s *CreateBackupInput) SetClientRequestToken(v string) *CreateBackupInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateBackupInput) SetFileSystemId

func (s *CreateBackupInput) SetFileSystemId(v string) *CreateBackupInput

SetFileSystemId sets the FileSystemId field's value.

func (*CreateBackupInput) SetTags

func (s *CreateBackupInput) SetTags(v []*Tag) *CreateBackupInput

SetTags sets the Tags field's value.

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

func (s CreateBackupOutput) GoString() string

GoString returns the string representation

func (*CreateBackupOutput) SetBackup

func (s *CreateBackupOutput) SetBackup(v *Backup) *CreateBackupOutput

SetBackup sets the Backup field's value.

func (CreateBackupOutput) String

func (s CreateBackupOutput) String() string

String returns the string representation

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"`

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

    // A list of IDs for the security groups that apply to the specified network
    // interfaces created for file system access. These security groups apply to
    // all network interfaces. This value isn't returned in later describe requests.
    SecurityGroupIds []*string `type:"list"`

    // A list of IDs for the subnets that the file system will be accessible from.
    // Currently, you can specify only one subnet. The file server is also launched
    // in that subnet's Availability Zone.
    //
    // 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) GoString

func (s CreateFileSystemFromBackupInput) GoString() string

GoString returns the string representation

func (*CreateFileSystemFromBackupInput) SetBackupId

func (s *CreateFileSystemFromBackupInput) SetBackupId(v string) *CreateFileSystemFromBackupInput

SetBackupId sets the BackupId field's value.

func (*CreateFileSystemFromBackupInput) SetClientRequestToken

func (s *CreateFileSystemFromBackupInput) SetClientRequestToken(v string) *CreateFileSystemFromBackupInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateFileSystemFromBackupInput) SetSecurityGroupIds

func (s *CreateFileSystemFromBackupInput) SetSecurityGroupIds(v []*string) *CreateFileSystemFromBackupInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateFileSystemFromBackupInput) SetSubnetIds

func (s *CreateFileSystemFromBackupInput) SetSubnetIds(v []*string) *CreateFileSystemFromBackupInput

SetSubnetIds sets the SubnetIds field's value.

func (*CreateFileSystemFromBackupInput) SetTags

func (s *CreateFileSystemFromBackupInput) SetTags(v []*Tag) *CreateFileSystemFromBackupInput

SetTags sets the Tags field's value.

func (*CreateFileSystemFromBackupInput) SetWindowsConfiguration

func (s *CreateFileSystemFromBackupInput) SetWindowsConfiguration(v *CreateFileSystemWindowsConfiguration) *CreateFileSystemFromBackupInput

SetWindowsConfiguration sets the WindowsConfiguration field's value.

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

func (s CreateFileSystemFromBackupOutput) GoString() string

GoString returns the string representation

func (*CreateFileSystemFromBackupOutput) SetFileSystem

func (s *CreateFileSystemFromBackupOutput) SetFileSystem(v *FileSystem) *CreateFileSystemFromBackupOutput

SetFileSystem sets the FileSystem field's value.

func (CreateFileSystemFromBackupOutput) String

func (s CreateFileSystemFromBackupOutput) String() string

String returns the string representation

type CreateFileSystemInput

type CreateFileSystemInput struct {

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

    // The type of Amazon FSx file system to create.
    //
    // FileSystemType is a required field
    FileSystemType *string `type:"string" required:"true" enum:"FileSystemType"`

    // The ID of your AWS Key Management Service (AWS KMS) key. This ID is used
    // to encrypt the data in your file system at rest. 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. This value is
    // required if FileSystemType is set to LUSTRE.
    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"`

    // The storage capacity of the file system being created.
    //
    // For Windows file systems, valid values are 32 GiB - 65,536 GiB.
    //
    // For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing
    // in increments of 3600 GiB.
    //
    // StorageCapacity is a required field
    StorageCapacity *int64 `min:"1" type:"integer" required:"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 standy
    // file server. You specify one of these subnets as the preferred subnet using
    // the WindowsConfiguration > PreferredSubnetID property.
    //
    // For Windows SINGLE_AZ_1 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. This
    // value is required if FileSystemType is set to WINDOWS.
    WindowsConfiguration *CreateFileSystemWindowsConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

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

func (CreateFileSystemInput) GoString

func (s CreateFileSystemInput) GoString() string

GoString returns the string representation

func (*CreateFileSystemInput) SetClientRequestToken

func (s *CreateFileSystemInput) SetClientRequestToken(v string) *CreateFileSystemInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateFileSystemInput) SetFileSystemType

func (s *CreateFileSystemInput) SetFileSystemType(v string) *CreateFileSystemInput

SetFileSystemType sets the FileSystemType field's value.

func (*CreateFileSystemInput) SetKmsKeyId

func (s *CreateFileSystemInput) SetKmsKeyId(v string) *CreateFileSystemInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateFileSystemInput) SetLustreConfiguration

func (s *CreateFileSystemInput) SetLustreConfiguration(v *CreateFileSystemLustreConfiguration) *CreateFileSystemInput

SetLustreConfiguration sets the LustreConfiguration field's value.

func (*CreateFileSystemInput) SetSecurityGroupIds

func (s *CreateFileSystemInput) SetSecurityGroupIds(v []*string) *CreateFileSystemInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateFileSystemInput) SetStorageCapacity

func (s *CreateFileSystemInput) SetStorageCapacity(v int64) *CreateFileSystemInput

SetStorageCapacity sets the StorageCapacity field's value.

func (*CreateFileSystemInput) SetSubnetIds

func (s *CreateFileSystemInput) SetSubnetIds(v []*string) *CreateFileSystemInput

SetSubnetIds sets the SubnetIds field's value.

func (*CreateFileSystemInput) SetTags

func (s *CreateFileSystemInput) SetTags(v []*Tag) *CreateFileSystemInput

SetTags sets the Tags field's value.

func (*CreateFileSystemInput) SetWindowsConfiguration

func (s *CreateFileSystemInput) SetWindowsConfiguration(v *CreateFileSystemWindowsConfiguration) *CreateFileSystemInput

SetWindowsConfiguration sets the WindowsConfiguration field's value.

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 {

    // (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 chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000
    // MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
    ImportedFileChunkSize *int64 `min:"1" type:"integer"`

    // The preferred time to perform weekly maintenance, in the UTC time zone.
    WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
    // contains filtered or unexported fields
}

The Lustre configuration for the file system being created. This value is required if FileSystemType is set to LUSTRE.

func (CreateFileSystemLustreConfiguration) GoString

func (s CreateFileSystemLustreConfiguration) GoString() string

GoString returns the string representation

func (*CreateFileSystemLustreConfiguration) SetExportPath

func (s *CreateFileSystemLustreConfiguration) SetExportPath(v string) *CreateFileSystemLustreConfiguration

SetExportPath sets the ExportPath field's value.

func (*CreateFileSystemLustreConfiguration) SetImportPath

func (s *CreateFileSystemLustreConfiguration) SetImportPath(v string) *CreateFileSystemLustreConfiguration

SetImportPath sets the ImportPath field's value.

func (*CreateFileSystemLustreConfiguration) SetImportedFileChunkSize

func (s *CreateFileSystemLustreConfiguration) SetImportedFileChunkSize(v int64) *CreateFileSystemLustreConfiguration

SetImportedFileChunkSize sets the ImportedFileChunkSize field's value.

func (*CreateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime

func (s *CreateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime(v string) *CreateFileSystemLustreConfiguration

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

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

func (s CreateFileSystemOutput) GoString() string

GoString returns the string representation

func (*CreateFileSystemOutput) SetFileSystem

func (s *CreateFileSystemOutput) SetFileSystem(v *FileSystem) *CreateFileSystemOutput

SetFileSystem sets the FileSystem field's value.

func (CreateFileSystemOutput) String

func (s CreateFileSystemOutput) String() string

String returns the string representation

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.
    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.
    //
    //    * SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured
    //    for single AZ redundancy.
    //
    // To learn more about high availability Multi-AZ file systems, see High Availability
    // for Amazon FSx for Windows File Server (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html).
    DeploymentType *string `type:"string" enum:"WindowsDeploymentType"`

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

func (s CreateFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation

func (*CreateFileSystemWindowsConfiguration) SetActiveDirectoryId

func (s *CreateFileSystemWindowsConfiguration) SetActiveDirectoryId(v string) *CreateFileSystemWindowsConfiguration

SetActiveDirectoryId sets the ActiveDirectoryId field's value.

func (*CreateFileSystemWindowsConfiguration) SetAutomaticBackupRetentionDays

func (s *CreateFileSystemWindowsConfiguration) SetAutomaticBackupRetentionDays(v int64) *CreateFileSystemWindowsConfiguration

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*CreateFileSystemWindowsConfiguration) SetCopyTagsToBackups

func (s *CreateFileSystemWindowsConfiguration) SetCopyTagsToBackups(v bool) *CreateFileSystemWindowsConfiguration

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*CreateFileSystemWindowsConfiguration) SetDailyAutomaticBackupStartTime

func (s *CreateFileSystemWindowsConfiguration) SetDailyAutomaticBackupStartTime(v string) *CreateFileSystemWindowsConfiguration

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*CreateFileSystemWindowsConfiguration) SetDeploymentType

func (s *CreateFileSystemWindowsConfiguration) SetDeploymentType(v string) *CreateFileSystemWindowsConfiguration

SetDeploymentType sets the DeploymentType field's value.

func (*CreateFileSystemWindowsConfiguration) SetPreferredSubnetId

func (s *CreateFileSystemWindowsConfiguration) SetPreferredSubnetId(v string) *CreateFileSystemWindowsConfiguration

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*CreateFileSystemWindowsConfiguration) SetSelfManagedActiveDirectoryConfiguration

func (s *CreateFileSystemWindowsConfiguration) SetSelfManagedActiveDirectoryConfiguration(v *SelfManagedActiveDirectoryConfiguration) *CreateFileSystemWindowsConfiguration

SetSelfManagedActiveDirectoryConfiguration sets the SelfManagedActiveDirectoryConfiguration field's value.

func (*CreateFileSystemWindowsConfiguration) SetThroughputCapacity

func (s *CreateFileSystemWindowsConfiguration) SetThroughputCapacity(v int64) *CreateFileSystemWindowsConfiguration

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*CreateFileSystemWindowsConfiguration) SetWeeklyMaintenanceStartTime

func (s *CreateFileSystemWindowsConfiguration) SetWeeklyMaintenanceStartTime(v string) *CreateFileSystemWindowsConfiguration

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

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

func (s DataRepositoryConfiguration) GoString() string

GoString returns the string representation

func (*DataRepositoryConfiguration) SetExportPath

func (s *DataRepositoryConfiguration) SetExportPath(v string) *DataRepositoryConfiguration

SetExportPath sets the ExportPath field's value.

func (*DataRepositoryConfiguration) SetImportPath

func (s *DataRepositoryConfiguration) SetImportPath(v string) *DataRepositoryConfiguration

SetImportPath sets the ImportPath field's value.

func (*DataRepositoryConfiguration) SetImportedFileChunkSize

func (s *DataRepositoryConfiguration) SetImportedFileChunkSize(v int64) *DataRepositoryConfiguration

SetImportedFileChunkSize sets the ImportedFileChunkSize field's value.

func (DataRepositoryConfiguration) String

func (s DataRepositoryConfiguration) String() string

String returns the string representation

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"`

    // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
    // ensure idempotent deletion. This is automatically filled on your behalf when
    // using the AWS CLI or SDK.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`
    // contains filtered or unexported fields
}

The request object for DeleteBackup operation.

func (DeleteBackupInput) GoString

func (s DeleteBackupInput) GoString() string

GoString returns the string representation

func (*DeleteBackupInput) SetBackupId

func (s *DeleteBackupInput) SetBackupId(v string) *DeleteBackupInput

SetBackupId sets the BackupId field's value.

func (*DeleteBackupInput) SetClientRequestToken

func (s *DeleteBackupInput) SetClientRequestToken(v string) *DeleteBackupInput

SetClientRequestToken sets the ClientRequestToken field's value.

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

The response object for DeleteBackup operation.

func (DeleteBackupOutput) GoString

func (s DeleteBackupOutput) GoString() string

GoString returns the string representation

func (*DeleteBackupOutput) SetBackupId

func (s *DeleteBackupOutput) SetBackupId(v string) *DeleteBackupOutput

SetBackupId sets the BackupId field's value.

func (*DeleteBackupOutput) SetLifecycle

func (s *DeleteBackupOutput) SetLifecycle(v string) *DeleteBackupOutput

SetLifecycle sets the Lifecycle field's value.

func (DeleteBackupOutput) String

func (s DeleteBackupOutput) String() string

String returns the string representation

type DeleteFileSystemInput

type DeleteFileSystemInput struct {

    // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
    // ensure idempotent deletion. This is automatically filled on your behalf when
    // using the AWS CLI or SDK.
    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 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) GoString

func (s DeleteFileSystemInput) GoString() string

GoString returns the string representation

func (*DeleteFileSystemInput) SetClientRequestToken

func (s *DeleteFileSystemInput) SetClientRequestToken(v string) *DeleteFileSystemInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteFileSystemInput) SetFileSystemId

func (s *DeleteFileSystemInput) SetFileSystemId(v string) *DeleteFileSystemInput

SetFileSystemId sets the FileSystemId field's value.

func (*DeleteFileSystemInput) SetWindowsConfiguration

func (s *DeleteFileSystemInput) SetWindowsConfiguration(v *DeleteFileSystemWindowsConfiguration) *DeleteFileSystemInput

SetWindowsConfiguration sets the WindowsConfiguration field's value.

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 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 *string `type:"string" enum:"FileSystemLifecycle"`

    // 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) GoString

func (s DeleteFileSystemOutput) GoString() string

GoString returns the string representation

func (*DeleteFileSystemOutput) SetFileSystemId

func (s *DeleteFileSystemOutput) SetFileSystemId(v string) *DeleteFileSystemOutput

SetFileSystemId sets the FileSystemId field's value.

func (*DeleteFileSystemOutput) SetLifecycle

func (s *DeleteFileSystemOutput) SetLifecycle(v string) *DeleteFileSystemOutput

SetLifecycle sets the Lifecycle field's value.

func (*DeleteFileSystemOutput) SetWindowsResponse

func (s *DeleteFileSystemOutput) SetWindowsResponse(v *DeleteFileSystemWindowsResponse) *DeleteFileSystemOutput

SetWindowsResponse sets the WindowsResponse field's value.

func (DeleteFileSystemOutput) String

func (s DeleteFileSystemOutput) String() string

String returns the string representation

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

func (s DeleteFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation

func (*DeleteFileSystemWindowsConfiguration) SetFinalBackupTags

func (s *DeleteFileSystemWindowsConfiguration) SetFinalBackupTags(v []*Tag) *DeleteFileSystemWindowsConfiguration

SetFinalBackupTags sets the FinalBackupTags field's value.

func (*DeleteFileSystemWindowsConfiguration) SetSkipFinalBackup

func (s *DeleteFileSystemWindowsConfiguration) SetSkipFinalBackup(v bool) *DeleteFileSystemWindowsConfiguration

SetSkipFinalBackup sets the SkipFinalBackup field's value.

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

func (s DeleteFileSystemWindowsResponse) GoString() string

GoString returns the string representation

func (*DeleteFileSystemWindowsResponse) SetFinalBackupId

func (s *DeleteFileSystemWindowsResponse) SetFinalBackupId(v string) *DeleteFileSystemWindowsResponse

SetFinalBackupId sets the FinalBackupId field's value.

func (*DeleteFileSystemWindowsResponse) SetFinalBackupTags

func (s *DeleteFileSystemWindowsResponse) SetFinalBackupTags(v []*Tag) *DeleteFileSystemWindowsResponse

SetFinalBackupTags sets the FinalBackupTags field's value.

func (DeleteFileSystemWindowsResponse) String

func (s DeleteFileSystemWindowsResponse) String() string

String returns the string representation

type DescribeBackupsInput

type DescribeBackupsInput struct {

    // (Optional) 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"`

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

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

    // (Optional) Opaque pagination token returned from a previous DescribeBackups
    // operation (String). If a token present, the action continues the list from
    // where the returning call left off.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

The request object for DescribeBackups operation.

func (DescribeBackupsInput) GoString

func (s DescribeBackupsInput) GoString() string

GoString returns the string representation

func (*DescribeBackupsInput) SetBackupIds

func (s *DescribeBackupsInput) SetBackupIds(v []*string) *DescribeBackupsInput

SetBackupIds sets the BackupIds field's value.

func (*DescribeBackupsInput) SetFilters

func (s *DescribeBackupsInput) SetFilters(v []*Filter) *DescribeBackupsInput

SetFilters sets the Filters field's value.

func (*DescribeBackupsInput) SetMaxResults

func (s *DescribeBackupsInput) SetMaxResults(v int64) *DescribeBackupsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBackupsInput) SetNextToken

func (s *DescribeBackupsInput) SetNextToken(v string) *DescribeBackupsInput

SetNextToken sets the NextToken field's value.

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

func (s DescribeBackupsOutput) GoString() string

GoString returns the string representation

func (*DescribeBackupsOutput) SetBackups

func (s *DescribeBackupsOutput) SetBackups(v []*Backup) *DescribeBackupsOutput

SetBackups sets the Backups field's value.

func (*DescribeBackupsOutput) SetNextToken

func (s *DescribeBackupsOutput) SetNextToken(v string) *DescribeBackupsOutput

SetNextToken sets the NextToken field's value.

func (DescribeBackupsOutput) String

func (s DescribeBackupsOutput) String() string

String returns the string representation

type DescribeFileSystemsInput

type DescribeFileSystemsInput struct {

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

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

    // (Optional) Opaque pagination token returned from a previous DescribeFileSystems
    // operation (String). If a token present, the action continues the list from
    // where the returning call left off.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

The request object for DescribeFileSystems operation.

func (DescribeFileSystemsInput) GoString

func (s DescribeFileSystemsInput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsInput) SetFileSystemIds

func (s *DescribeFileSystemsInput) SetFileSystemIds(v []*string) *DescribeFileSystemsInput

SetFileSystemIds sets the FileSystemIds field's value.

func (*DescribeFileSystemsInput) SetMaxResults

func (s *DescribeFileSystemsInput) SetMaxResults(v int64) *DescribeFileSystemsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeFileSystemsInput) SetNextToken

func (s *DescribeFileSystemsInput) SetNextToken(v string) *DescribeFileSystemsInput

SetNextToken sets the NextToken field's value.

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

func (s DescribeFileSystemsOutput) GoString() string

GoString returns the string representation

func (*DescribeFileSystemsOutput) SetFileSystems

func (s *DescribeFileSystemsOutput) SetFileSystems(v []*FileSystem) *DescribeFileSystemsOutput

SetFileSystems sets the FileSystems field's value.

func (*DescribeFileSystemsOutput) SetNextToken

func (s *DescribeFileSystemsOutput) SetNextToken(v string) *DescribeFileSystemsOutput

SetNextToken sets the NextToken field's value.

func (DescribeFileSystemsOutput) String

func (s DescribeFileSystemsOutput) String() string

String returns the string representation

type FSx

type FSx struct {
    *client.Client
}

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

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

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *FSx

New creates a new instance of the FSx client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a FSx client from just a session.
svc := fsx.New(mySession)

// Create a FSx client with additional configuration
svc := fsx.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*FSx) CreateBackup

func (c *FSx) CreateBackup(input *CreateBackupInput) (*CreateBackupOutput, error)

CreateBackup API operation for Amazon FSx.

Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.

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 CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation CreateBackup for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeUnsupportedOperation "UnsupportedOperation"
An error occured.

* ErrCodeFileSystemNotFound "FileSystemNotFound"
No Amazon FSx file systems were found based upon supplied parameters.

* ErrCodeBackupInProgress "BackupInProgress"
Another backup is already under way. Wait for completion before initiating
additional backups of this file system.

* ErrCodeIncompatibleParameterError "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.

* ErrCodeServiceLimitExceeded "ServiceLimitExceeded"
An error indicating that a particular service limit was exceeded. You can
increase some service limits by contacting AWS Support.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

See also, 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.

Code:

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

result, err := svc.CreateBackup(input)
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)

func (*FSx) CreateBackupRequest

func (c *FSx) CreateBackupRequest(input *CreateBackupInput) (req *request.Request, output *CreateBackupOutput)

CreateBackupRequest generates a "aws/request.Request" representing the client's request for the CreateBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBackup for more information on using the CreateBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateBackupRequest method.
req, resp := client.CreateBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) CreateBackupWithContext

func (c *FSx) CreateBackupWithContext(ctx aws.Context, input *CreateBackupInput, opts ...request.Option) (*CreateBackupOutput, error)

CreateBackupWithContext is the same as CreateBackup with the addition of the ability to pass a context and additional request options.

See CreateBackup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) CreateFileSystem

func (c *FSx) CreateFileSystem(input *CreateFileSystemInput) (*CreateFileSystemOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation CreateFileSystem for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeActiveDirectoryError "ActiveDirectoryError"
An Active Directory error.

* ErrCodeIncompatibleParameterError "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.

* ErrCodeInvalidImportPath "InvalidImportPath"
The path provided for data repository import isn't valid.

* ErrCodeInvalidExportPath "InvalidExportPath"
The path provided for data repository export isn't valid.

* ErrCodeInvalidNetworkSettings "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.

* ErrCodeServiceLimitExceeded "ServiceLimitExceeded"
An error indicating that a particular service limit was exceeded. You can
increase some service limits by contacting AWS Support.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

* ErrCodeMissingFileSystemConfiguration "MissingFileSystemConfiguration"
File system configuration is required for this operation.

See also, 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.

Code:

svc := fsx.New(session.New())
input := &fsx.CreateFileSystemInput{
    ClientRequestToken: aws.String("a8ca07e4-61ec-4399-99f4-19853801bcd5"),
    FileSystemType:     aws.String("WINDOWS"),
    KmsKeyId:           aws.String("arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6"),
    SecurityGroupIds: []*string{
        aws.String("sg-edcd9784"),
    },
    StorageCapacity: aws.Int64(300),
    SubnetIds: []*string{
        aws.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"),
    },
}

result, err := svc.CreateFileSystem(input)
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.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)

func (*FSx) CreateFileSystemFromBackup

func (c *FSx) CreateFileSystemFromBackup(input *CreateFileSystemFromBackupInput) (*CreateFileSystemFromBackupOutput, error)

CreateFileSystemFromBackup API operation for Amazon FSx.

Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation CreateFileSystemFromBackup for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeActiveDirectoryError "ActiveDirectoryError"
An Active Directory error.

* ErrCodeIncompatibleParameterError "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.

* ErrCodeInvalidNetworkSettings "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.

* ErrCodeServiceLimitExceeded "ServiceLimitExceeded"
An error indicating that a particular service limit was exceeded. You can
increase some service limits by contacting AWS Support.

* ErrCodeBackupNotFound "BackupNotFound"
No Amazon FSx backups were found based upon the supplied parameters.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

* ErrCodeMissingFileSystemConfiguration "MissingFileSystemConfiguration"
File system configuration is required for this operation.

See also, 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.

Code:

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

result, err := svc.CreateFileSystemFromBackup(input)
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.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)

func (*FSx) CreateFileSystemFromBackupRequest

func (c *FSx) CreateFileSystemFromBackupRequest(input *CreateFileSystemFromBackupInput) (req *request.Request, output *CreateFileSystemFromBackupOutput)

CreateFileSystemFromBackupRequest generates a "aws/request.Request" representing the client's request for the CreateFileSystemFromBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFileSystemFromBackup for more information on using the CreateFileSystemFromBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFileSystemFromBackupRequest method.
req, resp := client.CreateFileSystemFromBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) CreateFileSystemFromBackupWithContext

func (c *FSx) CreateFileSystemFromBackupWithContext(ctx aws.Context, input *CreateFileSystemFromBackupInput, opts ...request.Option) (*CreateFileSystemFromBackupOutput, error)

CreateFileSystemFromBackupWithContext is the same as CreateFileSystemFromBackup with the addition of the ability to pass a context and additional request options.

See CreateFileSystemFromBackup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) CreateFileSystemRequest

func (c *FSx) CreateFileSystemRequest(input *CreateFileSystemInput) (req *request.Request, output *CreateFileSystemOutput)

CreateFileSystemRequest generates a "aws/request.Request" representing the client's request for the CreateFileSystem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFileSystem for more information on using the CreateFileSystem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFileSystemRequest method.
req, resp := client.CreateFileSystemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) CreateFileSystemWithContext

func (c *FSx) CreateFileSystemWithContext(ctx aws.Context, input *CreateFileSystemInput, opts ...request.Option) (*CreateFileSystemOutput, error)

CreateFileSystemWithContext is the same as CreateFileSystem with the addition of the ability to pass a context and additional request options.

See CreateFileSystem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) DeleteBackup

func (c *FSx) DeleteBackup(input *DeleteBackupInput) (*DeleteBackupOutput, error)

DeleteBackup API operation for Amazon FSx.

Deletes an Amazon FSx for Windows File Server 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation DeleteBackup for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeBackupInProgress "BackupInProgress"
Another backup is already under way. Wait for completion before initiating
additional backups of this file system.

* ErrCodeBackupNotFound "BackupNotFound"
No Amazon FSx backups were found based upon the supplied parameters.

* ErrCodeBackupRestoring "BackupRestoring"
You can't delete a backup while it's being used to restore a file system.

* ErrCodeIncompatibleParameterError "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.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

See also, 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.

Code:

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

result, err := svc.DeleteBackup(input)
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)

func (*FSx) DeleteBackupRequest

func (c *FSx) DeleteBackupRequest(input *DeleteBackupInput) (req *request.Request, output *DeleteBackupOutput)

DeleteBackupRequest generates a "aws/request.Request" representing the client's request for the DeleteBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackup for more information on using the DeleteBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteBackupRequest method.
req, resp := client.DeleteBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) DeleteBackupWithContext

func (c *FSx) DeleteBackupWithContext(ctx aws.Context, input *DeleteBackupInput, opts ...request.Option) (*DeleteBackupOutput, error)

DeleteBackupWithContext is the same as DeleteBackup with the addition of the ability to pass a context and additional request options.

See DeleteBackup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) DeleteFileSystem

func (c *FSx) DeleteFileSystem(input *DeleteFileSystemInput) (*DeleteFileSystemOutput, error)

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

The data in a deleted file system is also deleted and can't be recovered by any means.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation DeleteFileSystem for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeIncompatibleParameterError "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.

* ErrCodeFileSystemNotFound "FileSystemNotFound"
No Amazon FSx file systems were found based upon supplied parameters.

* ErrCodeServiceLimitExceeded "ServiceLimitExceeded"
An error indicating that a particular service limit was exceeded. You can
increase some service limits by contacting AWS Support.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

See also, 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.

Code:

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

result, err := svc.DeleteFileSystem(input)
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)

func (*FSx) DeleteFileSystemRequest

func (c *FSx) DeleteFileSystemRequest(input *DeleteFileSystemInput) (req *request.Request, output *DeleteFileSystemOutput)

DeleteFileSystemRequest generates a "aws/request.Request" representing the client's request for the DeleteFileSystem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFileSystem for more information on using the DeleteFileSystem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFileSystemRequest method.
req, resp := client.DeleteFileSystemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) DeleteFileSystemWithContext

func (c *FSx) DeleteFileSystemWithContext(ctx aws.Context, input *DeleteFileSystemInput, opts ...request.Option) (*DeleteFileSystemOutput, error)

DeleteFileSystemWithContext is the same as DeleteFileSystem with the addition of the ability to pass a context and additional request options.

See DeleteFileSystem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) DescribeBackups

func (c *FSx) DescribeBackups(input *DescribeBackupsInput) (*DescribeBackupsOutput, error)

DescribeBackups API operation for Amazon FSx.

Returns the description of specific Amazon FSx for Windows File Server 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation DescribeBackups for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeFileSystemNotFound "FileSystemNotFound"
No Amazon FSx file systems were found based upon supplied parameters.

* ErrCodeBackupNotFound "BackupNotFound"
No Amazon FSx backups were found based upon the supplied parameters.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

See also, 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.

Code:

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

result, err := svc.DescribeBackups(input)
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)

func (*FSx) DescribeBackupsPages

func (c *FSx) DescribeBackupsPages(input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool) error

DescribeBackupsPages iterates over the pages of a DescribeBackups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBackups method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeBackups operation.
pageNum := 0
err := client.DescribeBackupsPages(params,
    func(page *fsx.DescribeBackupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeBackupsPagesWithContext

func (c *FSx) DescribeBackupsPagesWithContext(ctx aws.Context, input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool, opts ...request.Option) error

DescribeBackupsPagesWithContext same as DescribeBackupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) DescribeBackupsRequest

func (c *FSx) DescribeBackupsRequest(input *DescribeBackupsInput) (req *request.Request, output *DescribeBackupsOutput)

DescribeBackupsRequest generates a "aws/request.Request" representing the client's request for the DescribeBackups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBackups for more information on using the DescribeBackups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeBackupsRequest method.
req, resp := client.DescribeBackupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) DescribeBackupsWithContext

func (c *FSx) DescribeBackupsWithContext(ctx aws.Context, input *DescribeBackupsInput, opts ...request.Option) (*DescribeBackupsOutput, error)

DescribeBackupsWithContext is the same as DescribeBackups with the addition of the ability to pass a context and additional request options.

See DescribeBackups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) DescribeFileSystems

func (c *FSx) DescribeFileSystems(input *DescribeFileSystemsInput) (*DescribeFileSystemsOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation DescribeFileSystems for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeFileSystemNotFound "FileSystemNotFound"
No Amazon FSx file systems were found based upon supplied parameters.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

See also, 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.

Code:

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

result, err := svc.DescribeFileSystems(input)
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)

func (*FSx) DescribeFileSystemsPages

func (c *FSx) DescribeFileSystemsPages(input *DescribeFileSystemsInput, fn func(*DescribeFileSystemsOutput, bool) bool) error

DescribeFileSystemsPages iterates over the pages of a DescribeFileSystems operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeFileSystems method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeFileSystems operation.
pageNum := 0
err := client.DescribeFileSystemsPages(params,
    func(page *fsx.DescribeFileSystemsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeFileSystemsPagesWithContext

func (c *FSx) DescribeFileSystemsPagesWithContext(ctx aws.Context, input *DescribeFileSystemsInput, fn func(*DescribeFileSystemsOutput, bool) bool, opts ...request.Option) error

DescribeFileSystemsPagesWithContext same as DescribeFileSystemsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) DescribeFileSystemsRequest

func (c *FSx) DescribeFileSystemsRequest(input *DescribeFileSystemsInput) (req *request.Request, output *DescribeFileSystemsOutput)

DescribeFileSystemsRequest generates a "aws/request.Request" representing the client's request for the DescribeFileSystems operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFileSystems for more information on using the DescribeFileSystems API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFileSystemsRequest method.
req, resp := client.DescribeFileSystemsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) DescribeFileSystemsWithContext

func (c *FSx) DescribeFileSystemsWithContext(ctx aws.Context, input *DescribeFileSystemsInput, opts ...request.Option) (*DescribeFileSystemsOutput, error)

DescribeFileSystemsWithContext is the same as DescribeFileSystems with the addition of the ability to pass a context and additional request options.

See DescribeFileSystems for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) ListTagsForResource

func (c *FSx) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

* ErrCodeResourceNotFound "ResourceNotFound"
The resource specified by the Amazon Resource Name (ARN) can't be found.

* ErrCodeNotServiceResourceError "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.

* ErrCodeResourceDoesNotSupportTagging "ResourceDoesNotSupportTagging"
The resource specified does not support tagging.

See also, 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.

Code:

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

result, err := svc.ListTagsForResource(input)
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)

func (*FSx) ListTagsForResourceRequest

func (c *FSx) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) ListTagsForResourceWithContext

func (c *FSx) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) TagResource

func (c *FSx) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon FSx.

Tags an Amazon FSx resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation TagResource for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

* ErrCodeResourceNotFound "ResourceNotFound"
The resource specified by the Amazon Resource Name (ARN) can't be found.

* ErrCodeNotServiceResourceError "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.

* ErrCodeResourceDoesNotSupportTagging "ResourceDoesNotSupportTagging"
The resource specified does not support tagging.

See also, 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.

Code:

svc := fsx.New(session.New())
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"),
        },
    },
}

result, err := svc.TagResource(input)
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)

func (*FSx) TagResourceRequest

func (c *FSx) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) TagResourceWithContext

func (c *FSx) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) UntagResource

func (c *FSx) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon FSx.

This action removes a tag from an Amazon FSx resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation UntagResource for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

* ErrCodeResourceNotFound "ResourceNotFound"
The resource specified by the Amazon Resource Name (ARN) can't be found.

* ErrCodeNotServiceResourceError "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.

* ErrCodeResourceDoesNotSupportTagging "ResourceDoesNotSupportTagging"
The resource specified does not support tagging.

See also, 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.

Code:

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

result, err := svc.UntagResource(input)
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)

func (*FSx) UntagResourceRequest

func (c *FSx) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) UntagResourceWithContext

func (c *FSx) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*FSx) UpdateFileSystem

func (c *FSx) UpdateFileSystem(input *UpdateFileSystemInput) (*UpdateFileSystemOutput, error)

UpdateFileSystem API operation for Amazon FSx.

Updates a file system configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon FSx's API operation UpdateFileSystem for usage and error information.

Returned Error Codes:

* ErrCodeBadRequest "BadRequest"
A generic error indicating a failure with a client request.

* ErrCodeUnsupportedOperation "UnsupportedOperation"
An error occured.

* ErrCodeIncompatibleParameterError "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.

* ErrCodeInternalServerError "InternalServerError"
A generic error indicating a server-side failure.

* ErrCodeFileSystemNotFound "FileSystemNotFound"
No Amazon FSx file systems were found based upon supplied parameters.

* ErrCodeMissingFileSystemConfiguration "MissingFileSystemConfiguration"
File system configuration is required for this operation.

See also, 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.

Code:

svc := fsx.New(session.New())
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"),
    },
}

result, err := svc.UpdateFileSystem(input)
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())
        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)

func (*FSx) UpdateFileSystemRequest

func (c *FSx) UpdateFileSystemRequest(input *UpdateFileSystemInput) (req *request.Request, output *UpdateFileSystemOutput)

UpdateFileSystemRequest generates a "aws/request.Request" representing the client's request for the UpdateFileSystem operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFileSystem for more information on using the UpdateFileSystem API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFileSystemRequest method.
req, resp := client.UpdateFileSystemRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*FSx) UpdateFileSystemWithContext

func (c *FSx) UpdateFileSystemWithContext(ctx aws.Context, input *UpdateFileSystemInput, opts ...request.Option) (*UpdateFileSystemOutput, error)

UpdateFileSystemWithContext is the same as UpdateFileSystem with the addition of the ability to pass a context and additional request options.

See UpdateFileSystem for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type FileSystem

type FileSystem struct {

    // 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 *string `type:"string" enum:"FileSystemType"`

    // The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the
    // file system's data for an Amazon FSx for Windows File Server file system.
    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 *string `type:"string" enum:"FileSystemLifecycle"`

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

    // The ID of the subnet to contain the endpoint for the file system. One and
    // only one is supported. The file system is launched in the Availability Zone
    // associated with this subnet.
    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) GoString

func (s FileSystem) GoString() string

GoString returns the string representation

func (*FileSystem) SetCreationTime

func (s *FileSystem) SetCreationTime(v time.Time) *FileSystem

SetCreationTime sets the CreationTime field's value.

func (*FileSystem) SetDNSName

func (s *FileSystem) SetDNSName(v string) *FileSystem

SetDNSName sets the DNSName field's value.

func (*FileSystem) SetFailureDetails

func (s *FileSystem) SetFailureDetails(v *FileSystemFailureDetails) *FileSystem

SetFailureDetails sets the FailureDetails field's value.

func (*FileSystem) SetFileSystemId

func (s *FileSystem) SetFileSystemId(v string) *FileSystem

SetFileSystemId sets the FileSystemId field's value.

func (*FileSystem) SetFileSystemType

func (s *FileSystem) SetFileSystemType(v string) *FileSystem

SetFileSystemType sets the FileSystemType field's value.

func (*FileSystem) SetKmsKeyId

func (s *FileSystem) SetKmsKeyId(v string) *FileSystem

SetKmsKeyId sets the KmsKeyId field's value.

func (*FileSystem) SetLifecycle

func (s *FileSystem) SetLifecycle(v string) *FileSystem

SetLifecycle sets the Lifecycle field's value.

func (*FileSystem) SetLustreConfiguration

func (s *FileSystem) SetLustreConfiguration(v *LustreFileSystemConfiguration) *FileSystem

SetLustreConfiguration sets the LustreConfiguration field's value.

func (*FileSystem) SetNetworkInterfaceIds

func (s *FileSystem) SetNetworkInterfaceIds(v []*string) *FileSystem

SetNetworkInterfaceIds sets the NetworkInterfaceIds field's value.

func (*FileSystem) SetOwnerId

func (s *FileSystem) SetOwnerId(v string) *FileSystem

SetOwnerId sets the OwnerId field's value.

func (*FileSystem) SetResourceARN

func (s *FileSystem) SetResourceARN(v string) *FileSystem

SetResourceARN sets the ResourceARN field's value.

func (*FileSystem) SetStorageCapacity

func (s *FileSystem) SetStorageCapacity(v int64) *FileSystem

SetStorageCapacity sets the StorageCapacity field's value.

func (*FileSystem) SetSubnetIds

func (s *FileSystem) SetSubnetIds(v []*string) *FileSystem

SetSubnetIds sets the SubnetIds field's value.

func (*FileSystem) SetTags

func (s *FileSystem) SetTags(v []*Tag) *FileSystem

SetTags sets the Tags field's value.

func (*FileSystem) SetVpcId

func (s *FileSystem) SetVpcId(v string) *FileSystem

SetVpcId sets the VpcId field's value.

func (*FileSystem) SetWindowsConfiguration

func (s *FileSystem) SetWindowsConfiguration(v *WindowsFileSystemConfiguration) *FileSystem

SetWindowsConfiguration sets the WindowsConfiguration field's value.

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

func (s FileSystemFailureDetails) GoString() string

GoString returns the string representation

func (*FileSystemFailureDetails) SetMessage

func (s *FileSystemFailureDetails) SetMessage(v string) *FileSystemFailureDetails

SetMessage sets the Message field's value.

func (FileSystemFailureDetails) String

func (s FileSystemFailureDetails) String() string

String returns the string representation

type Filter

type Filter struct {

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

    // 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) GoString

func (s Filter) GoString() string

GoString returns the string representation

func (*Filter) SetName

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetValues

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String

func (s Filter) String() string

String returns the string representation

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

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

    // (Optional) Opaque pagination token returned from a previous ListTagsForResource
    // operation (String). If a token present, the action continues the list from
    // where the returning call left off.
    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) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetMaxResults

func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceARN

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

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

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetNextToken

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type LustreFileSystemConfiguration

type LustreFileSystemConfiguration struct {

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

    // The UTC time that you want to begin your weekly maintenance window.
    WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
    // contains filtered or unexported fields
}

The configuration for the Amazon FSx for Lustre file system.

func (LustreFileSystemConfiguration) GoString

func (s LustreFileSystemConfiguration) GoString() string

GoString returns the string representation

func (*LustreFileSystemConfiguration) SetDataRepositoryConfiguration

func (s *LustreFileSystemConfiguration) SetDataRepositoryConfiguration(v *DataRepositoryConfiguration) *LustreFileSystemConfiguration

SetDataRepositoryConfiguration sets the DataRepositoryConfiguration field's value.

func (*LustreFileSystemConfiguration) SetWeeklyMaintenanceStartTime

func (s *LustreFileSystemConfiguration) SetWeeklyMaintenanceStartTime(v string) *LustreFileSystemConfiguration

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (LustreFileSystemConfiguration) String

func (s LustreFileSystemConfiguration) String() string

String returns the string representation

type SelfManagedActiveDirectoryAttributes

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 `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) GoString

func (s SelfManagedActiveDirectoryAttributes) GoString() string

GoString returns the string representation

func (*SelfManagedActiveDirectoryAttributes) SetDnsIps

func (s *SelfManagedActiveDirectoryAttributes) SetDnsIps(v []*string) *SelfManagedActiveDirectoryAttributes

SetDnsIps sets the DnsIps field's value.

func (*SelfManagedActiveDirectoryAttributes) SetDomainName

func (s *SelfManagedActiveDirectoryAttributes) SetDomainName(v string) *SelfManagedActiveDirectoryAttributes

SetDomainName sets the DomainName field's value.

func (*SelfManagedActiveDirectoryAttributes) SetFileSystemAdministratorsGroup

func (s *SelfManagedActiveDirectoryAttributes) SetFileSystemAdministratorsGroup(v string) *SelfManagedActiveDirectoryAttributes

SetFileSystemAdministratorsGroup sets the FileSystemAdministratorsGroup field's value.

func (*SelfManagedActiveDirectoryAttributes) SetOrganizationalUnitDistinguishedName

func (s *SelfManagedActiveDirectoryAttributes) SetOrganizationalUnitDistinguishedName(v string) *SelfManagedActiveDirectoryAttributes

SetOrganizationalUnitDistinguishedName sets the OrganizationalUnitDistinguishedName field's value.

func (*SelfManagedActiveDirectoryAttributes) SetUserName

func (s *SelfManagedActiveDirectoryAttributes) SetUserName(v string) *SelfManagedActiveDirectoryAttributes

SetUserName sets the UserName field's value.

func (SelfManagedActiveDirectoryAttributes) String

func (s SelfManagedActiveDirectoryAttributes) String() string

String returns the string representation

type SelfManagedActiveDirectoryConfiguration

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 (Iv4) 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 `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) GoString

func (s SelfManagedActiveDirectoryConfiguration) GoString() string

GoString returns the string representation

func (*SelfManagedActiveDirectoryConfiguration) SetDnsIps

func (s *SelfManagedActiveDirectoryConfiguration) SetDnsIps(v []*string) *SelfManagedActiveDirectoryConfiguration

SetDnsIps sets the DnsIps field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetDomainName

func (s *SelfManagedActiveDirectoryConfiguration) SetDomainName(v string) *SelfManagedActiveDirectoryConfiguration

SetDomainName sets the DomainName field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetFileSystemAdministratorsGroup

func (s *SelfManagedActiveDirectoryConfiguration) SetFileSystemAdministratorsGroup(v string) *SelfManagedActiveDirectoryConfiguration

SetFileSystemAdministratorsGroup sets the FileSystemAdministratorsGroup field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetOrganizationalUnitDistinguishedName

func (s *SelfManagedActiveDirectoryConfiguration) SetOrganizationalUnitDistinguishedName(v string) *SelfManagedActiveDirectoryConfiguration

SetOrganizationalUnitDistinguishedName sets the OrganizationalUnitDistinguishedName field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetPassword

func (s *SelfManagedActiveDirectoryConfiguration) SetPassword(v string) *SelfManagedActiveDirectoryConfiguration

SetPassword sets the Password field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetUserName

func (s *SelfManagedActiveDirectoryConfiguration) SetUserName(v string) *SelfManagedActiveDirectoryConfiguration

SetUserName sets the UserName field's value.

func (SelfManagedActiveDirectoryConfiguration) String

func (s SelfManagedActiveDirectoryConfiguration) String() string

String returns the string representation

func (*SelfManagedActiveDirectoryConfiguration) Validate

func (s *SelfManagedActiveDirectoryConfiguration) Validate() error

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

type SelfManagedActiveDirectoryConfigurationUpdates

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 the self-managed Microsoft Active Directory (AD) directory.

func (SelfManagedActiveDirectoryConfigurationUpdates) GoString

func (s SelfManagedActiveDirectoryConfigurationUpdates) GoString() string

GoString returns the string representation

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetDnsIps

func (s *SelfManagedActiveDirectoryConfigurationUpdates) SetDnsIps(v []*string) *SelfManagedActiveDirectoryConfigurationUpdates

SetDnsIps sets the DnsIps field's value.

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetPassword

func (s *SelfManagedActiveDirectoryConfigurationUpdates) SetPassword(v string) *SelfManagedActiveDirectoryConfigurationUpdates

SetPassword sets the Password field's value.

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetUserName

func (s *SelfManagedActiveDirectoryConfigurationUpdates) SetUserName(v string) *SelfManagedActiveDirectoryConfigurationUpdates

SetUserName sets the UserName field's value.

func (SelfManagedActiveDirectoryConfigurationUpdates) String

func (s SelfManagedActiveDirectoryConfigurationUpdates) String() string

String returns the string representation

func (*SelfManagedActiveDirectoryConfigurationUpdates) Validate

func (s *SelfManagedActiveDirectoryConfigurationUpdates) Validate() error

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

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

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

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

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

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

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

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

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

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

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateFileSystemInput

type UpdateFileSystemInput struct {

    // (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
    // ensure idempotent updates. This string is automatically filled on your behalf
    // when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
    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"`

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

    // The configuration update for this Microsoft Windows file system. The only
    // supported options are for backup and maintenance and for self-managed Active
    // Directory configuration.
    WindowsConfiguration *UpdateFileSystemWindowsConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

The request object for the UpdateFileSystem operation.

func (UpdateFileSystemInput) GoString

func (s UpdateFileSystemInput) GoString() string

GoString returns the string representation

func (*UpdateFileSystemInput) SetClientRequestToken

func (s *UpdateFileSystemInput) SetClientRequestToken(v string) *UpdateFileSystemInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateFileSystemInput) SetFileSystemId

func (s *UpdateFileSystemInput) SetFileSystemId(v string) *UpdateFileSystemInput

SetFileSystemId sets the FileSystemId field's value.

func (*UpdateFileSystemInput) SetLustreConfiguration

func (s *UpdateFileSystemInput) SetLustreConfiguration(v *UpdateFileSystemLustreConfiguration) *UpdateFileSystemInput

SetLustreConfiguration sets the LustreConfiguration field's value.

func (*UpdateFileSystemInput) SetWindowsConfiguration

func (s *UpdateFileSystemInput) SetWindowsConfiguration(v *UpdateFileSystemWindowsConfiguration) *UpdateFileSystemInput

SetWindowsConfiguration sets the WindowsConfiguration field's value.

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 preferred time to perform weekly maintenance, in the UTC time zone.
    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) GoString

func (s UpdateFileSystemLustreConfiguration) GoString() string

GoString returns the string representation

func (*UpdateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime

func (s *UpdateFileSystemLustreConfiguration) SetWeeklyMaintenanceStartTime(v string) *UpdateFileSystemLustreConfiguration

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

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

func (s UpdateFileSystemOutput) GoString() string

GoString returns the string representation

func (*UpdateFileSystemOutput) SetFileSystem

func (s *UpdateFileSystemOutput) SetFileSystem(v *FileSystem) *UpdateFileSystemOutput

SetFileSystem sets the FileSystem field's value.

func (UpdateFileSystemOutput) String

func (s UpdateFileSystemOutput) String() string

String returns the string representation

type UpdateFileSystemWindowsConfiguration

type UpdateFileSystemWindowsConfiguration 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.
    AutomaticBackupRetentionDays *int64 `type:"integer"`

    // The preferred time to take daily automatic backups, in the UTC time zone.
    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.
    SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates `type:"structure"`

    // The preferred time to perform weekly maintenance, in the UTC time zone.
    WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
    // contains filtered or unexported fields
}

Updates the Microsoft Windows configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx overwrites existing properties with non-null values provided in the request. If you don't specify a non-null value for a property, that property is not updated.

func (UpdateFileSystemWindowsConfiguration) GoString

func (s UpdateFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation

func (*UpdateFileSystemWindowsConfiguration) SetAutomaticBackupRetentionDays

func (s *UpdateFileSystemWindowsConfiguration) SetAutomaticBackupRetentionDays(v int64) *UpdateFileSystemWindowsConfiguration

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*UpdateFileSystemWindowsConfiguration) SetDailyAutomaticBackupStartTime

func (s *UpdateFileSystemWindowsConfiguration) SetDailyAutomaticBackupStartTime(v string) *UpdateFileSystemWindowsConfiguration

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*UpdateFileSystemWindowsConfiguration) SetSelfManagedActiveDirectoryConfiguration

func (s *UpdateFileSystemWindowsConfiguration) SetSelfManagedActiveDirectoryConfiguration(v *SelfManagedActiveDirectoryConfigurationUpdates) *UpdateFileSystemWindowsConfiguration

SetSelfManagedActiveDirectoryConfiguration sets the SelfManagedActiveDirectoryConfiguration field's value.

func (*UpdateFileSystemWindowsConfiguration) SetWeeklyMaintenanceStartTime

func (s *UpdateFileSystemWindowsConfiguration) SetWeeklyMaintenanceStartTime(v string) *UpdateFileSystemWindowsConfiguration

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

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 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.
    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.
    //
    //    * SINGLE_AZ_1 - (Default) Specifies a file system that is configured for
    //    single AZ redundancy.
    DeploymentType *string `type:"string" enum:"WindowsDeploymentType"`

    // The list of maintenance operations in progress for this file system.
    MaintenanceOperationsInProgress []*string `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 both SINGLE_AZ_1 and MULTI_AZ_1 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 and instruction
    // on mapping and mounting file shares, see https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html
    // (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html).
    PreferredFileServerIp *string `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 deployment types, this value is the same as that for SubnetIDs.
    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 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 time to perform weekly maintenance, in the UTC time zone.
    WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
    // contains filtered or unexported fields
}

The configuration for this Microsoft Windows file system.

func (WindowsFileSystemConfiguration) GoString

func (s WindowsFileSystemConfiguration) GoString() string

GoString returns the string representation

func (*WindowsFileSystemConfiguration) SetActiveDirectoryId

func (s *WindowsFileSystemConfiguration) SetActiveDirectoryId(v string) *WindowsFileSystemConfiguration

SetActiveDirectoryId sets the ActiveDirectoryId field's value.

func (*WindowsFileSystemConfiguration) SetAutomaticBackupRetentionDays

func (s *WindowsFileSystemConfiguration) SetAutomaticBackupRetentionDays(v int64) *WindowsFileSystemConfiguration

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*WindowsFileSystemConfiguration) SetCopyTagsToBackups

func (s *WindowsFileSystemConfiguration) SetCopyTagsToBackups(v bool) *WindowsFileSystemConfiguration

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*WindowsFileSystemConfiguration) SetDailyAutomaticBackupStartTime

func (s *WindowsFileSystemConfiguration) SetDailyAutomaticBackupStartTime(v string) *WindowsFileSystemConfiguration

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*WindowsFileSystemConfiguration) SetDeploymentType

func (s *WindowsFileSystemConfiguration) SetDeploymentType(v string) *WindowsFileSystemConfiguration

SetDeploymentType sets the DeploymentType field's value.

func (*WindowsFileSystemConfiguration) SetMaintenanceOperationsInProgress

func (s *WindowsFileSystemConfiguration) SetMaintenanceOperationsInProgress(v []*string) *WindowsFileSystemConfiguration

SetMaintenanceOperationsInProgress sets the MaintenanceOperationsInProgress field's value.

func (*WindowsFileSystemConfiguration) SetPreferredFileServerIp

func (s *WindowsFileSystemConfiguration) SetPreferredFileServerIp(v string) *WindowsFileSystemConfiguration

SetPreferredFileServerIp sets the PreferredFileServerIp field's value.

func (*WindowsFileSystemConfiguration) SetPreferredSubnetId

func (s *WindowsFileSystemConfiguration) SetPreferredSubnetId(v string) *WindowsFileSystemConfiguration

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*WindowsFileSystemConfiguration) SetRemoteAdministrationEndpoint

func (s *WindowsFileSystemConfiguration) SetRemoteAdministrationEndpoint(v string) *WindowsFileSystemConfiguration

SetRemoteAdministrationEndpoint sets the RemoteAdministrationEndpoint field's value.

func (*WindowsFileSystemConfiguration) SetSelfManagedActiveDirectoryConfiguration

func (s *WindowsFileSystemConfiguration) SetSelfManagedActiveDirectoryConfiguration(v *SelfManagedActiveDirectoryAttributes) *WindowsFileSystemConfiguration

SetSelfManagedActiveDirectoryConfiguration sets the SelfManagedActiveDirectoryConfiguration field's value.

func (*WindowsFileSystemConfiguration) SetThroughputCapacity

func (s *WindowsFileSystemConfiguration) SetThroughputCapacity(v int64) *WindowsFileSystemConfiguration

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*WindowsFileSystemConfiguration) SetWeeklyMaintenanceStartTime

func (s *WindowsFileSystemConfiguration) SetWeeklyMaintenanceStartTime(v string) *WindowsFileSystemConfiguration

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (WindowsFileSystemConfiguration) String

func (s WindowsFileSystemConfiguration) String() string

String returns the string representation