fsx

package
v1.40.49 Latest Latest
Warning

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

 Go to latest Published: Sep 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 79

Documentation

Overview

Package fsx provides the client and types for making API requests to Amazon FSx.

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

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

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

Using the Client

To 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

Index

Examples

Constants

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

View Source 
const (
	// AdministrativeActionTypeFileSystemUpdate is a AdministrativeActionType enum value
	AdministrativeActionTypeFileSystemUpdate = "FILE_SYSTEM_UPDATE"

	// AdministrativeActionTypeStorageOptimization is a AdministrativeActionType enum value
	AdministrativeActionTypeStorageOptimization = "STORAGE_OPTIMIZATION"

	// AdministrativeActionTypeFileSystemAliasAssociation is a AdministrativeActionType enum value
	AdministrativeActionTypeFileSystemAliasAssociation = "FILE_SYSTEM_ALIAS_ASSOCIATION"

	// AdministrativeActionTypeFileSystemAliasDisassociation is a AdministrativeActionType enum value
	AdministrativeActionTypeFileSystemAliasDisassociation = "FILE_SYSTEM_ALIAS_DISASSOCIATION"
)

Describes the type of administrative action, as follows:

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

  • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts. For Windows, storage optimization is the process of migrating the file system data to the new, larger disks. For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers. You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html) in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) in the Amazon FSx for Lustre User Guide.

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .

View Source 
const (
	// AliasLifecycleAvailable is a AliasLifecycle enum value
	AliasLifecycleAvailable = "AVAILABLE"

	// AliasLifecycleCreating is a AliasLifecycle enum value
	AliasLifecycleCreating = "CREATING"

	// AliasLifecycleDeleting is a AliasLifecycle enum value
	AliasLifecycleDeleting = "DELETING"

	// AliasLifecycleCreateFailed is a AliasLifecycle enum value
	AliasLifecycleCreateFailed = "CREATE_FAILED"

	// AliasLifecycleDeleteFailed is a AliasLifecycle enum value
	AliasLifecycleDeleteFailed = "DELETE_FAILED"
)
View Source 
const (
	// AutoImportPolicyTypeNone is a AutoImportPolicyType enum value
	AutoImportPolicyTypeNone = "NONE"

	// AutoImportPolicyTypeNew is a AutoImportPolicyType enum value
	AutoImportPolicyTypeNew = "NEW"

	// AutoImportPolicyTypeNewChanged is a AutoImportPolicyType enum value
	AutoImportPolicyTypeNewChanged = "NEW_CHANGED"
)
View Source 
const (
	// BackupLifecycleAvailable is a BackupLifecycle enum value
	BackupLifecycleAvailable = "AVAILABLE"

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

	// BackupLifecycleTransferring is a BackupLifecycle enum value
	BackupLifecycleTransferring = "TRANSFERRING"

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

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

	// BackupLifecyclePending is a BackupLifecycle enum value
	BackupLifecyclePending = "PENDING"

	// BackupLifecycleCopying is a BackupLifecycle enum value
	BackupLifecycleCopying = "COPYING"
)

The lifecycle status of the backup.

  • AVAILABLE - The backup is fully available.

  • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

  • CREATING - Amazon FSx is creating the new user-intiated backup

  • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file system.

  • COPYING - Amazon FSx is copying the backup.

  • DELETED - Amazon FSx deleted the backup and it is no longer available.

  • FAILED - Amazon FSx could not complete the backup.

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

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

	// BackupTypeAwsBackup is a BackupType enum value
	BackupTypeAwsBackup = "AWS_BACKUP"
)

The type of the backup.

View Source 
const (
	// DataCompressionTypeNone is a DataCompressionType enum value
	DataCompressionTypeNone = "NONE"

	// DataCompressionTypeLz4 is a DataCompressionType enum value
	DataCompressionTypeLz4 = "LZ4"
)
View Source 
const (
	// DataRepositoryLifecycleCreating is a DataRepositoryLifecycle enum value
	DataRepositoryLifecycleCreating = "CREATING"

	// DataRepositoryLifecycleAvailable is a DataRepositoryLifecycle enum value
	DataRepositoryLifecycleAvailable = "AVAILABLE"

	// DataRepositoryLifecycleMisconfigured is a DataRepositoryLifecycle enum value
	DataRepositoryLifecycleMisconfigured = "MISCONFIGURED"

	// DataRepositoryLifecycleUpdating is a DataRepositoryLifecycle enum value
	DataRepositoryLifecycleUpdating = "UPDATING"

	// DataRepositoryLifecycleDeleting is a DataRepositoryLifecycle enum value
	DataRepositoryLifecycleDeleting = "DELETING"
)
View Source 
const (
	// DataRepositoryTaskFilterNameFileSystemId is a DataRepositoryTaskFilterName enum value
	DataRepositoryTaskFilterNameFileSystemId = "file-system-id"

	// DataRepositoryTaskFilterNameTaskLifecycle is a DataRepositoryTaskFilterName enum value
	DataRepositoryTaskFilterNameTaskLifecycle = "task-lifecycle"
)
View Source 
const (
	// DataRepositoryTaskLifecyclePending is a DataRepositoryTaskLifecycle enum value
	DataRepositoryTaskLifecyclePending = "PENDING"

	// DataRepositoryTaskLifecycleExecuting is a DataRepositoryTaskLifecycle enum value
	DataRepositoryTaskLifecycleExecuting = "EXECUTING"

	// DataRepositoryTaskLifecycleFailed is a DataRepositoryTaskLifecycle enum value
	DataRepositoryTaskLifecycleFailed = "FAILED"

	// DataRepositoryTaskLifecycleSucceeded is a DataRepositoryTaskLifecycle enum value
	DataRepositoryTaskLifecycleSucceeded = "SUCCEEDED"

	// DataRepositoryTaskLifecycleCanceled is a DataRepositoryTaskLifecycle enum value
	DataRepositoryTaskLifecycleCanceled = "CANCELED"

	// DataRepositoryTaskLifecycleCanceling is a DataRepositoryTaskLifecycle enum value
	DataRepositoryTaskLifecycleCanceling = "CANCELING"
)
View Source 
const (
	// DiskIopsConfigurationModeAutomatic is a DiskIopsConfigurationMode enum value
	DiskIopsConfigurationModeAutomatic = "AUTOMATIC"

	// DiskIopsConfigurationModeUserProvisioned is a DiskIopsConfigurationMode enum value
	DiskIopsConfigurationModeUserProvisioned = "USER_PROVISIONED"
)
View Source 
const (
	// DriveCacheTypeNone is a DriveCacheType enum value
	DriveCacheTypeNone = "NONE"

	// DriveCacheTypeRead is a DriveCacheType enum value
	DriveCacheTypeRead = "READ"
)
View Source 
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.

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

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

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

	// FileSystemTypeOntap is a FileSystemType enum value
	FileSystemTypeOntap = "ONTAP"
)

The type of file system.

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

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

	// FilterNameFileSystemType is a FilterName enum value
	FilterNameFileSystemType = "file-system-type"

	// FilterNameVolumeId is a FilterName enum value
	FilterNameVolumeId = "volume-id"
)

The name for a filter.

View Source 
const (
	// FlexCacheEndpointTypeNone is a FlexCacheEndpointType enum value
	FlexCacheEndpointTypeNone = "NONE"

	// FlexCacheEndpointTypeOrigin is a FlexCacheEndpointType enum value
	FlexCacheEndpointTypeOrigin = "ORIGIN"

	// FlexCacheEndpointTypeCache is a FlexCacheEndpointType enum value
	FlexCacheEndpointTypeCache = "CACHE"
)
View Source 
const (
	// LustreDeploymentTypeScratch1 is a LustreDeploymentType enum value
	LustreDeploymentTypeScratch1 = "SCRATCH_1"

	// LustreDeploymentTypeScratch2 is a LustreDeploymentType enum value
	LustreDeploymentTypeScratch2 = "SCRATCH_2"

	// LustreDeploymentTypePersistent1 is a LustreDeploymentType enum value
	LustreDeploymentTypePersistent1 = "PERSISTENT_1"
)
View Source 
const (
	// OntapVolumeTypeRw is a OntapVolumeType enum value
	OntapVolumeTypeRw = "RW"

	// OntapVolumeTypeDp is a OntapVolumeType enum value
	OntapVolumeTypeDp = "DP"

	// OntapVolumeTypeLs is a OntapVolumeType enum value
	OntapVolumeTypeLs = "LS"
)
View Source 
const (
	// ResourceTypeFileSystem is a ResourceType enum value
	ResourceTypeFileSystem = "FILE_SYSTEM"

	// ResourceTypeVolume is a ResourceType enum value
	ResourceTypeVolume = "VOLUME"
)
View Source 
const (
	// SecurityStyleUnix is a SecurityStyle enum value
	SecurityStyleUnix = "UNIX"

	// SecurityStyleNtfs is a SecurityStyle enum value
	SecurityStyleNtfs = "NTFS"

	// SecurityStyleMixed is a SecurityStyle enum value
	SecurityStyleMixed = "MIXED"
)
View Source 
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"

	// ServiceLimitTotalUserTags is a ServiceLimit enum value
	ServiceLimitTotalUserTags = "TOTAL_USER_TAGS"

	// ServiceLimitTotalInProgressCopyBackups is a ServiceLimit enum value
	ServiceLimitTotalInProgressCopyBackups = "TOTAL_IN_PROGRESS_COPY_BACKUPS"

	// ServiceLimitStorageVirtualMachinesPerFileSystem is a ServiceLimit enum value
	ServiceLimitStorageVirtualMachinesPerFileSystem = "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM"

	// ServiceLimitVolumesPerFileSystem is a ServiceLimit enum value
	ServiceLimitVolumesPerFileSystem = "VOLUMES_PER_FILE_SYSTEM"

	// ServiceLimitTotalSsdIops is a ServiceLimit enum value
	ServiceLimitTotalSsdIops = "TOTAL_SSD_IOPS"
)

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 Amazon Web Services Region. You can increase some of them by contacting Amazon Web Services Support.

View Source 
const (
	// StatusFailed is a Status enum value
	StatusFailed = "FAILED"

	// StatusInProgress is a Status enum value
	StatusInProgress = "IN_PROGRESS"

	// StatusPending is a Status enum value
	StatusPending = "PENDING"

	// StatusCompleted is a Status enum value
	StatusCompleted = "COMPLETED"

	// StatusUpdatedOptimizing is a Status enum value
	StatusUpdatedOptimizing = "UPDATED_OPTIMIZING"
)
View Source 
const (
	// StorageTypeSsd is a StorageType enum value
	StorageTypeSsd = "SSD"

	// StorageTypeHdd is a StorageType enum value
	StorageTypeHdd = "HDD"
)

The storage type for your Amazon FSx file system.

View Source 
const (
	// StorageVirtualMachineLifecycleCreated is a StorageVirtualMachineLifecycle enum value
	StorageVirtualMachineLifecycleCreated = "CREATED"

	// StorageVirtualMachineLifecycleCreating is a StorageVirtualMachineLifecycle enum value
	StorageVirtualMachineLifecycleCreating = "CREATING"

	// StorageVirtualMachineLifecycleDeleting is a StorageVirtualMachineLifecycle enum value
	StorageVirtualMachineLifecycleDeleting = "DELETING"

	// StorageVirtualMachineLifecycleFailed is a StorageVirtualMachineLifecycle enum value
	StorageVirtualMachineLifecycleFailed = "FAILED"

	// StorageVirtualMachineLifecycleMisconfigured is a StorageVirtualMachineLifecycle enum value
	StorageVirtualMachineLifecycleMisconfigured = "MISCONFIGURED"

	// StorageVirtualMachineLifecyclePending is a StorageVirtualMachineLifecycle enum value
	StorageVirtualMachineLifecyclePending = "PENDING"
)
View Source 
const (
	// StorageVirtualMachineRootVolumeSecurityStyleUnix is a StorageVirtualMachineRootVolumeSecurityStyle enum value
	StorageVirtualMachineRootVolumeSecurityStyleUnix = "UNIX"

	// StorageVirtualMachineRootVolumeSecurityStyleNtfs is a StorageVirtualMachineRootVolumeSecurityStyle enum value
	StorageVirtualMachineRootVolumeSecurityStyleNtfs = "NTFS"

	// StorageVirtualMachineRootVolumeSecurityStyleMixed is a StorageVirtualMachineRootVolumeSecurityStyle enum value
	StorageVirtualMachineRootVolumeSecurityStyleMixed = "MIXED"
)
View Source 
const (
	// StorageVirtualMachineSubtypeDefault is a StorageVirtualMachineSubtype enum value
	StorageVirtualMachineSubtypeDefault = "DEFAULT"

	// StorageVirtualMachineSubtypeDpDestination is a StorageVirtualMachineSubtype enum value
	StorageVirtualMachineSubtypeDpDestination = "DP_DESTINATION"

	// StorageVirtualMachineSubtypeSyncDestination is a StorageVirtualMachineSubtype enum value
	StorageVirtualMachineSubtypeSyncDestination = "SYNC_DESTINATION"

	// StorageVirtualMachineSubtypeSyncSource is a StorageVirtualMachineSubtype enum value
	StorageVirtualMachineSubtypeSyncSource = "SYNC_SOURCE"
)
View Source 
const (
	// TieringPolicyNameSnapshotOnly is a TieringPolicyName enum value
	TieringPolicyNameSnapshotOnly = "SNAPSHOT_ONLY"

	// TieringPolicyNameAuto is a TieringPolicyName enum value
	TieringPolicyNameAuto = "AUTO"

	// TieringPolicyNameAll is a TieringPolicyName enum value
	TieringPolicyNameAll = "ALL"

	// TieringPolicyNameNone is a TieringPolicyName enum value
	TieringPolicyNameNone = "NONE"
)
View Source 
const (
	// VolumeFilterNameFileSystemId is a VolumeFilterName enum value
	VolumeFilterNameFileSystemId = "file-system-id"

	// VolumeFilterNameStorageVirtualMachineId is a VolumeFilterName enum value
	VolumeFilterNameStorageVirtualMachineId = "storage-virtual-machine-id"
)
View Source 
const (
	// VolumeLifecycleCreating is a VolumeLifecycle enum value
	VolumeLifecycleCreating = "CREATING"

	// VolumeLifecycleCreated is a VolumeLifecycle enum value
	VolumeLifecycleCreated = "CREATED"

	// VolumeLifecycleDeleting is a VolumeLifecycle enum value
	VolumeLifecycleDeleting = "DELETING"

	// VolumeLifecycleFailed is a VolumeLifecycle enum value
	VolumeLifecycleFailed = "FAILED"

	// VolumeLifecycleMisconfigured is a VolumeLifecycle enum value
	VolumeLifecycleMisconfigured = "MISCONFIGURED"

	// VolumeLifecyclePending is a VolumeLifecycle enum value
	VolumeLifecyclePending = "PENDING"
)
View Source 
const (
	// WindowsAccessAuditLogLevelDisabled is a WindowsAccessAuditLogLevel enum value
	WindowsAccessAuditLogLevelDisabled = "DISABLED"

	// WindowsAccessAuditLogLevelSuccessOnly is a WindowsAccessAuditLogLevel enum value
	WindowsAccessAuditLogLevelSuccessOnly = "SUCCESS_ONLY"

	// WindowsAccessAuditLogLevelFailureOnly is a WindowsAccessAuditLogLevel enum value
	WindowsAccessAuditLogLevelFailureOnly = "FAILURE_ONLY"

	// WindowsAccessAuditLogLevelSuccessAndFailure is a WindowsAccessAuditLogLevel enum value
	WindowsAccessAuditLogLevelSuccessAndFailure = "SUCCESS_AND_FAILURE"
)
View Source 
const (
	// WindowsDeploymentTypeMultiAz1 is a WindowsDeploymentType enum value
	WindowsDeploymentTypeMultiAz1 = "MULTI_AZ_1"

	// WindowsDeploymentTypeSingleAz1 is a WindowsDeploymentType enum value
	WindowsDeploymentTypeSingleAz1 = "SINGLE_AZ_1"

	// WindowsDeploymentTypeSingleAz2 is a WindowsDeploymentType enum value
	WindowsDeploymentTypeSingleAz2 = "SINGLE_AZ_2"
)
View Source 
const (

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

	// ErrCodeBackupBeingCopied for service response error code
	// "BackupBeingCopied".
	//
	// You can't delete a backup while it's being copied.
	ErrCodeBackupBeingCopied = "BackupBeingCopied"

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

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

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

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

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

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

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

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

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

	// ErrCodeIncompatibleRegionForMultiAZ for service response error code
	// "IncompatibleRegionForMultiAZ".
	//
	// Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the
	// destination Region, so the copied backup can't be restored.
	ErrCodeIncompatibleRegionForMultiAZ = "IncompatibleRegionForMultiAZ"

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

	// ErrCodeInvalidDestinationKmsKey for service response error code
	// "InvalidDestinationKmsKey".
	//
	// The Key Management Service (KMS) key of the destination backup is invalid.
	ErrCodeInvalidDestinationKmsKey = "InvalidDestinationKmsKey"

	// 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.
	ErrCodeInvalidNetworkSettings = "InvalidNetworkSettings"

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

	// ErrCodeInvalidRegion for service response error code
	// "InvalidRegion".
	//
	// The Region provided for Source Region is invalid or is in a different Amazon
	// Web Services partition.
	ErrCodeInvalidRegion = "InvalidRegion"

	// ErrCodeInvalidSourceKmsKey for service response error code
	// "InvalidSourceKmsKey".
	//
	// The Key Management Service (KMS) key of the source backup is invalid.
	ErrCodeInvalidSourceKmsKey = "InvalidSourceKmsKey"

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

	// ErrCodeMissingVolumeConfiguration for service response error code
	// "MissingVolumeConfiguration".
	//
	// A volume configuration is required for this operation.
	ErrCodeMissingVolumeConfiguration = "MissingVolumeConfiguration"

	// 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 Amazon Web Services Support.
	ErrCodeServiceLimitExceeded = "ServiceLimitExceeded"

	// ErrCodeSourceBackupUnavailable for service response error code
	// "SourceBackupUnavailable".
	//
	// The request was rejected because the lifecycle status of the source backup
	// is not AVAILABLE.
	ErrCodeSourceBackupUnavailable = "SourceBackupUnavailable"

	// ErrCodeStorageVirtualMachineNotFound for service response error code
	// "StorageVirtualMachineNotFound".
	//
	// No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.
	ErrCodeStorageVirtualMachineNotFound = "StorageVirtualMachineNotFound"

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

	// ErrCodeVolumeNotFound for service response error code
	// "VolumeNotFound".
	//
	// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied
	// parameters.
	ErrCodeVolumeNotFound = "VolumeNotFound"
)
View Source 
const (
	ServiceName = "FSx" // Name of service.
	EndpointsID = "fsx" // ID to lookup a service endpoint with.
	ServiceID   = "FSx" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// DataRepositoryTaskTypeExportToRepository is a DataRepositoryTaskType enum value
	DataRepositoryTaskTypeExportToRepository = "EXPORT_TO_REPOSITORY"
)
View Source 
const (
	// OntapDeploymentTypeMultiAz1 is a OntapDeploymentType enum value
	OntapDeploymentTypeMultiAz1 = "MULTI_AZ_1"
)
View Source 
const (
	// ReportFormatReportCsv20191124 is a ReportFormat enum value
	ReportFormatReportCsv20191124 = "REPORT_CSV_20191124"
)
View Source 
const (
	// ReportScopeFailedFilesOnly is a ReportScope enum value
	ReportScopeFailedFilesOnly = "FAILED_FILES_ONLY"
)
View Source 
const (
	// StorageVirtualMachineFilterNameFileSystemId is a StorageVirtualMachineFilterName enum value
	StorageVirtualMachineFilterNameFileSystemId = "file-system-id"
)
View Source 
const (
	// VolumeTypeOntap is a VolumeType enum value
	VolumeTypeOntap = "ONTAP"
)

Variables

This section is empty.

Functions

func ActiveDirectoryErrorType_Values added in v1.34.3 

func ActiveDirectoryErrorType_Values() []string

ActiveDirectoryErrorType_Values returns all elements of the ActiveDirectoryErrorType enum

func AdministrativeActionType_Values added in v1.34.3 

func AdministrativeActionType_Values() []string

AdministrativeActionType_Values returns all elements of the AdministrativeActionType enum

func AliasLifecycle_Values added in v1.35.24 

func AliasLifecycle_Values() []string

AliasLifecycle_Values returns all elements of the AliasLifecycle enum

func AutoImportPolicyType_Values added in v1.34.3 

func AutoImportPolicyType_Values() []string

AutoImportPolicyType_Values returns all elements of the AutoImportPolicyType enum

func BackupLifecycle_Values added in v1.34.3 

func BackupLifecycle_Values() []string

BackupLifecycle_Values returns all elements of the BackupLifecycle enum

func BackupType_Values added in v1.34.3 

func BackupType_Values() []string

BackupType_Values returns all elements of the BackupType enum

func DataCompressionType_Values added in v1.38.50 

func DataCompressionType_Values() []string

DataCompressionType_Values returns all elements of the DataCompressionType enum

func DataRepositoryLifecycle_Values added in v1.34.3 

func DataRepositoryLifecycle_Values() []string

DataRepositoryLifecycle_Values returns all elements of the DataRepositoryLifecycle enum

func DataRepositoryTaskFilterName_Values added in v1.34.3 

func DataRepositoryTaskFilterName_Values() []string

DataRepositoryTaskFilterName_Values returns all elements of the DataRepositoryTaskFilterName enum

func DataRepositoryTaskLifecycle_Values added in v1.34.3 

func DataRepositoryTaskLifecycle_Values() []string

DataRepositoryTaskLifecycle_Values returns all elements of the DataRepositoryTaskLifecycle enum

func DataRepositoryTaskType_Values added in v1.34.3 

func DataRepositoryTaskType_Values() []string

DataRepositoryTaskType_Values returns all elements of the DataRepositoryTaskType enum

func DiskIopsConfigurationMode_Values added in v1.40.36 

func DiskIopsConfigurationMode_Values() []string

DiskIopsConfigurationMode_Values returns all elements of the DiskIopsConfigurationMode enum

func DriveCacheType_Values added in v1.34.3 

func DriveCacheType_Values() []string

DriveCacheType_Values returns all elements of the DriveCacheType enum

func FileSystemLifecycle_Values added in v1.34.3 

func FileSystemLifecycle_Values() []string

FileSystemLifecycle_Values returns all elements of the FileSystemLifecycle enum

func FileSystemMaintenanceOperation_Values added in v1.34.3 

func FileSystemMaintenanceOperation_Values() []string

FileSystemMaintenanceOperation_Values returns all elements of the FileSystemMaintenanceOperation enum

func FileSystemType_Values added in v1.34.3 

func FileSystemType_Values() []string

FileSystemType_Values returns all elements of the FileSystemType enum

func FilterName_Values added in v1.34.3 

func FilterName_Values() []string

FilterName_Values returns all elements of the FilterName enum

func FlexCacheEndpointType_Values added in v1.40.36 

func FlexCacheEndpointType_Values() []string

FlexCacheEndpointType_Values returns all elements of the FlexCacheEndpointType enum

func LustreDeploymentType_Values added in v1.34.3 

func LustreDeploymentType_Values() []string

LustreDeploymentType_Values returns all elements of the LustreDeploymentType enum

func OntapDeploymentType_Values added in v1.40.36 

func OntapDeploymentType_Values() []string

OntapDeploymentType_Values returns all elements of the OntapDeploymentType enum

func OntapVolumeType_Values added in v1.40.36 

func OntapVolumeType_Values() []string

OntapVolumeType_Values returns all elements of the OntapVolumeType enum

func ReportFormat_Values added in v1.34.3 

func ReportFormat_Values() []string

ReportFormat_Values returns all elements of the ReportFormat enum

func ReportScope_Values added in v1.34.3 

func ReportScope_Values() []string

ReportScope_Values returns all elements of the ReportScope enum

func ResourceType_Values added in v1.40.36 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func SecurityStyle_Values added in v1.40.36 

func SecurityStyle_Values() []string

SecurityStyle_Values returns all elements of the SecurityStyle enum

func ServiceLimit_Values added in v1.34.3 

func ServiceLimit_Values() []string

ServiceLimit_Values returns all elements of the ServiceLimit enum

func Status_Values added in v1.34.3 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func StorageType_Values added in v1.34.3 

func StorageType_Values() []string

StorageType_Values returns all elements of the StorageType enum

func StorageVirtualMachineFilterName_Values added in v1.40.36 

func StorageVirtualMachineFilterName_Values() []string

StorageVirtualMachineFilterName_Values returns all elements of the StorageVirtualMachineFilterName enum

func StorageVirtualMachineLifecycle_Values added in v1.40.36 

func StorageVirtualMachineLifecycle_Values() []string

StorageVirtualMachineLifecycle_Values returns all elements of the StorageVirtualMachineLifecycle enum

func StorageVirtualMachineRootVolumeSecurityStyle_Values added in v1.40.36 

func StorageVirtualMachineRootVolumeSecurityStyle_Values() []string

StorageVirtualMachineRootVolumeSecurityStyle_Values returns all elements of the StorageVirtualMachineRootVolumeSecurityStyle enum

func StorageVirtualMachineSubtype_Values added in v1.40.36 

func StorageVirtualMachineSubtype_Values() []string

StorageVirtualMachineSubtype_Values returns all elements of the StorageVirtualMachineSubtype enum

func TieringPolicyName_Values added in v1.40.36 

func TieringPolicyName_Values() []string

TieringPolicyName_Values returns all elements of the TieringPolicyName enum

func VolumeFilterName_Values added in v1.40.36 

func VolumeFilterName_Values() []string

VolumeFilterName_Values returns all elements of the VolumeFilterName enum

func VolumeLifecycle_Values added in v1.40.36 

func VolumeLifecycle_Values() []string

VolumeLifecycle_Values returns all elements of the VolumeLifecycle enum

func VolumeType_Values added in v1.40.36 

func VolumeType_Values() []string

VolumeType_Values returns all elements of the VolumeType enum

func WindowsAccessAuditLogLevel_Values added in v1.38.57 

func WindowsAccessAuditLogLevel_Values() []string

WindowsAccessAuditLogLevel_Values returns all elements of the WindowsAccessAuditLogLevel enum

func WindowsDeploymentType_Values added in v1.34.3 

func WindowsDeploymentType_Values() []string

WindowsDeploymentType_Values returns all elements of the WindowsDeploymentType enum

Types

type ActiveDirectoryBackupAttributes added in v1.20.7 

type ActiveDirectoryBackupAttributes struct {

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

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

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

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

func (ActiveDirectoryBackupAttributes) GoString added in v1.20.7 

func (s ActiveDirectoryBackupAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActiveDirectoryBackupAttributes) SetActiveDirectoryId added in v1.20.7 

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

SetActiveDirectoryId sets the ActiveDirectoryId field's value.

func (*ActiveDirectoryBackupAttributes) SetDomainName added in v1.20.7 

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

SetDomainName sets the DomainName field's value.

func (*ActiveDirectoryBackupAttributes) SetResourceARN added in v1.38.18 

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

SetResourceARN sets the ResourceARN field's value.

func (ActiveDirectoryBackupAttributes) String added in v1.20.7 

func (s ActiveDirectoryBackupAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActiveDirectoryError added in v1.28.0 

type ActiveDirectoryError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The directory ID of the directory that an error pertains to.
	//
	// ActiveDirectoryId is a required field
	ActiveDirectoryId *string `min:"12" type:"string" required:"true"`

	// A detailed error message.
	Message_ *string `locationName:"Message" min:"1" type:"string"`

	// The type of Active Directory error.
	Type *string `type:"string" enum:"ActiveDirectoryErrorType"`
	// contains filtered or unexported fields
}

An Active Directory error.

func (*ActiveDirectoryError) Code added in v1.28.0 

func (s *ActiveDirectoryError) Code() string

Code returns the exception type name.

func (*ActiveDirectoryError) Error added in v1.28.0 

func (s *ActiveDirectoryError) Error() string

func (ActiveDirectoryError) GoString added in v1.28.0 

func (s ActiveDirectoryError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActiveDirectoryError) Message added in v1.28.0 

func (s *ActiveDirectoryError) Message() string

Message returns the exception's message.

func (*ActiveDirectoryError) OrigErr added in v1.28.0 

func (s *ActiveDirectoryError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ActiveDirectoryError) RequestID added in v1.28.0 

func (s *ActiveDirectoryError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ActiveDirectoryError) StatusCode added in v1.28.0 

func (s *ActiveDirectoryError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ActiveDirectoryError) String added in v1.28.0 

func (s ActiveDirectoryError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdministrativeAction added in v1.31.8 

type AdministrativeAction struct {

	// Describes the type of administrative action, as follows:
	//
	//    * FILE_SYSTEM_UPDATE - A file system update administrative action initiated
	//    by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI
	//    (update-file-system).
	//
	//    * STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase
	//    a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION
	//    task starts. For Windows, storage optimization is the process of migrating
	//    the file system data to the new, larger disks. For Lustre, storage optimization
	//    consists of rebalancing the data across the existing and newly added file
	//    servers. You can track the storage optimization progress using the ProgressPercent
	//    property. When STORAGE_OPTIMIZATION completes successfully, the parent
	//    FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information,
	//    see Managing storage capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html)
	//    in the Amazon FSx for Windows File Server User Guide and Managing storage
	//    and throughput capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html)
	//    in the Amazon FSx for Lustre User Guide.
	//
	//    * FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a
	//    new DNS alias with the file system. For more information, see .
	//
	//    * FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate
	//    a DNS alias from the file system. For more information, see .
	AdministrativeActionType *string `type:"string" enum:"AdministrativeActionType"`

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

	// Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.
	// Does not apply to any other administrative action type.
	ProgressPercent *int64 `type:"integer"`

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

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

	// Describes the target value for the administration action, provided in the
	// UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative
	// actions.
	TargetFileSystemValues *FileSystem `type:"structure"`

	// Describes an Amazon FSx for NetApp ONTAP volume.
	TargetVolumeValues *Volume `type:"structure"`
	// contains filtered or unexported fields
}

Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.

func (AdministrativeAction) GoString added in v1.31.8 

func (s AdministrativeAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdministrativeAction) SetAdministrativeActionType added in v1.31.8 

func (s *AdministrativeAction) SetAdministrativeActionType(v string) *AdministrativeAction

SetAdministrativeActionType sets the AdministrativeActionType field's value.

func (*AdministrativeAction) SetFailureDetails added in v1.31.8 

func (s *AdministrativeAction) SetFailureDetails(v *AdministrativeActionFailureDetails) *AdministrativeAction

SetFailureDetails sets the FailureDetails field's value.

func (*AdministrativeAction) SetProgressPercent added in v1.31.8 

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

SetProgressPercent sets the ProgressPercent field's value.

func (*AdministrativeAction) SetRequestTime added in v1.31.8 

func (s *AdministrativeAction) SetRequestTime(v time.Time) *AdministrativeAction

SetRequestTime sets the RequestTime field's value.

func (*AdministrativeAction) SetStatus added in v1.31.8 

func (s *AdministrativeAction) SetStatus(v string) *AdministrativeAction

SetStatus sets the Status field's value.

func (*AdministrativeAction) SetTargetFileSystemValues added in v1.31.8 

func (s *AdministrativeAction) SetTargetFileSystemValues(v *FileSystem) *AdministrativeAction

SetTargetFileSystemValues sets the TargetFileSystemValues field's value.

func (*AdministrativeAction) SetTargetVolumeValues added in v1.40.36 

func (s *AdministrativeAction) SetTargetVolumeValues(v *Volume) *AdministrativeAction

SetTargetVolumeValues sets the TargetVolumeValues field's value.

func (AdministrativeAction) String added in v1.31.8 

func (s AdministrativeAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdministrativeActionFailureDetails added in v1.31.8 

type AdministrativeActionFailureDetails struct {

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

Provides information about a failed administrative action.

func (AdministrativeActionFailureDetails) GoString added in v1.31.8 

func (s AdministrativeActionFailureDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdministrativeActionFailureDetails) SetMessage added in v1.31.8 

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

SetMessage sets the Message field's value.

func (AdministrativeActionFailureDetails) String added in v1.31.8 

func (s AdministrativeActionFailureDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Alias added in v1.35.24 

type Alias struct {

	// Describes the state of the DNS alias.
	//
	//    * AVAILABLE - The DNS alias is associated with an Amazon FSx file system.
	//
	//    * CREATING - Amazon FSx is creating the DNS alias and associating it with
	//    the file system.
	//
	//    * CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with
	//    the file system.
	//
	//    * DELETING - Amazon FSx is disassociating the DNS alias from the file
	//    system and deleting it.
	//
	//    * DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias
	//    from the file system.
	Lifecycle *string `type:"string" enum:"AliasLifecycle"`

	// The name of the DNS alias. The alias name has to meet the following requirements:
	//
	//    * Formatted as a fully-qualified domain name (FQDN), hostname.domain,
	//    for example, accounting.example.com.
	//
	//    * Can contain alphanumeric characters, the underscore (_), and the hyphen
	//    (-).
	//
	//    * Cannot start or end with a hyphen.
	//
	//    * Can start with a numeric.
	//
	// For DNS names, Amazon FSx stores alphabetic characters as lowercase letters
	// (a-z), regardless of how you specify them: as uppercase letters, lowercase
	// letters, or the corresponding letters in escape codes.
	Name *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) in the FSx for Windows File Server User Guide.

func (Alias) GoString added in v1.35.24 

func (s Alias) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Alias) SetLifecycle added in v1.35.24 

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

SetLifecycle sets the Lifecycle field's value.

func (*Alias) SetName added in v1.35.24 

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

SetName sets the Name field's value.

func (Alias) String added in v1.35.24 

func (s Alias) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateFileSystemAliasesInput added in v1.35.24 

type AssociateFileSystemAliasesInput struct {

	// An array of one or more DNS alias names to associate with the file system.
	// The alias name has to comply with the following formatting requirements:
	//
	//    * Formatted as a fully-qualified domain name (FQDN), hostname.domain ,
	//    for example, accounting.corp.example.com.
	//
	//    * Can contain alphanumeric characters and the hyphen (-).
	//
	//    * Cannot start or end with a hyphen.
	//
	//    * Can start with a numeric.
	//
	// For DNS alias names, Amazon FSx stores alphabetic characters as lowercase
	// letters (a-z), regardless of how you specify them: as uppercase letters,
	// lowercase letters, or the corresponding letters in escape codes.
	//
	// Aliases is a required field
	Aliases []*string `type:"list" required:"true"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Specifies the file system with which you want to associate one or more DNS
	// aliases.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (AssociateFileSystemAliasesInput) GoString added in v1.35.24 

func (s AssociateFileSystemAliasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFileSystemAliasesInput) SetAliases added in v1.35.24 

func (s *AssociateFileSystemAliasesInput) SetAliases(v []*string) *AssociateFileSystemAliasesInput

SetAliases sets the Aliases field's value.

func (*AssociateFileSystemAliasesInput) SetClientRequestToken added in v1.35.24 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*AssociateFileSystemAliasesInput) SetFileSystemId added in v1.35.24 

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

SetFileSystemId sets the FileSystemId field's value.

func (AssociateFileSystemAliasesInput) String added in v1.35.24 

func (s AssociateFileSystemAliasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFileSystemAliasesInput) Validate added in v1.35.24 

func (s *AssociateFileSystemAliasesInput) Validate() error

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

type AssociateFileSystemAliasesOutput added in v1.35.24 

type AssociateFileSystemAliasesOutput struct {

	// An array of the DNS aliases that Amazon FSx is associating with the file
	// system.
	Aliases []*Alias `type:"list"`
	// contains filtered or unexported fields
}

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

func (AssociateFileSystemAliasesOutput) GoString added in v1.35.24 

func (s AssociateFileSystemAliasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFileSystemAliasesOutput) SetAliases added in v1.35.24 

func (s *AssociateFileSystemAliasesOutput) SetAliases(v []*Alias) *AssociateFileSystemAliasesOutput

SetAliases sets the Aliases field's value.

func (AssociateFileSystemAliasesOutput) String added in v1.35.24 

func (s AssociateFileSystemAliasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Key Management Service (KMS) key used to encrypt the backup
	// of the Amazon FSx file system's data at rest.
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle status of the backup.
	//
	//    * AVAILABLE - The backup is fully available.
	//
	//    * PENDING - For user-initiated backups on Lustre file systems only; Amazon
	//    FSx has not started creating the backup.
	//
	//    * CREATING - Amazon FSx is creating the backup.
	//
	//    * TRANSFERRING - For user-initiated backups on Lustre file systems only;
	//    Amazon FSx is transferring the backup to S3.
	//
	//    * COPYING - Amazon FSx is copying the backup.
	//
	//    * DELETED - Amazon FSx deleted the backup and it is no longer available.
	//
	//    * FAILED - Amazon FSx could not complete the backup.
	//
	// Lifecycle is a required field
	Lifecycle *string `type:"string" required:"true" enum:"BackupLifecycle"`

	// An Amazon Web Services account ID. This ID is a 12-digit number that you
	// use to construct Amazon Resource Names (ARNs) for resources.
	OwnerId *string `min:"12" type:"string"`

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

	// Specifies the resource type that is backed up.
	ResourceType *string `type:"string" enum:"ResourceType"`

	// The ID of the source backup. Specifies the backup you are copying.
	SourceBackupId *string `min:"12" type:"string"`

	// The source Region of the backup. Specifies the Region from where this backup
	// is copied.
	SourceBackupRegion *string `min:"1" type:"string"`

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

	// The type of the file system backup.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"BackupType"`

	// Describes an Amazon FSx for NetApp ONTAP volume.
	Volume *Volume `type:"structure"`
	// contains filtered or unexported fields
}

A backup of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume.

func (Backup) GoString 

func (s Backup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 added in v1.20.7 

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) SetOwnerId added in v1.38.18 

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

SetOwnerId sets the OwnerId 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) SetResourceType added in v1.40.36 

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

SetResourceType sets the ResourceType field's value.

func (*Backup) SetSourceBackupId added in v1.38.18 

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

SetSourceBackupId sets the SourceBackupId field's value.

func (*Backup) SetSourceBackupRegion added in v1.38.18 

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

SetSourceBackupRegion sets the SourceBackupRegion 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) SetVolume added in v1.40.36 

func (s *Backup) SetVolume(v *Volume) *Backup

SetVolume sets the Volume field's value.

func (Backup) String 

func (s Backup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BackupBeingCopied added in v1.38.18 

type BackupBeingCopied struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The ID of the source backup. Specifies the backup you are copying.
	BackupId *string `min:"12" type:"string"`

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

You can't delete a backup while it's being copied.

func (*BackupBeingCopied) Code added in v1.38.18 

func (s *BackupBeingCopied) Code() string

Code returns the exception type name.

func (*BackupBeingCopied) Error added in v1.38.18 

func (s *BackupBeingCopied) Error() string

func (BackupBeingCopied) GoString added in v1.38.18 

func (s BackupBeingCopied) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BackupBeingCopied) Message added in v1.38.18 

func (s *BackupBeingCopied) Message() string

Message returns the exception's message.

func (*BackupBeingCopied) OrigErr added in v1.38.18 

func (s *BackupBeingCopied) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BackupBeingCopied) RequestID added in v1.38.18 

func (s *BackupBeingCopied) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BackupBeingCopied) StatusCode added in v1.38.18 

func (s *BackupBeingCopied) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BackupBeingCopied) String added in v1.38.18 

func (s BackupBeingCopied) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BackupInProgress added in v1.28.0 

type BackupInProgress struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

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

func (*BackupInProgress) Code added in v1.28.0 

func (s *BackupInProgress) Code() string

Code returns the exception type name.

func (*BackupInProgress) Error added in v1.28.0 

func (s *BackupInProgress) Error() string

func (BackupInProgress) GoString added in v1.28.0 

func (s BackupInProgress) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BackupInProgress) Message added in v1.28.0 

func (s *BackupInProgress) Message() string

Message returns the exception's message.

func (*BackupInProgress) OrigErr added in v1.28.0 

func (s *BackupInProgress) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BackupInProgress) RequestID added in v1.28.0 

func (s *BackupInProgress) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BackupInProgress) StatusCode added in v1.28.0 

func (s *BackupInProgress) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BackupInProgress) String added in v1.28.0 

func (s BackupInProgress) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BackupNotFound added in v1.28.0 

type BackupNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

No Amazon FSx backups were found based upon the supplied parameters.

func (*BackupNotFound) Code added in v1.28.0 

func (s *BackupNotFound) Code() string

Code returns the exception type name.

func (*BackupNotFound) Error added in v1.28.0 

func (s *BackupNotFound) Error() string

func (BackupNotFound) GoString added in v1.28.0 

func (s BackupNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BackupNotFound) Message added in v1.28.0 

func (s *BackupNotFound) Message() string

Message returns the exception's message.

func (*BackupNotFound) OrigErr added in v1.28.0 

func (s *BackupNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BackupNotFound) RequestID added in v1.28.0 

func (s *BackupNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BackupNotFound) StatusCode added in v1.28.0 

func (s *BackupNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BackupNotFound) String added in v1.28.0 

func (s BackupNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BackupRestoring added in v1.28.0 

type BackupRestoring struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The ID of a file system being restored from the backup.
	FileSystemId *string `min:"11" type:"string"`

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

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

func (*BackupRestoring) Code added in v1.28.0 

func (s *BackupRestoring) Code() string

Code returns the exception type name.

func (*BackupRestoring) Error added in v1.28.0 

func (s *BackupRestoring) Error() string

func (BackupRestoring) GoString added in v1.28.0 

func (s BackupRestoring) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BackupRestoring) Message added in v1.28.0 

func (s *BackupRestoring) Message() string

Message returns the exception's message.

func (*BackupRestoring) OrigErr added in v1.28.0 

func (s *BackupRestoring) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BackupRestoring) RequestID added in v1.28.0 

func (s *BackupRestoring) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BackupRestoring) StatusCode added in v1.28.0 

func (s *BackupRestoring) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BackupRestoring) String added in v1.28.0 

func (s BackupRestoring) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadRequest added in v1.28.0 

type BadRequest struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

A generic error indicating a failure with a client request.

func (*BadRequest) Code added in v1.28.0 

func (s *BadRequest) Code() string

Code returns the exception type name.

func (*BadRequest) Error added in v1.28.0 

func (s *BadRequest) Error() string

func (BadRequest) GoString added in v1.28.0 

func (s BadRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequest) Message added in v1.28.0 

func (s *BadRequest) Message() string

Message returns the exception's message.

func (*BadRequest) OrigErr added in v1.28.0 

func (s *BadRequest) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequest) RequestID added in v1.28.0 

func (s *BadRequest) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequest) StatusCode added in v1.28.0 

func (s *BadRequest) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequest) String added in v1.28.0 

func (s BadRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelDataRepositoryTaskInput added in v1.26.8 

type CancelDataRepositoryTaskInput struct {

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

Cancels a data repository task.

func (CancelDataRepositoryTaskInput) GoString added in v1.26.8 

func (s CancelDataRepositoryTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDataRepositoryTaskInput) SetTaskId added in v1.26.8 

func (s *CancelDataRepositoryTaskInput) SetTaskId(v string) *CancelDataRepositoryTaskInput

SetTaskId sets the TaskId field's value.

func (CancelDataRepositoryTaskInput) String added in v1.26.8 

func (s CancelDataRepositoryTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDataRepositoryTaskInput) Validate added in v1.26.8 

func (s *CancelDataRepositoryTaskInput) Validate() error

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

type CancelDataRepositoryTaskOutput added in v1.26.8 

type CancelDataRepositoryTaskOutput struct {

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

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

func (CancelDataRepositoryTaskOutput) GoString added in v1.26.8 

func (s CancelDataRepositoryTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelDataRepositoryTaskOutput) SetLifecycle added in v1.26.8 

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

SetLifecycle sets the Lifecycle field's value.

func (*CancelDataRepositoryTaskOutput) SetTaskId added in v1.26.8 

func (s *CancelDataRepositoryTaskOutput) SetTaskId(v string) *CancelDataRepositoryTaskOutput

SetTaskId sets the TaskId field's value.

func (CancelDataRepositoryTaskOutput) String added in v1.26.8 

func (s CancelDataRepositoryTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompletionReport added in v1.26.8 

type CompletionReport struct {

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

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

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

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

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

func (CompletionReport) GoString added in v1.26.8 

func (s CompletionReport) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompletionReport) SetEnabled added in v1.26.8 

func (s *CompletionReport) SetEnabled(v bool) *CompletionReport

SetEnabled sets the Enabled field's value.

func (*CompletionReport) SetFormat added in v1.26.8 

func (s *CompletionReport) SetFormat(v string) *CompletionReport

SetFormat sets the Format field's value.

func (*CompletionReport) SetPath added in v1.26.8 

func (s *CompletionReport) SetPath(v string) *CompletionReport

SetPath sets the Path field's value.

func (*CompletionReport) SetScope added in v1.26.8 

func (s *CompletionReport) SetScope(v string) *CompletionReport

SetScope sets the Scope field's value.

func (CompletionReport) String added in v1.26.8 

func (s CompletionReport) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompletionReport) Validate added in v1.26.8 

func (s *CompletionReport) Validate() error

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

type CopyBackupInput added in v1.38.18 

type CopyBackupInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A boolean flag indicating whether tags from the source backup should be copied
	// to the backup copy. This value defaults to false.
	//
	// If you set CopyTags to true and the source backup has existing tags, you
	// can use the Tags parameter to create new tags, provided that the sum of the
	// source backup tags and the new tags doesn't exceed 50. Both sets of tags
	// are merged. If there are tag conflicts (for example, two tags with the same
	// key but different values), the tags created with the Tags parameter take
	// precedence.
	CopyTags *bool `type:"boolean"`

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

	// The ID of the source backup. Specifies the ID of the backup that is being
	// copied.
	//
	// SourceBackupId is a required field
	SourceBackupId *string `min:"12" type:"string" required:"true"`

	// The source Amazon Web Services Region of the backup. Specifies the Amazon
	// Web Services Region from which the backup is being copied. The source and
	// destination Regions must be in the same Amazon Web Services partition. If
	// you don't specify a Region, it defaults to the Region where the request is
	// sent from (in-Region copy).
	SourceRegion *string `min:"1" type:"string"`

	// A list of Tag values, with a maximum of 50 elements.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CopyBackupInput) GoString added in v1.38.18 

func (s CopyBackupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyBackupInput) SetClientRequestToken added in v1.38.18 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CopyBackupInput) SetCopyTags added in v1.38.18 

func (s *CopyBackupInput) SetCopyTags(v bool) *CopyBackupInput

SetCopyTags sets the CopyTags field's value.

func (*CopyBackupInput) SetKmsKeyId added in v1.38.18 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopyBackupInput) SetSourceBackupId added in v1.38.18 

func (s *CopyBackupInput) SetSourceBackupId(v string) *CopyBackupInput

SetSourceBackupId sets the SourceBackupId field's value.

func (*CopyBackupInput) SetSourceRegion added in v1.38.18 

func (s *CopyBackupInput) SetSourceRegion(v string) *CopyBackupInput

SetSourceRegion sets the SourceRegion field's value.

func (*CopyBackupInput) SetTags added in v1.38.18 

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

SetTags sets the Tags field's value.

func (CopyBackupInput) String added in v1.38.18 

func (s CopyBackupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyBackupInput) Validate added in v1.38.18 

func (s *CopyBackupInput) Validate() error

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

type CopyBackupOutput added in v1.38.18 

type CopyBackupOutput struct {

	// A backup of an Amazon FSx for Windows File Server or Amazon FSx for Lustre
	// file system, or of an Amazon FSx for NetApp ONTAP volume.
	Backup *Backup `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyBackupOutput) GoString added in v1.38.18 

func (s CopyBackupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyBackupOutput) SetBackup added in v1.38.18 

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

SetBackup sets the Backup field's value.

func (CopyBackupOutput) String added in v1.38.18 

func (s CopyBackupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

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

	// (Optional) The tags to apply to the backup at backup creation. The key value
	// of the Name tag appears in the console as the backup name. If you have set
	// CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup
	// action, no existing file system tags are copied from the file system to the
	// backup.
	Tags []*Tag `min:"1" type:"list"`

	// The ID of he FSx for NetApp ONTAP volume to back up.
	VolumeId *string `min:"23" type:"string"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetVolumeId added in v1.40.36 

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

SetVolumeId sets the VolumeId field's value.

func (CreateBackupInput) String 

func (s CreateBackupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDataRepositoryTaskInput added in v1.26.8 

type CreateDataRepositoryTaskInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

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

	// (Optional) The path or paths on the Amazon FSx file system to use when the
	// data repository task is processed. The default path is the file system root
	// directory. The paths you provide need to be relative to the mount point of
	// the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory
	// or file on the file system you want to export, then the path to provide is
	// path1. If a path that you provide isn't valid, the task fails.
	Paths []*string `type:"list"`

	// Defines whether or not Amazon FSx provides a CompletionReport once the task
	// has completed. A CompletionReport provides a detailed report on the files
	// that Amazon FSx processed that meet the criteria specified by the Scope parameter.
	// For more information, see Working with Task Completion Reports (https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html).
	//
	// Report is a required field
	Report *CompletionReport `type:"structure" required:"true"`

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

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

func (CreateDataRepositoryTaskInput) GoString added in v1.26.8 

func (s CreateDataRepositoryTaskInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataRepositoryTaskInput) SetClientRequestToken added in v1.26.8 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDataRepositoryTaskInput) SetFileSystemId added in v1.26.8 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateDataRepositoryTaskInput) SetPaths added in v1.26.8 

func (s *CreateDataRepositoryTaskInput) SetPaths(v []*string) *CreateDataRepositoryTaskInput

SetPaths sets the Paths field's value.

func (*CreateDataRepositoryTaskInput) SetReport added in v1.26.8 

func (s *CreateDataRepositoryTaskInput) SetReport(v *CompletionReport) *CreateDataRepositoryTaskInput

SetReport sets the Report field's value.

func (*CreateDataRepositoryTaskInput) SetTags added in v1.26.8 

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

SetTags sets the Tags field's value.

func (*CreateDataRepositoryTaskInput) SetType added in v1.26.8 

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

SetType sets the Type field's value.

func (CreateDataRepositoryTaskInput) String added in v1.26.8 

func (s CreateDataRepositoryTaskInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataRepositoryTaskInput) Validate added in v1.26.8 

func (s *CreateDataRepositoryTaskInput) Validate() error

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

type CreateDataRepositoryTaskOutput added in v1.26.8 

type CreateDataRepositoryTaskOutput struct {

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

func (CreateDataRepositoryTaskOutput) GoString added in v1.26.8 

func (s CreateDataRepositoryTaskOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataRepositoryTaskOutput) SetDataRepositoryTask added in v1.26.8 

func (s *CreateDataRepositoryTaskOutput) SetDataRepositoryTask(v *DataRepositoryTask) *CreateDataRepositoryTaskOutput

SetDataRepositoryTask sets the DataRepositoryTask field's value.

func (CreateDataRepositoryTaskOutput) String added in v1.26.8 

func (s CreateDataRepositoryTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFileSystemFromBackupInput 

type CreateFileSystemFromBackupInput struct {

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

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

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

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

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

	// Sets the storage type for the Windows file system you're creating from a
	// backup. Valid values are SSD and HDD.
	//
	//    * Set to SSD to use solid state drive storage. Supported on all Windows
	//    deployment types.
	//
	//    * Set to HDD to use hard disk drive storage. Supported on SINGLE_AZ_2
	//    and MULTI_AZ_1 Windows file system deployment types.
	//
	// Default value is SSD.
	//
	// HDD and SSD storage types have different minimum storage capacity requirements.
	// A restored file system's storage capacity is tied to the file system that
	// was backed up. You can create a file system that uses HDD storage from a
	// backup of a file system that used SSD storage only if the original SSD file
	// system had a storage capacity of at least 2000 GiB.
	StorageType *string `type:"string" enum:"StorageType"`

	// Specifies the IDs of the subnets that the file system will be accessible
	// from. For Windows MULTI_AZ_1 file system deployment types, provide exactly
	// two subnet IDs, one for the preferred file server and one for the standby
	// file server. You specify one of these subnets as the preferred subnet using
	// the WindowsConfiguration > PreferredSubnetID property.
	//
	// For Windows SINGLE_AZ_1 and SINGLE_AZ_2 deployment types and Lustre file
	// systems, provide exactly one subnet ID. The file server is launched in that
	// subnet's Availability Zone.
	//
	// SubnetIds is a required field
	SubnetIds []*string `type:"list" required:"true"`

	// The tags to be applied to the file system at file system creation. The key
	// value of the Name tag appears in the console as the file system name.
	Tags []*Tag `min:"1" type:"list"`

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

The request object for the CreateFileSystemFromBackup operation.

func (CreateFileSystemFromBackupInput) GoString 

func (s CreateFileSystemFromBackupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetKmsKeyId added in v1.38.18 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateFileSystemFromBackupInput) SetLustreConfiguration added in v1.32.9 

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

SetLustreConfiguration sets the LustreConfiguration field's value.

func (*CreateFileSystemFromBackupInput) SetSecurityGroupIds 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateFileSystemFromBackupInput) SetStorageType added in v1.29.33 

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

SetStorageType sets the StorageType 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFileSystemInput 

type CreateFileSystemInput struct {

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

	// The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE,
	// and ONTAP.
	//
	// FileSystemType is a required field
	FileSystemType *string `type:"string" required:"true" enum:"FileSystemType"`

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

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

	// The ONTAP configuration properties of the FSx for NetApp ONTAP file system
	// that you are creating.
	OntapConfiguration *CreateFileSystemOntapConfiguration `type:"structure"`

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

	// Sets the storage capacity of the file system that you're creating.
	//
	// For Lustre file systems:
	//
	//    * For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are
	//    1200 GiB, 2400 GiB, and increments of 2400 GiB.
	//
	//    * For PERSISTENT HDD file systems, valid values are increments of 6000
	//    GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB
	//    file systems.
	//
	//    * For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB,
	//    and increments of 3600 GiB.
	//
	// For Windows file systems:
	//
	//    * If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
	//
	//    * If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
	//
	// For ONTAP file systems:
	//
	//    * Valid values are 1024 GiB - 196,608 GiB (192 TiB).
	//
	// StorageCapacity is a required field
	StorageCapacity *int64 `type:"integer" required:"true"`

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

	// Specifies the IDs of the subnets that the file system will be accessible
	// from. For Windows and ONTAP MULTI_AZ_1 file system deployment types, provide
	// exactly two subnet IDs, one for the preferred file server and one for the
	// standby file server. You specify one of these subnets as the preferred subnet
	// using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration
	// > PreferredSubnetID properties. For more information, see Availability and
	// durability: Single-AZ and Multi-AZ file systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html)
	// in the Amazon FSx for Windows User Guide and Availability and durability
	// (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html)
	// in the Amazon FSx for ONTAP User Guide.
	//
	// For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and
	// Lustre file systems, provide exactly one subnet ID. The file server is launched
	// in that subnet's Availability Zone.
	//
	// SubnetIds is a required field
	SubnetIds []*string `type:"list" required:"true"`

	// The tags to apply to the file system being created. The key value of the
	// Name tag appears in the console as the file system name.
	Tags []*Tag `min:"1" type:"list"`

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

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

func (CreateFileSystemInput) GoString 

func (s CreateFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetOntapConfiguration added in v1.40.36 

func (s *CreateFileSystemInput) SetOntapConfiguration(v *CreateFileSystemOntapConfiguration) *CreateFileSystemInput

SetOntapConfiguration sets the OntapConfiguration 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) SetStorageType added in v1.29.33 

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

SetStorageType sets the StorageType 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) When you create your file system, your existing S3 objects appear
	// as file and directory listings. Use this property to choose how Amazon FSx
	// keeps your file and directory listings up to date as you add or modify objects
	// in your linked S3 bucket. AutoImportPolicy can have the following values:
	//
	//    * NONE - (Default) AutoImport is off. Amazon FSx only updates file and
	//    directory listings from the linked S3 bucket when the file system is created.
	//    FSx does not update file and directory listings for any new or changed
	//    objects after choosing this option.
	//
	//    * NEW - AutoImport is on. Amazon FSx automatically imports directory listings
	//    of any new objects added to the linked S3 bucket that do not currently
	//    exist in the FSx file system.
	//
	//    * NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file
	//    and directory listings of any new objects added to the S3 bucket and any
	//    existing objects that are changed in the S3 bucket after you choose this
	//    option.
	//
	// For more information, see Automatically import updates from your S3 bucket
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html).
	AutoImportPolicy *string `type:"string" enum:"AutoImportPolicyType"`

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

	// (Optional) Not available to use with file systems that are linked to a data
	// repository. A boolean flag indicating whether tags for the file system should
	// be copied to backups. The default value is false. If it's set to true, all
	// file system tags are copied to all automatic and user-initiated backups when
	// the user doesn't specify any backup-specific tags. If this value is true,
	// and you specify one or more backup tags, only the specified tags are copied
	// to backups. If you specify one or more tags when creating a user-initiated
	// backup, no tags are copied from the file system, regardless of this value.
	//
	// For more information, see Working with backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html).
	CopyTagsToBackups *bool `type:"boolean"`

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

	// Sets the data compression configuration for the file system. DataCompressionType
	// can have the following values:
	//
	//    * NONE - (Default) Data compression is turned off when the file system
	//    is created.
	//
	//    * LZ4 - Data compression is turned on with the LZ4 algorithm.
	//
	// For more information, see Lustre data compression (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html).
	DataCompressionType *string `type:"string" enum:"DataCompressionType"`

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

	// The type of drive cache used by PERSISTENT_1 file systems that are provisioned
	// with HDD storage devices. This parameter is required when storage type is
	// HDD. Set to READ, improve the performance for frequently accessed files and
	// allows 20% of the total storage capacity of the file system to be cached.
	//
	// This parameter is required when StorageType is set to HDD.
	DriveCacheType *string `type:"string" enum:"DriveCacheType"`

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

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

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

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

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

The Lustre configuration for the file system being created.

func (CreateFileSystemLustreConfiguration) GoString 

func (s CreateFileSystemLustreConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemLustreConfiguration) SetAutoImportPolicy added in v1.33.11 

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

SetAutoImportPolicy sets the AutoImportPolicy field's value.

func (*CreateFileSystemLustreConfiguration) SetAutomaticBackupRetentionDays added in v1.32.9 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*CreateFileSystemLustreConfiguration) SetCopyTagsToBackups added in v1.32.9 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*CreateFileSystemLustreConfiguration) SetDailyAutomaticBackupStartTime added in v1.32.9 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*CreateFileSystemLustreConfiguration) SetDataCompressionType added in v1.38.50 

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

SetDataCompressionType sets the DataCompressionType field's value.

func (*CreateFileSystemLustreConfiguration) SetDeploymentType added in v1.29.9 

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

SetDeploymentType sets the DeploymentType field's value.

func (*CreateFileSystemLustreConfiguration) SetDriveCacheType added in v1.34.3 

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

SetDriveCacheType sets the DriveCacheType field's value.

func (*CreateFileSystemLustreConfiguration) SetExportPath added in v1.16.29 

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) SetPerUnitStorageThroughput added in v1.29.9 

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

SetPerUnitStorageThroughput sets the PerUnitStorageThroughput 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemLustreConfiguration) Validate 

func (s *CreateFileSystemLustreConfiguration) Validate() error

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

type CreateFileSystemOntapConfiguration added in v1.40.36 

type CreateFileSystemOntapConfiguration 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 90 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

	// Specifies the ONTAP file system deployment type to use in creating the file
	// system.
	//
	// DeploymentType is a required field
	DeploymentType *string `type:"string" required:"true" enum:"OntapDeploymentType"`

	// The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system.
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

	// Specifies the IP address range in which the endpoints to access your file
	// system will be created. By default, Amazon FSx selects an unused IP address
	// range for you from the 198.19.* range.
	EndpointIpAddressRange *string `min:"9" type:"string"`

	// The ONTAP administrative password for the fsxadmin user that you can use
	// to administer your file system using the ONTAP CLI and REST API.
	//
	// FsxAdminPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateFileSystemOntapConfiguration's
	// String and GoString methods.
	FsxAdminPassword *string `min:"8" type:"string" sensitive:"true"`

	// The ID for a subnet. A subnet is a range of IP addresses in your virtual
	// private cloud (VPC). For more information, see VPC and Subnets (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html)
	// in the Amazon VPC User Guide.
	PreferredSubnetId *string `min:"15" type:"string"`

	// Specifies the VPC route tables in which your file system's endpoints will
	// be created. You should specify all VPC route tables associated with the subnets
	// in which your clients are located. By default, Amazon FSx selects your VPC's
	// default route table.
	RouteTableIds []*string `type:"list"`

	// Sustained throughput of an Amazon FSx file system in MBps.
	//
	// ThroughputCapacity is a required field
	ThroughputCapacity *int64 `min:"8" type:"integer" required:"true"`

	// A recurring weekly time, in the format D:HH:MM.
	//
	// D is the day of the week, for which 1 represents Monday and 7 represents
	// Sunday. For further details, see the ISO-8601 spec as described on Wikipedia
	// (https://en.wikipedia.org/wiki/ISO_week_date).
	//
	// HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute
	// of the hour.
	//
	// For example, 1:05:00 specifies maintenance at 5 AM Monday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

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

func (CreateFileSystemOntapConfiguration) GoString added in v1.40.36 

func (s CreateFileSystemOntapConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemOntapConfiguration) SetAutomaticBackupRetentionDays added in v1.40.36 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*CreateFileSystemOntapConfiguration) SetDailyAutomaticBackupStartTime added in v1.40.36 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*CreateFileSystemOntapConfiguration) SetDeploymentType added in v1.40.36 

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

SetDeploymentType sets the DeploymentType field's value.

func (*CreateFileSystemOntapConfiguration) SetDiskIopsConfiguration added in v1.40.36 

func (s *CreateFileSystemOntapConfiguration) SetDiskIopsConfiguration(v *DiskIopsConfiguration) *CreateFileSystemOntapConfiguration

SetDiskIopsConfiguration sets the DiskIopsConfiguration field's value.

func (*CreateFileSystemOntapConfiguration) SetEndpointIpAddressRange added in v1.40.36 

func (s *CreateFileSystemOntapConfiguration) SetEndpointIpAddressRange(v string) *CreateFileSystemOntapConfiguration

SetEndpointIpAddressRange sets the EndpointIpAddressRange field's value.

func (*CreateFileSystemOntapConfiguration) SetFsxAdminPassword added in v1.40.36 

func (s *CreateFileSystemOntapConfiguration) SetFsxAdminPassword(v string) *CreateFileSystemOntapConfiguration

SetFsxAdminPassword sets the FsxAdminPassword field's value.

func (*CreateFileSystemOntapConfiguration) SetPreferredSubnetId added in v1.40.36 

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

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*CreateFileSystemOntapConfiguration) SetRouteTableIds added in v1.40.36 

func (s *CreateFileSystemOntapConfiguration) SetRouteTableIds(v []*string) *CreateFileSystemOntapConfiguration

SetRouteTableIds sets the RouteTableIds field's value.

func (*CreateFileSystemOntapConfiguration) SetThroughputCapacity added in v1.40.36 

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

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*CreateFileSystemOntapConfiguration) SetWeeklyMaintenanceStartTime added in v1.40.36 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (CreateFileSystemOntapConfiguration) String added in v1.40.36 

func (s CreateFileSystemOntapConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemOntapConfiguration) Validate added in v1.40.36 

func (s *CreateFileSystemOntapConfiguration) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFileSystemWindowsConfiguration 

type CreateFileSystemWindowsConfiguration struct {

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

	// An array of one or more DNS alias names that you want to associate with the
	// Amazon FSx file system. Aliases allow you to use existing DNS names to access
	// the data in your Amazon FSx file system. You can associate up to 50 aliases
	// with a file system at any time. You can associate additional DNS aliases
	// after you create the file system using the AssociateFileSystemAliases operation.
	// You can remove DNS aliases from the file system after it is created using
	// the DisassociateFileSystemAliases operation. You only need to specify the
	// alias name in the request payload.
	//
	// For more information, see Working with DNS Aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html)
	// and Walkthrough 5: Using DNS aliases to access your file system (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html),
	// including additional steps you must take to be able to access your file system
	// using a DNS alias.
	//
	// An alias name has to meet the following requirements:
	//
	//    * Formatted as a fully-qualified domain name (FQDN), hostname.domain,
	//    for example, accounting.example.com.
	//
	//    * Can contain alphanumeric characters, the underscore (_), and the hyphen
	//    (-).
	//
	//    * Cannot start or end with a hyphen.
	//
	//    * Can start with a numeric.
	//
	// For DNS alias names, Amazon FSx stores alphabetic characters as lowercase
	// letters (a-z), regardless of how you specify them: as uppercase letters,
	// lowercase letters, or the corresponding letters in escape codes.
	Aliases []*string `type:"list"`

	// The configuration that Amazon FSx for Windows File Server uses to audit and
	// log user accesses of files, folders, and file shares on the Amazon FSx for
	// Windows File Server file system.
	AuditLogConfiguration *WindowsAuditLogCreateConfiguration `type:"structure"`

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

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

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

	// Specifies the file system deployment type, valid values are the following:
	//
	//    * MULTI_AZ_1 - Deploys a high availability file system that is configured
	//    for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
	//    You can only deploy a Multi-AZ file system in Amazon Web Services Regions
	//    that have a minimum of three Availability Zones. Also supports HDD storage
	//    type
	//
	//    * SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured
	//    for single AZ redundancy.
	//
	//    * SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies
	//    a file system that is configured for single AZ redundancy and supports
	//    HDD storage type.
	//
	// For more information, see Availability and Durability: Single-AZ and Multi-AZ
	// File Systems (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-Amazon
	// Web Services applications, we recommend that you launch your clients in the
	// same Availability Zone (AZ) as your preferred file server to reduce cross-AZ
	// data transfer costs and minimize latency.
	PreferredSubnetId *string `min:"15" type:"string"`

	// The configuration that Amazon FSx uses to join a Amazon FSx for Windows File
	// Server file system or an ONTAP storage virtual machine (SVM) to a self-managed
	// (including on-premises) Microsoft Active Directory (AD) directory. For more
	// information, see Using Amazon FSx with your self-managed Microsoft Active
	// Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html)
	// or Managing SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html).
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration `type:"structure"`

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

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

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

func (CreateFileSystemWindowsConfiguration) GoString 

func (s CreateFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemWindowsConfiguration) SetActiveDirectoryId 

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

SetActiveDirectoryId sets the ActiveDirectoryId field's value.

func (*CreateFileSystemWindowsConfiguration) SetAliases added in v1.35.24 

func (s *CreateFileSystemWindowsConfiguration) SetAliases(v []*string) *CreateFileSystemWindowsConfiguration

SetAliases sets the Aliases field's value.

func (*CreateFileSystemWindowsConfiguration) SetAuditLogConfiguration added in v1.38.57 

func (s *CreateFileSystemWindowsConfiguration) SetAuditLogConfiguration(v *WindowsAuditLogCreateConfiguration) *CreateFileSystemWindowsConfiguration

SetAuditLogConfiguration sets the AuditLogConfiguration 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 added in v1.25.39 

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

SetDeploymentType sets the DeploymentType field's value.

func (*CreateFileSystemWindowsConfiguration) SetPreferredSubnetId added in v1.25.39 

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

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*CreateFileSystemWindowsConfiguration) SetSelfManagedActiveDirectoryConfiguration added in v1.20.7 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFileSystemWindowsConfiguration) Validate 

func (s *CreateFileSystemWindowsConfiguration) Validate() error

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

type CreateOntapVolumeConfiguration added in v1.40.36 

type CreateOntapVolumeConfiguration struct {

	// Specifies the location in the SVM's namespace where the volume is mounted.
	// The JunctionPath must have a leading forward slash, such as /vol3.
	//
	// JunctionPath is a required field
	JunctionPath *string `min:"1" type:"string" required:"true"`

	// The security style for the volume. Specify one of the following values:
	//
	//    * UNIX if the file system is managed by a UNIX administrator, the majority
	//    of users are NFS clients, and an application accessing the data uses a
	//    UNIX user as the service account. UNIX is the default.
	//
	//    * NTFS if the file system is managed by a Windows administrator, the majority
	//    of users are SMB clients, and an application accessing the data uses a
	//    Windows user as the service account.
	//
	//    * MIXED if the file system is managed by both UNIX and Windows administrators
	//    and users consist of both NFS and SMB clients.
	SecurityStyle *string `type:"string" enum:"SecurityStyle"`

	// Specifies the size of the volume, in megabytes (MB), that you are creating.
	//
	// SizeInMegabytes is a required field
	SizeInMegabytes *int64 `type:"integer" required:"true"`

	// Set to true to enable deduplication, compression, and compaction storage
	// efficiency features on the volume.
	//
	// StorageEfficiencyEnabled is a required field
	StorageEfficiencyEnabled *bool `type:"boolean" required:"true"`

	// Specifies the ONTAP SVM in which to create the volume.
	//
	// StorageVirtualMachineId is a required field
	StorageVirtualMachineId *string `min:"21" type:"string" required:"true"`

	// Describes the data tiering policy for an ONTAP volume. When enabled, Amazon
	// FSx for ONTAP's intelligent tiering automatically transitions a volume's
	// data between the file system's primary storage and capacity pool storage
	// based on your access patterns.
	TieringPolicy *TieringPolicy `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the configuration of the ONTAP volume that you are creating.

func (CreateOntapVolumeConfiguration) GoString added in v1.40.36 

func (s CreateOntapVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOntapVolumeConfiguration) SetJunctionPath added in v1.40.36 

func (s *CreateOntapVolumeConfiguration) SetJunctionPath(v string) *CreateOntapVolumeConfiguration

SetJunctionPath sets the JunctionPath field's value.

func (*CreateOntapVolumeConfiguration) SetSecurityStyle added in v1.40.36 

func (s *CreateOntapVolumeConfiguration) SetSecurityStyle(v string) *CreateOntapVolumeConfiguration

SetSecurityStyle sets the SecurityStyle field's value.

func (*CreateOntapVolumeConfiguration) SetSizeInMegabytes added in v1.40.36 

func (s *CreateOntapVolumeConfiguration) SetSizeInMegabytes(v int64) *CreateOntapVolumeConfiguration

SetSizeInMegabytes sets the SizeInMegabytes field's value.

func (*CreateOntapVolumeConfiguration) SetStorageEfficiencyEnabled added in v1.40.36 

func (s *CreateOntapVolumeConfiguration) SetStorageEfficiencyEnabled(v bool) *CreateOntapVolumeConfiguration

SetStorageEfficiencyEnabled sets the StorageEfficiencyEnabled field's value.

func (*CreateOntapVolumeConfiguration) SetStorageVirtualMachineId added in v1.40.36 

func (s *CreateOntapVolumeConfiguration) SetStorageVirtualMachineId(v string) *CreateOntapVolumeConfiguration

SetStorageVirtualMachineId sets the StorageVirtualMachineId field's value.

func (*CreateOntapVolumeConfiguration) SetTieringPolicy added in v1.40.36 

func (s *CreateOntapVolumeConfiguration) SetTieringPolicy(v *TieringPolicy) *CreateOntapVolumeConfiguration

SetTieringPolicy sets the TieringPolicy field's value.

func (CreateOntapVolumeConfiguration) String added in v1.40.36 

func (s CreateOntapVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateOntapVolumeConfiguration) Validate added in v1.40.36 

func (s *CreateOntapVolumeConfiguration) Validate() error

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

type CreateStorageVirtualMachineInput added in v1.40.36 

type CreateStorageVirtualMachineInput struct {

	// Describes the self-managed Microsoft Active Directory to which you want to
	// join the SVM. Joining an Active Directory provides user authentication and
	// access control for SMB clients, including Microsoft Windows and macOS client
	// accessing the file system.
	ActiveDirectoryConfiguration *CreateSvmActiveDirectoryConfiguration `type:"structure"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	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 name of the SVM.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The security style of the root volume of the SVM. Specify one of the following
	// values:
	//
	//    * UNIX if the file system is managed by a UNIX administrator, the majority
	//    of users are NFS clients, and an application accessing the data uses a
	//    UNIX user as the service account.
	//
	//    * NTFS if the file system is managed by a Windows administrator, the majority
	//    of users are SMB clients, and an application accessing the data uses a
	//    Windows user as the service account.
	//
	//    * MIXED if the file system is managed by both UNIX and Windows administrators
	//    and users consist of both NFS and SMB clients.
	RootVolumeSecurityStyle *string `type:"string" enum:"StorageVirtualMachineRootVolumeSecurityStyle"`

	// The password to use when managing the SVM using the NetApp ONTAP CLI or REST
	// API. If you do not specify a password, you can still use the file system's
	// fsxadmin user to manage the SVM.
	//
	// SvmAdminPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateStorageVirtualMachineInput's
	// String and GoString methods.
	SvmAdminPassword *string `min:"8" type:"string" sensitive:"true"`

	// A list of Tag values, with a maximum of 50 elements.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateStorageVirtualMachineInput) GoString added in v1.40.36 

func (s CreateStorageVirtualMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStorageVirtualMachineInput) SetActiveDirectoryConfiguration added in v1.40.36 

func (s *CreateStorageVirtualMachineInput) SetActiveDirectoryConfiguration(v *CreateSvmActiveDirectoryConfiguration) *CreateStorageVirtualMachineInput

SetActiveDirectoryConfiguration sets the ActiveDirectoryConfiguration field's value.

func (*CreateStorageVirtualMachineInput) SetClientRequestToken added in v1.40.36 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateStorageVirtualMachineInput) SetFileSystemId added in v1.40.36 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateStorageVirtualMachineInput) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (*CreateStorageVirtualMachineInput) SetRootVolumeSecurityStyle added in v1.40.36 

func (s *CreateStorageVirtualMachineInput) SetRootVolumeSecurityStyle(v string) *CreateStorageVirtualMachineInput

SetRootVolumeSecurityStyle sets the RootVolumeSecurityStyle field's value.

func (*CreateStorageVirtualMachineInput) SetSvmAdminPassword added in v1.40.36 

func (s *CreateStorageVirtualMachineInput) SetSvmAdminPassword(v string) *CreateStorageVirtualMachineInput

SetSvmAdminPassword sets the SvmAdminPassword field's value.

func (*CreateStorageVirtualMachineInput) SetTags added in v1.40.36 

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

SetTags sets the Tags field's value.

func (CreateStorageVirtualMachineInput) String added in v1.40.36 

func (s CreateStorageVirtualMachineInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStorageVirtualMachineInput) Validate added in v1.40.36 

func (s *CreateStorageVirtualMachineInput) Validate() error

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

type CreateStorageVirtualMachineOutput added in v1.40.36 

type CreateStorageVirtualMachineOutput struct {

	// Returned after a successful CreateStorageVirtualMachine operation; describes
	// the SVM just created.
	StorageVirtualMachine *StorageVirtualMachine `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateStorageVirtualMachineOutput) GoString added in v1.40.36 

func (s CreateStorageVirtualMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStorageVirtualMachineOutput) SetStorageVirtualMachine added in v1.40.36 

func (s *CreateStorageVirtualMachineOutput) SetStorageVirtualMachine(v *StorageVirtualMachine) *CreateStorageVirtualMachineOutput

SetStorageVirtualMachine sets the StorageVirtualMachine field's value.

func (CreateStorageVirtualMachineOutput) String added in v1.40.36 

func (s CreateStorageVirtualMachineOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSvmActiveDirectoryConfiguration added in v1.40.36 

type CreateSvmActiveDirectoryConfiguration struct {

	// The NetBIOS name of the Active Directory computer object that will be created
	// for your SVM.
	//
	// NetBiosName is a required field
	NetBiosName *string `min:"1" type:"string" required:"true"`

	// The configuration that Amazon FSx uses to join a Amazon FSx for Windows File
	// Server file system or an ONTAP storage virtual machine (SVM) to a self-managed
	// (including on-premises) Microsoft Active Directory (AD) directory. For more
	// information, see Using Amazon FSx with your self-managed Microsoft Active
	// Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html)
	// or Managing SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html).
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

func (CreateSvmActiveDirectoryConfiguration) GoString added in v1.40.36 

func (s CreateSvmActiveDirectoryConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSvmActiveDirectoryConfiguration) SetNetBiosName added in v1.40.36 

func (s *CreateSvmActiveDirectoryConfiguration) SetNetBiosName(v string) *CreateSvmActiveDirectoryConfiguration

SetNetBiosName sets the NetBiosName field's value.

func (*CreateSvmActiveDirectoryConfiguration) SetSelfManagedActiveDirectoryConfiguration added in v1.40.36 

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

SetSelfManagedActiveDirectoryConfiguration sets the SelfManagedActiveDirectoryConfiguration field's value.

func (CreateSvmActiveDirectoryConfiguration) String added in v1.40.36 

func (s CreateSvmActiveDirectoryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSvmActiveDirectoryConfiguration) Validate added in v1.40.36 

func (s *CreateSvmActiveDirectoryConfiguration) Validate() error

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

type CreateVolumeFromBackupInput added in v1.40.36 

type CreateVolumeFromBackupInput struct {

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

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The name of the new volume you're creating.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Specifies the configuration of the ONTAP volume that you are creating.
	OntapConfiguration *CreateOntapVolumeConfiguration `type:"structure"`

	// A list of Tag values, with a maximum of 50 elements.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateVolumeFromBackupInput) GoString added in v1.40.36 

func (s CreateVolumeFromBackupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVolumeFromBackupInput) SetBackupId added in v1.40.36 

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

SetBackupId sets the BackupId field's value.

func (*CreateVolumeFromBackupInput) SetClientRequestToken added in v1.40.36 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateVolumeFromBackupInput) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (*CreateVolumeFromBackupInput) SetOntapConfiguration added in v1.40.36 

func (s *CreateVolumeFromBackupInput) SetOntapConfiguration(v *CreateOntapVolumeConfiguration) *CreateVolumeFromBackupInput

SetOntapConfiguration sets the OntapConfiguration field's value.

func (*CreateVolumeFromBackupInput) SetTags added in v1.40.36 

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

SetTags sets the Tags field's value.

func (CreateVolumeFromBackupInput) String added in v1.40.36 

func (s CreateVolumeFromBackupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVolumeFromBackupInput) Validate added in v1.40.36 

func (s *CreateVolumeFromBackupInput) Validate() error

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

type CreateVolumeFromBackupOutput added in v1.40.36 

type CreateVolumeFromBackupOutput struct {

	// Returned after a successful CreateVolumeFromBackup API operation, describing
	// the volume just created.
	Volume *Volume `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateVolumeFromBackupOutput) GoString added in v1.40.36 

func (s CreateVolumeFromBackupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVolumeFromBackupOutput) SetVolume added in v1.40.36 

func (s *CreateVolumeFromBackupOutput) SetVolume(v *Volume) *CreateVolumeFromBackupOutput

SetVolume sets the Volume field's value.

func (CreateVolumeFromBackupOutput) String added in v1.40.36 

func (s CreateVolumeFromBackupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateVolumeInput added in v1.40.36 

type CreateVolumeInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Specifies the name of the volume you're creating.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Specifies the ONTAP configuration to use in creating the volume.
	OntapConfiguration *CreateOntapVolumeConfiguration `type:"structure"`

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

	// Specifies the type of volume to create; ONTAP is the only valid volume type.
	//
	// VolumeType is a required field
	VolumeType *string `type:"string" required:"true" enum:"VolumeType"`
	// contains filtered or unexported fields
}

func (CreateVolumeInput) GoString added in v1.40.36 

func (s CreateVolumeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVolumeInput) SetClientRequestToken added in v1.40.36 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateVolumeInput) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (*CreateVolumeInput) SetOntapConfiguration added in v1.40.36 

func (s *CreateVolumeInput) SetOntapConfiguration(v *CreateOntapVolumeConfiguration) *CreateVolumeInput

SetOntapConfiguration sets the OntapConfiguration field's value.

func (*CreateVolumeInput) SetTags added in v1.40.36 

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

SetTags sets the Tags field's value.

func (*CreateVolumeInput) SetVolumeType added in v1.40.36 

func (s *CreateVolumeInput) SetVolumeType(v string) *CreateVolumeInput

SetVolumeType sets the VolumeType field's value.

func (CreateVolumeInput) String added in v1.40.36 

func (s CreateVolumeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVolumeInput) Validate added in v1.40.36 

func (s *CreateVolumeInput) Validate() error

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

type CreateVolumeOutput added in v1.40.36 

type CreateVolumeOutput struct {

	// Returned after a successful CreateVolume API operation, describing the volume
	// just created.
	Volume *Volume `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateVolumeOutput) GoString added in v1.40.36 

func (s CreateVolumeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateVolumeOutput) SetVolume added in v1.40.36 

func (s *CreateVolumeOutput) SetVolume(v *Volume) *CreateVolumeOutput

SetVolume sets the Volume field's value.

func (CreateVolumeOutput) String added in v1.40.36 

func (s CreateVolumeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryConfiguration 

type DataRepositoryConfiguration struct {

	// Describes the file system's linked S3 data repository's AutoImportPolicy.
	// The AutoImportPolicy configures how Amazon FSx keeps your file and directory
	// listings up to date as you add or modify objects in your linked S3 bucket.
	// AutoImportPolicy can have the following values:
	//
	//    * NONE - (Default) AutoImport is off. Amazon FSx only updates file and
	//    directory listings from the linked S3 bucket when the file system is created.
	//    FSx does not update file and directory listings for any new or changed
	//    objects after choosing this option.
	//
	//    * NEW - AutoImport is on. Amazon FSx automatically imports directory listings
	//    of any new objects added to the linked S3 bucket that do not currently
	//    exist in the FSx file system.
	//
	//    * NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file
	//    and directory listings of any new objects added to the S3 bucket and any
	//    existing objects that are changed in the S3 bucket after you choose this
	//    option.
	//
	// For more information, see Automatically import updates from your S3 bucket
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html).
	AutoImportPolicy *string `type:"string" enum:"AutoImportPolicyType"`

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

	// Provides detailed information about the data respository if its Lifecycle
	// is set to MISCONFIGURED.
	FailureDetails *DataRepositoryFailureDetails `type:"structure"`

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

	// Describes the state of the file system's S3 durable data repository, if it
	// is configured with an S3 repository. The lifecycle can have the following
	// values:
	//
	//    * CREATING - The data repository configuration between the FSx file system
	//    and the linked S3 data repository is being created. The data repository
	//    is unavailable.
	//
	//    * AVAILABLE - The data repository is available for use.
	//
	//    * MISCONFIGURED - Amazon FSx cannot automatically import updates from
	//    the S3 bucket until the data repository configuration is corrected. For
	//    more information, see Troubleshooting a Misconfigured linked S3 bucket
	//    (https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository).
	//
	//    * UPDATING - The data repository is undergoing a customer initiated update
	//    and availability may be impacted.
	Lifecycle *string `type:"string" enum:"DataRepositoryLifecycle"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryConfiguration) SetAutoImportPolicy added in v1.33.11 

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

SetAutoImportPolicy sets the AutoImportPolicy field's value.

func (*DataRepositoryConfiguration) SetExportPath 

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

SetExportPath sets the ExportPath field's value.

func (*DataRepositoryConfiguration) SetFailureDetails added in v1.33.11 

func (s *DataRepositoryConfiguration) SetFailureDetails(v *DataRepositoryFailureDetails) *DataRepositoryConfiguration

SetFailureDetails sets the FailureDetails 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) SetLifecycle added in v1.33.11 

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

SetLifecycle sets the Lifecycle field's value.

func (DataRepositoryConfiguration) String 

func (s DataRepositoryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryFailureDetails added in v1.33.11 

type DataRepositoryFailureDetails struct {

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

Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED.

func (DataRepositoryFailureDetails) GoString added in v1.33.11 

func (s DataRepositoryFailureDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryFailureDetails) SetMessage added in v1.33.11 

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

SetMessage sets the Message field's value.

func (DataRepositoryFailureDetails) String added in v1.33.11 

func (s DataRepositoryFailureDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryTask added in v1.26.8 

type DataRepositoryTask struct {

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

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

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

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

	// The lifecycle status of the data repository task, as follows:
	//
	//    * PENDING - Amazon FSx has not started the task.
	//
	//    * EXECUTING - Amazon FSx is processing the task.
	//
	//    * FAILED - Amazon FSx was not able to complete the task. For example,
	//    there may be files the task failed to process. The DataRepositoryTaskFailureDetails
	//    property provides more information about task failures.
	//
	//    * SUCCEEDED - FSx completed the task successfully.
	//
	//    * CANCELED - Amazon FSx canceled the task and it did not complete.
	//
	//    * CANCELING - FSx is in process of canceling the task.
	//
	// You cannot delete an FSx for Lustre file system if there are data repository
	// tasks for the file system in the PENDING or EXECUTING states. Please retry
	// when the data repository task is finished (with a status of CANCELED, SUCCEEDED,
	// or FAILED). You can use the DescribeDataRepositoryTask action to monitor
	// the task status. Contact the FSx team if you need to delete your file system
	// immediately.
	//
	// Lifecycle is a required field
	Lifecycle *string `type:"string" required:"true" enum:"DataRepositoryTaskLifecycle"`

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

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

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

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

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

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

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

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

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

func (DataRepositoryTask) GoString added in v1.26.8 

func (s DataRepositoryTask) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryTask) SetCreationTime added in v1.26.8 

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

SetCreationTime sets the CreationTime field's value.

func (*DataRepositoryTask) SetEndTime added in v1.26.8 

func (s *DataRepositoryTask) SetEndTime(v time.Time) *DataRepositoryTask

SetEndTime sets the EndTime field's value.

func (*DataRepositoryTask) SetFailureDetails added in v1.26.8 

func (s *DataRepositoryTask) SetFailureDetails(v *DataRepositoryTaskFailureDetails) *DataRepositoryTask

SetFailureDetails sets the FailureDetails field's value.

func (*DataRepositoryTask) SetFileSystemId added in v1.26.8 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DataRepositoryTask) SetLifecycle added in v1.26.8 

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

SetLifecycle sets the Lifecycle field's value.

func (*DataRepositoryTask) SetPaths added in v1.26.8 

func (s *DataRepositoryTask) SetPaths(v []*string) *DataRepositoryTask

SetPaths sets the Paths field's value.

func (*DataRepositoryTask) SetReport added in v1.26.8 

func (s *DataRepositoryTask) SetReport(v *CompletionReport) *DataRepositoryTask

SetReport sets the Report field's value.

func (*DataRepositoryTask) SetResourceARN added in v1.26.8 

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

SetResourceARN sets the ResourceARN field's value.

func (*DataRepositoryTask) SetStartTime added in v1.26.8 

func (s *DataRepositoryTask) SetStartTime(v time.Time) *DataRepositoryTask

SetStartTime sets the StartTime field's value.

func (*DataRepositoryTask) SetStatus added in v1.26.8 

func (s *DataRepositoryTask) SetStatus(v *DataRepositoryTaskStatus) *DataRepositoryTask

SetStatus sets the Status field's value.

func (*DataRepositoryTask) SetTags added in v1.26.8 

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

SetTags sets the Tags field's value.

func (*DataRepositoryTask) SetTaskId added in v1.26.8 

func (s *DataRepositoryTask) SetTaskId(v string) *DataRepositoryTask

SetTaskId sets the TaskId field's value.

func (*DataRepositoryTask) SetType added in v1.26.8 

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

SetType sets the Type field's value.

func (DataRepositoryTask) String added in v1.26.8 

func (s DataRepositoryTask) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryTaskEnded added in v1.28.0 

type DataRepositoryTaskEnded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The data repository task could not be canceled because the task has already ended.

func (*DataRepositoryTaskEnded) Code added in v1.28.0 

func (s *DataRepositoryTaskEnded) Code() string

Code returns the exception type name.

func (*DataRepositoryTaskEnded) Error added in v1.28.0 

func (s *DataRepositoryTaskEnded) Error() string

func (DataRepositoryTaskEnded) GoString added in v1.28.0 

func (s DataRepositoryTaskEnded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryTaskEnded) Message added in v1.28.0 

func (s *DataRepositoryTaskEnded) Message() string

Message returns the exception's message.

func (*DataRepositoryTaskEnded) OrigErr added in v1.28.0 

func (s *DataRepositoryTaskEnded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DataRepositoryTaskEnded) RequestID added in v1.28.0 

func (s *DataRepositoryTaskEnded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DataRepositoryTaskEnded) StatusCode added in v1.28.0 

func (s *DataRepositoryTaskEnded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DataRepositoryTaskEnded) String added in v1.28.0 

func (s DataRepositoryTaskEnded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryTaskExecuting added in v1.28.0 

type DataRepositoryTaskExecuting struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.

func (*DataRepositoryTaskExecuting) Code added in v1.28.0 

func (s *DataRepositoryTaskExecuting) Code() string

Code returns the exception type name.

func (*DataRepositoryTaskExecuting) Error added in v1.28.0 

func (s *DataRepositoryTaskExecuting) Error() string

func (DataRepositoryTaskExecuting) GoString added in v1.28.0 

func (s DataRepositoryTaskExecuting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryTaskExecuting) Message added in v1.28.0 

func (s *DataRepositoryTaskExecuting) Message() string

Message returns the exception's message.

func (*DataRepositoryTaskExecuting) OrigErr added in v1.28.0 

func (s *DataRepositoryTaskExecuting) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DataRepositoryTaskExecuting) RequestID added in v1.28.0 

func (s *DataRepositoryTaskExecuting) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DataRepositoryTaskExecuting) StatusCode added in v1.28.0 

func (s *DataRepositoryTaskExecuting) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DataRepositoryTaskExecuting) String added in v1.28.0 

func (s DataRepositoryTaskExecuting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryTaskFailureDetails added in v1.26.8 

type DataRepositoryTaskFailureDetails struct {

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

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

func (DataRepositoryTaskFailureDetails) GoString added in v1.26.8 

func (s DataRepositoryTaskFailureDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryTaskFailureDetails) SetMessage added in v1.26.8 

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

SetMessage sets the Message field's value.

func (DataRepositoryTaskFailureDetails) String added in v1.26.8 

func (s DataRepositoryTaskFailureDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryTaskFilter added in v1.26.8 

type DataRepositoryTaskFilter struct {

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

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

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

func (DataRepositoryTaskFilter) GoString added in v1.26.8 

func (s DataRepositoryTaskFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryTaskFilter) SetName added in v1.26.8 

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

SetName sets the Name field's value.

func (*DataRepositoryTaskFilter) SetValues added in v1.26.8 

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

SetValues sets the Values field's value.

func (DataRepositoryTaskFilter) String added in v1.26.8 

func (s DataRepositoryTaskFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryTaskNotFound added in v1.28.0 

type DataRepositoryTaskNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The data repository task or tasks you specified could not be found.

func (*DataRepositoryTaskNotFound) Code added in v1.28.0 

func (s *DataRepositoryTaskNotFound) Code() string

Code returns the exception type name.

func (*DataRepositoryTaskNotFound) Error added in v1.28.0 

func (s *DataRepositoryTaskNotFound) Error() string

func (DataRepositoryTaskNotFound) GoString added in v1.28.0 

func (s DataRepositoryTaskNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryTaskNotFound) Message added in v1.28.0 

func (s *DataRepositoryTaskNotFound) Message() string

Message returns the exception's message.

func (*DataRepositoryTaskNotFound) OrigErr added in v1.28.0 

func (s *DataRepositoryTaskNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DataRepositoryTaskNotFound) RequestID added in v1.28.0 

func (s *DataRepositoryTaskNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DataRepositoryTaskNotFound) StatusCode added in v1.28.0 

func (s *DataRepositoryTaskNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DataRepositoryTaskNotFound) String added in v1.28.0 

func (s DataRepositoryTaskNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataRepositoryTaskStatus added in v1.26.8 

type DataRepositoryTaskStatus struct {

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

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

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

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

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

func (DataRepositoryTaskStatus) GoString added in v1.26.8 

func (s DataRepositoryTaskStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataRepositoryTaskStatus) SetFailedCount added in v1.26.8 

func (s *DataRepositoryTaskStatus) SetFailedCount(v int64) *DataRepositoryTaskStatus

SetFailedCount sets the FailedCount field's value.

func (*DataRepositoryTaskStatus) SetLastUpdatedTime added in v1.26.8 

func (s *DataRepositoryTaskStatus) SetLastUpdatedTime(v time.Time) *DataRepositoryTaskStatus

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*DataRepositoryTaskStatus) SetSucceededCount added in v1.26.8 

func (s *DataRepositoryTaskStatus) SetSucceededCount(v int64) *DataRepositoryTaskStatus

SetSucceededCount sets the SucceededCount field's value.

func (*DataRepositoryTaskStatus) SetTotalCount added in v1.26.8 

func (s *DataRepositoryTaskStatus) SetTotalCount(v int64) *DataRepositoryTaskStatus

SetTotalCount sets the TotalCount field's value.

func (DataRepositoryTaskStatus) String added in v1.26.8 

func (s DataRepositoryTaskStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBackupInput 

type DeleteBackupInput struct {

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

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFileSystemInput 

type DeleteFileSystemInput struct {

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

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

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

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

The request object for DeleteFileSystem operation.

func (DeleteFileSystemInput) GoString 

func (s DeleteFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetLustreConfiguration added in v1.32.9 

func (s *DeleteFileSystemInput) SetLustreConfiguration(v *DeleteFileSystemLustreConfiguration) *DeleteFileSystemInput

SetLustreConfiguration sets the LustreConfiguration 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemInput) Validate 

func (s *DeleteFileSystemInput) Validate() error

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

type DeleteFileSystemLustreConfiguration added in v1.32.9 

type DeleteFileSystemLustreConfiguration struct {

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

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

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

func (DeleteFileSystemLustreConfiguration) GoString added in v1.32.9 

func (s DeleteFileSystemLustreConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemLustreConfiguration) SetFinalBackupTags added in v1.32.9 

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

SetFinalBackupTags sets the FinalBackupTags field's value.

func (*DeleteFileSystemLustreConfiguration) SetSkipFinalBackup added in v1.32.9 

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

SetSkipFinalBackup sets the SkipFinalBackup field's value.

func (DeleteFileSystemLustreConfiguration) String added in v1.32.9 

func (s DeleteFileSystemLustreConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemLustreConfiguration) Validate added in v1.32.9 

func (s *DeleteFileSystemLustreConfiguration) Validate() error

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

type DeleteFileSystemLustreResponse added in v1.32.9 

type DeleteFileSystemLustreResponse struct {

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

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

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

func (DeleteFileSystemLustreResponse) GoString added in v1.32.9 

func (s DeleteFileSystemLustreResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFileSystemLustreResponse) SetFinalBackupId added in v1.32.9 

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

SetFinalBackupId sets the FinalBackupId field's value.

func (*DeleteFileSystemLustreResponse) SetFinalBackupTags added in v1.32.9 

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

SetFinalBackupTags sets the FinalBackupTags field's value.

func (DeleteFileSystemLustreResponse) String added in v1.32.9 

func (s DeleteFileSystemLustreResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon FSx for Lustre file system being deleted
	// in the DeleteFileSystem operation.
	LustreResponse *DeleteFileSystemLustreResponse `type:"structure"`

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

The response object for the DeleteFileSystem operation.

func (DeleteFileSystemOutput) GoString 

func (s DeleteFileSystemOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetLustreResponse added in v1.32.9 

func (s *DeleteFileSystemOutput) SetLustreResponse(v *DeleteFileSystemLustreResponse) *DeleteFileSystemOutput

SetLustreResponse sets the LustreResponse 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStorageVirtualMachineInput added in v1.40.36 

type DeleteStorageVirtualMachineInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the SVM that you want to delete.
	//
	// StorageVirtualMachineId is a required field
	StorageVirtualMachineId *string `min:"21" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStorageVirtualMachineInput) GoString added in v1.40.36 

func (s DeleteStorageVirtualMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStorageVirtualMachineInput) SetClientRequestToken added in v1.40.36 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteStorageVirtualMachineInput) SetStorageVirtualMachineId added in v1.40.36 

func (s *DeleteStorageVirtualMachineInput) SetStorageVirtualMachineId(v string) *DeleteStorageVirtualMachineInput

SetStorageVirtualMachineId sets the StorageVirtualMachineId field's value.

func (DeleteStorageVirtualMachineInput) String added in v1.40.36 

func (s DeleteStorageVirtualMachineInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStorageVirtualMachineInput) Validate added in v1.40.36 

func (s *DeleteStorageVirtualMachineInput) Validate() error

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

type DeleteStorageVirtualMachineOutput added in v1.40.36 

type DeleteStorageVirtualMachineOutput struct {

	// Describes the lifecycle state of the SVM being deleted.
	Lifecycle *string `type:"string" enum:"StorageVirtualMachineLifecycle"`

	// The ID of the SVM Amazon FSx is deleting.
	StorageVirtualMachineId *string `min:"21" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteStorageVirtualMachineOutput) GoString added in v1.40.36 

func (s DeleteStorageVirtualMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStorageVirtualMachineOutput) SetLifecycle added in v1.40.36 

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

SetLifecycle sets the Lifecycle field's value.

func (*DeleteStorageVirtualMachineOutput) SetStorageVirtualMachineId added in v1.40.36 

func (s *DeleteStorageVirtualMachineOutput) SetStorageVirtualMachineId(v string) *DeleteStorageVirtualMachineOutput

SetStorageVirtualMachineId sets the StorageVirtualMachineId field's value.

func (DeleteStorageVirtualMachineOutput) String added in v1.40.36 

func (s DeleteStorageVirtualMachineOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteVolumeInput added in v1.40.36 

type DeleteVolumeInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// For Amazon FSx for ONTAP volumes, specify whether to take a final backup
	// of the volume, and apply tags to the backup.
	OntapConfiguration *DeleteVolumeOntapConfiguration `type:"structure"`

	// The ID of the volume you are deleting.
	//
	// VolumeId is a required field
	VolumeId *string `min:"23" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteVolumeInput) GoString added in v1.40.36 

func (s DeleteVolumeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVolumeInput) SetClientRequestToken added in v1.40.36 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteVolumeInput) SetOntapConfiguration added in v1.40.36 

func (s *DeleteVolumeInput) SetOntapConfiguration(v *DeleteVolumeOntapConfiguration) *DeleteVolumeInput

SetOntapConfiguration sets the OntapConfiguration field's value.

func (*DeleteVolumeInput) SetVolumeId added in v1.40.36 

func (s *DeleteVolumeInput) SetVolumeId(v string) *DeleteVolumeInput

SetVolumeId sets the VolumeId field's value.

func (DeleteVolumeInput) String added in v1.40.36 

func (s DeleteVolumeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVolumeInput) Validate added in v1.40.36 

func (s *DeleteVolumeInput) Validate() error

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

type DeleteVolumeOntapConfiguration added in v1.40.36 

type DeleteVolumeOntapConfiguration struct {

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

	// Set to true if you want to skip taking a final backup of the volume you are
	// deleting.
	SkipFinalBackup *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Use to specify skipping a final backup, or to add tags to a final backup.

func (DeleteVolumeOntapConfiguration) GoString added in v1.40.36 

func (s DeleteVolumeOntapConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVolumeOntapConfiguration) SetFinalBackupTags added in v1.40.36 

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

SetFinalBackupTags sets the FinalBackupTags field's value.

func (*DeleteVolumeOntapConfiguration) SetSkipFinalBackup added in v1.40.36 

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

SetSkipFinalBackup sets the SkipFinalBackup field's value.

func (DeleteVolumeOntapConfiguration) String added in v1.40.36 

func (s DeleteVolumeOntapConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVolumeOntapConfiguration) Validate added in v1.40.36 

func (s *DeleteVolumeOntapConfiguration) Validate() error

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

type DeleteVolumeOntapResponse added in v1.40.36 

type DeleteVolumeOntapResponse struct {

	// The ID of the source backup. Specifies the backup you are copying.
	FinalBackupId *string `min:"12" type:"string"`

	// A list of Tag values, with a maximum of 50 elements.
	FinalBackupTags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The response object for the Amazon FSx for NetApp ONTAP volume being deleted in the DeleteVolume operation.

func (DeleteVolumeOntapResponse) GoString added in v1.40.36 

func (s DeleteVolumeOntapResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVolumeOntapResponse) SetFinalBackupId added in v1.40.36 

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

SetFinalBackupId sets the FinalBackupId field's value.

func (*DeleteVolumeOntapResponse) SetFinalBackupTags added in v1.40.36 

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

SetFinalBackupTags sets the FinalBackupTags field's value.

func (DeleteVolumeOntapResponse) String added in v1.40.36 

func (s DeleteVolumeOntapResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteVolumeOutput added in v1.40.36 

type DeleteVolumeOutput struct {

	// Describes the lifecycle state of the volume being deleted.
	Lifecycle *string `type:"string" enum:"VolumeLifecycle"`

	// Returned after a DeleteVolume request, showing the status of the delete request.
	OntapResponse *DeleteVolumeOntapResponse `type:"structure"`

	// The ID of the volume being deleted.
	VolumeId *string `min:"23" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteVolumeOutput) GoString added in v1.40.36 

func (s DeleteVolumeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteVolumeOutput) SetLifecycle added in v1.40.36 

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

SetLifecycle sets the Lifecycle field's value.

func (*DeleteVolumeOutput) SetOntapResponse added in v1.40.36 

func (s *DeleteVolumeOutput) SetOntapResponse(v *DeleteVolumeOntapResponse) *DeleteVolumeOutput

SetOntapResponse sets the OntapResponse field's value.

func (*DeleteVolumeOutput) SetVolumeId added in v1.40.36 

func (s *DeleteVolumeOutput) SetVolumeId(v string) *DeleteVolumeOutput

SetVolumeId sets the VolumeId field's value.

func (DeleteVolumeOutput) String added in v1.40.36 

func (s DeleteVolumeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBackupsInput 

type DescribeBackupsInput struct {

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

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

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

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

The request object for DescribeBackups operation.

func (DescribeBackupsInput) GoString 

func (s DescribeBackupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDataRepositoryTasksInput added in v1.26.8 

type DescribeDataRepositoryTasksInput struct {

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

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

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

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

func (DescribeDataRepositoryTasksInput) GoString added in v1.26.8 

func (s DescribeDataRepositoryTasksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataRepositoryTasksInput) SetFilters added in v1.26.8 

func (s *DescribeDataRepositoryTasksInput) SetFilters(v []*DataRepositoryTaskFilter) *DescribeDataRepositoryTasksInput

SetFilters sets the Filters field's value.

func (*DescribeDataRepositoryTasksInput) SetMaxResults added in v1.26.8 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeDataRepositoryTasksInput) SetNextToken added in v1.26.8 

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

SetNextToken sets the NextToken field's value.

func (*DescribeDataRepositoryTasksInput) SetTaskIds added in v1.26.8 

func (s *DescribeDataRepositoryTasksInput) SetTaskIds(v []*string) *DescribeDataRepositoryTasksInput

SetTaskIds sets the TaskIds field's value.

func (DescribeDataRepositoryTasksInput) String added in v1.26.8 

func (s DescribeDataRepositoryTasksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataRepositoryTasksInput) Validate added in v1.26.8 

func (s *DescribeDataRepositoryTasksInput) Validate() error

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

type DescribeDataRepositoryTasksOutput added in v1.26.8 

type DescribeDataRepositoryTasksOutput struct {

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

	// (Optional) Opaque pagination token returned from a previous operation (String).
	// If present, this token indicates from what point you can continue processing
	// the request, where the previous NextToken value left off.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDataRepositoryTasksOutput) GoString added in v1.26.8 

func (s DescribeDataRepositoryTasksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataRepositoryTasksOutput) SetDataRepositoryTasks added in v1.26.8 

func (s *DescribeDataRepositoryTasksOutput) SetDataRepositoryTasks(v []*DataRepositoryTask) *DescribeDataRepositoryTasksOutput

SetDataRepositoryTasks sets the DataRepositoryTasks field's value.

func (*DescribeDataRepositoryTasksOutput) SetNextToken added in v1.26.8 

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

SetNextToken sets the NextToken field's value.

func (DescribeDataRepositoryTasksOutput) String added in v1.26.8 

func (s DescribeDataRepositoryTasksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFileSystemAliasesInput added in v1.35.24 

type DescribeFileSystemAliasesInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the file system to return the associated DNS aliases for (String).
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

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

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

The request object for DescribeFileSystemAliases operation.

func (DescribeFileSystemAliasesInput) GoString added in v1.35.24 

func (s DescribeFileSystemAliasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemAliasesInput) SetClientRequestToken added in v1.35.24 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DescribeFileSystemAliasesInput) SetFileSystemId added in v1.35.24 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DescribeFileSystemAliasesInput) SetMaxResults added in v1.35.24 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeFileSystemAliasesInput) SetNextToken added in v1.35.24 

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

SetNextToken sets the NextToken field's value.

func (DescribeFileSystemAliasesInput) String added in v1.35.24 

func (s DescribeFileSystemAliasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemAliasesInput) Validate added in v1.35.24 

func (s *DescribeFileSystemAliasesInput) Validate() error

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

type DescribeFileSystemAliasesOutput added in v1.35.24 

type DescribeFileSystemAliasesOutput struct {

	// An array of one or more DNS aliases currently associated with the specified
	// file system.
	Aliases []*Alias `type:"list"`

	// Present if there are more DNS aliases than returned in the response (String).
	// You can use the NextToken value in a later request to fetch additional descriptions.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The response object for DescribeFileSystemAliases operation.

func (DescribeFileSystemAliasesOutput) GoString added in v1.35.24 

func (s DescribeFileSystemAliasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFileSystemAliasesOutput) SetAliases added in v1.35.24 

func (s *DescribeFileSystemAliasesOutput) SetAliases(v []*Alias) *DescribeFileSystemAliasesOutput

SetAliases sets the Aliases field's value.

func (*DescribeFileSystemAliasesOutput) SetNextToken added in v1.35.24 

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

SetNextToken sets the NextToken field's value.

func (DescribeFileSystemAliasesOutput) String added in v1.35.24 

func (s DescribeFileSystemAliasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFileSystemsInput 

type DescribeFileSystemsInput struct {

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

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

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

The request object for DescribeFileSystems operation.

func (DescribeFileSystemsInput) GoString 

func (s DescribeFileSystemsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStorageVirtualMachinesInput added in v1.40.36 

type DescribeStorageVirtualMachinesInput struct {

	// Enter a filter name:value pair to view a select set of SVMs.
	Filters []*StorageVirtualMachineFilter `type:"list"`

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

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

	// Enter the ID of one or more SVMs that you want to view.
	StorageVirtualMachineIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeStorageVirtualMachinesInput) GoString added in v1.40.36 

func (s DescribeStorageVirtualMachinesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStorageVirtualMachinesInput) SetFilters added in v1.40.36 

func (s *DescribeStorageVirtualMachinesInput) SetFilters(v []*StorageVirtualMachineFilter) *DescribeStorageVirtualMachinesInput

SetFilters sets the Filters field's value.

func (*DescribeStorageVirtualMachinesInput) SetMaxResults added in v1.40.36 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeStorageVirtualMachinesInput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (*DescribeStorageVirtualMachinesInput) SetStorageVirtualMachineIds added in v1.40.36 

func (s *DescribeStorageVirtualMachinesInput) SetStorageVirtualMachineIds(v []*string) *DescribeStorageVirtualMachinesInput

SetStorageVirtualMachineIds sets the StorageVirtualMachineIds field's value.

func (DescribeStorageVirtualMachinesInput) String added in v1.40.36 

func (s DescribeStorageVirtualMachinesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStorageVirtualMachinesInput) Validate added in v1.40.36 

func (s *DescribeStorageVirtualMachinesInput) Validate() error

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

type DescribeStorageVirtualMachinesOutput added in v1.40.36 

type DescribeStorageVirtualMachinesOutput struct {

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

	// Returned after a successful DescribeStorageVirtualMachines operation, describing
	// each SVM.
	StorageVirtualMachines []*StorageVirtualMachine `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeStorageVirtualMachinesOutput) GoString added in v1.40.36 

func (s DescribeStorageVirtualMachinesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStorageVirtualMachinesOutput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (*DescribeStorageVirtualMachinesOutput) SetStorageVirtualMachines added in v1.40.36 

func (s *DescribeStorageVirtualMachinesOutput) SetStorageVirtualMachines(v []*StorageVirtualMachine) *DescribeStorageVirtualMachinesOutput

SetStorageVirtualMachines sets the StorageVirtualMachines field's value.

func (DescribeStorageVirtualMachinesOutput) String added in v1.40.36 

func (s DescribeStorageVirtualMachinesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeVolumesInput added in v1.40.36 

type DescribeVolumesInput struct {

	// Enter a filter name:value pair to view a select set of volumes.
	Filters []*VolumeFilter `type:"list"`

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

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

	// IDs of the volumes whose descriptions you want to retrieve.
	VolumeIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeVolumesInput) GoString added in v1.40.36 

func (s DescribeVolumesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVolumesInput) SetFilters added in v1.40.36 

func (s *DescribeVolumesInput) SetFilters(v []*VolumeFilter) *DescribeVolumesInput

SetFilters sets the Filters field's value.

func (*DescribeVolumesInput) SetMaxResults added in v1.40.36 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeVolumesInput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (*DescribeVolumesInput) SetVolumeIds added in v1.40.36 

func (s *DescribeVolumesInput) SetVolumeIds(v []*string) *DescribeVolumesInput

SetVolumeIds sets the VolumeIds field's value.

func (DescribeVolumesInput) String added in v1.40.36 

func (s DescribeVolumesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVolumesInput) Validate added in v1.40.36 

func (s *DescribeVolumesInput) Validate() error

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

type DescribeVolumesOutput added in v1.40.36 

type DescribeVolumesOutput struct {

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

	// Returned after a successful DescribeVolumes operation, describing each volume.
	Volumes []*Volume `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeVolumesOutput) GoString added in v1.40.36 

func (s DescribeVolumesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeVolumesOutput) SetNextToken added in v1.40.36 

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

SetNextToken sets the NextToken field's value.

func (*DescribeVolumesOutput) SetVolumes added in v1.40.36 

func (s *DescribeVolumesOutput) SetVolumes(v []*Volume) *DescribeVolumesOutput

SetVolumes sets the Volumes field's value.

func (DescribeVolumesOutput) String added in v1.40.36 

func (s DescribeVolumesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateFileSystemAliasesInput added in v1.35.24 

type DisassociateFileSystemAliasesInput struct {

	// An array of one or more DNS alias names to disassociate, or remove, from
	// the file system.
	//
	// Aliases is a required field
	Aliases []*string `type:"list" required:"true"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Specifies the file system from which to disassociate the DNS aliases.
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DisassociateFileSystemAliasesInput) GoString added in v1.35.24 

func (s DisassociateFileSystemAliasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFileSystemAliasesInput) SetAliases added in v1.35.24 

func (s *DisassociateFileSystemAliasesInput) SetAliases(v []*string) *DisassociateFileSystemAliasesInput

SetAliases sets the Aliases field's value.

func (*DisassociateFileSystemAliasesInput) SetClientRequestToken added in v1.35.24 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DisassociateFileSystemAliasesInput) SetFileSystemId added in v1.35.24 

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

SetFileSystemId sets the FileSystemId field's value.

func (DisassociateFileSystemAliasesInput) String added in v1.35.24 

func (s DisassociateFileSystemAliasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFileSystemAliasesInput) Validate added in v1.35.24 

func (s *DisassociateFileSystemAliasesInput) Validate() error

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

type DisassociateFileSystemAliasesOutput added in v1.35.24 

type DisassociateFileSystemAliasesOutput struct {

	// An array of one or more DNS aliases that Amazon FSx is attempting to disassociate
	// from the file system.
	Aliases []*Alias `type:"list"`
	// contains filtered or unexported fields
}

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

func (DisassociateFileSystemAliasesOutput) GoString added in v1.35.24 

func (s DisassociateFileSystemAliasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateFileSystemAliasesOutput) SetAliases added in v1.35.24 

func (s *DisassociateFileSystemAliasesOutput) SetAliases(v []*Alias) *DisassociateFileSystemAliasesOutput

SetAliases sets the Aliases field's value.

func (DisassociateFileSystemAliasesOutput) String added in v1.35.24 

func (s DisassociateFileSystemAliasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DiskIopsConfiguration added in v1.40.36 

type DiskIopsConfiguration struct {

	// The total number of SSD IOPS provisioned for the file system.
	Iops *int64 `type:"long"`

	// Specifies whether the number of IOPS for the file system is using the system
	// default (AUTOMATIC) or was provisioned by the customer (USER_PROVISIONED).
	Mode *string `type:"string" enum:"DiskIopsConfigurationMode"`
	// contains filtered or unexported fields
}

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).

func (DiskIopsConfiguration) GoString added in v1.40.36 

func (s DiskIopsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DiskIopsConfiguration) SetIops added in v1.40.36 

func (s *DiskIopsConfiguration) SetIops(v int64) *DiskIopsConfiguration

SetIops sets the Iops field's value.

func (*DiskIopsConfiguration) SetMode added in v1.40.36 

func (s *DiskIopsConfiguration) SetMode(v string) *DiskIopsConfiguration

SetMode sets the Mode field's value.

func (DiskIopsConfiguration) String added in v1.40.36 

func (s DiskIopsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) AssociateFileSystemAliases added in v1.35.24 

func (c *FSx) AssociateFileSystemAliases(input *AssociateFileSystemAliasesInput) (*AssociateFileSystemAliasesOutput, error)

AssociateFileSystemAliases API operation for Amazon FSx.

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

The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.

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 AssociateFileSystemAliases for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • InternalServerError A generic error indicating a server-side failure.

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

func (*FSx) AssociateFileSystemAliasesRequest added in v1.35.24 

func (c *FSx) AssociateFileSystemAliasesRequest(input *AssociateFileSystemAliasesInput) (req *request.Request, output *AssociateFileSystemAliasesOutput)

AssociateFileSystemAliasesRequest generates a "aws/request.Request" representing the client's request for the AssociateFileSystemAliases 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 AssociateFileSystemAliases for more information on using the AssociateFileSystemAliases 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 AssociateFileSystemAliasesRequest method.
req, resp := client.AssociateFileSystemAliasesRequest(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/AssociateFileSystemAliases

func (*FSx) AssociateFileSystemAliasesWithContext added in v1.35.24 

func (c *FSx) AssociateFileSystemAliasesWithContext(ctx aws.Context, input *AssociateFileSystemAliasesInput, opts ...request.Option) (*AssociateFileSystemAliasesOutput, error)

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

See AssociateFileSystemAliases 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) CancelDataRepositoryTask added in v1.26.8 

func (c *FSx) CancelDataRepositoryTask(input *CancelDataRepositoryTaskInput) (*CancelDataRepositoryTaskOutput, error)

CancelDataRepositoryTask API operation for Amazon FSx.

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

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

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

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

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 CancelDataRepositoryTask for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

  • DataRepositoryTaskNotFound The data repository task or tasks you specified could not be found.

  • DataRepositoryTaskEnded The data repository task could not be canceled because the task has already ended.

  • InternalServerError A generic error indicating a server-side failure.

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

func (*FSx) CancelDataRepositoryTaskRequest added in v1.26.8 

func (c *FSx) CancelDataRepositoryTaskRequest(input *CancelDataRepositoryTaskInput) (req *request.Request, output *CancelDataRepositoryTaskOutput)

CancelDataRepositoryTaskRequest generates a "aws/request.Request" representing the client's request for the CancelDataRepositoryTask 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 CancelDataRepositoryTask for more information on using the CancelDataRepositoryTask 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 CancelDataRepositoryTaskRequest method.
req, resp := client.CancelDataRepositoryTaskRequest(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/CancelDataRepositoryTask

func (*FSx) CancelDataRepositoryTaskWithContext added in v1.26.8 

func (c *FSx) CancelDataRepositoryTaskWithContext(ctx aws.Context, input *CancelDataRepositoryTaskInput, opts ...request.Option) (*CancelDataRepositoryTaskOutput, error)

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

See CancelDataRepositoryTask 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) CopyBackup added in v1.38.18 

func (c *FSx) CopyBackup(input *CopyBackupInput) (*CopyBackupOutput, error)

CopyBackup API operation for Amazon FSx.

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

You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition.

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

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

For more information on creating backup copies, see Copying backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups) in the Amazon FSx for Windows User Guide and Copying backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups) in the Amazon FSx for Lustre User Guide.

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 CopyBackup for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • BackupNotFound No Amazon FSx backups were found based upon the supplied parameters.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

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

  • InternalServerError A generic error indicating a server-side failure.

  • InvalidSourceKmsKey The Key Management Service (KMS) key of the source backup is invalid.

  • InvalidDestinationKmsKey The Key Management Service (KMS) key of the destination backup is invalid.

  • InvalidRegion The Region provided for Source Region is invalid or is in a different Amazon Web Services partition.

  • SourceBackupUnavailable The request was rejected because the lifecycle status of the source backup is not AVAILABLE.

  • IncompatibleRegionForMultiAZ Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.

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

Example (Shared00)

To copy a backup

This operation copies an Amazon FSx backup. 

package main

import (
	"fmt"

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

func main() {
	svc := fsx.New(session.New())
	input := &fsx.CopyBackupInput{
		SourceBackupId: aws.String("backup-03e3c82e0183b7b6b"),
		SourceRegion:   aws.String("us-east-2"),
	}

	result, err := svc.CopyBackup(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.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, 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.ErrCodeInvalidSourceKmsKey:
				fmt.Println(fsx.ErrCodeInvalidSourceKmsKey, aerr.Error())
			case fsx.ErrCodeInvalidDestinationKmsKey:
				fmt.Println(fsx.ErrCodeInvalidDestinationKmsKey, aerr.Error())
			case fsx.ErrCodeInvalidRegion:
				fmt.Println(fsx.ErrCodeInvalidRegion, aerr.Error())
			case fsx.ErrCodeSourceBackupUnavailable:
				fmt.Println(fsx.ErrCodeSourceBackupUnavailable, aerr.Error())
			case fsx.ErrCodeIncompatibleRegionForMultiAZ:
				fmt.Println(fsx.ErrCodeIncompatibleRegionForMultiAZ, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) CopyBackupRequest added in v1.38.18 

func (c *FSx) CopyBackupRequest(input *CopyBackupInput) (req *request.Request, output *CopyBackupOutput)

CopyBackupRequest generates a "aws/request.Request" representing the client's request for the CopyBackup 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 CopyBackup for more information on using the CopyBackup 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 CopyBackupRequest method.
req, resp := client.CopyBackupRequest(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/CopyBackup

func (*FSx) CopyBackupWithContext added in v1.38.18 

func (c *FSx) CopyBackupWithContext(ctx aws.Context, input *CopyBackupInput, opts ...request.Option) (*CopyBackupOutput, error)

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

See CopyBackup 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) 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 or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to restore a file system or volume from a backup if an issue arises with the original file system or volume.

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

  • a Persistent deployment type

  • is not linked to a data repository.

For more information about backups, see the following:

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

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

  • Returns the description of the backup.

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

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

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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • VolumeNotFound No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

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

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

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

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

package main

import (
	"fmt"

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

func main() {
	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.ErrCodeVolumeNotFound:
				fmt.Println(fsx.ErrCodeVolumeNotFound, aerr.Error())
			case fsx.ErrCodeBackupInProgress:
				fmt.Println(fsx.ErrCodeBackupInProgress, aerr.Error())
			case fsx.ErrCodeIncompatibleParameterError:
				fmt.Println(fsx.ErrCodeIncompatibleParameterError, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*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) CreateDataRepositoryTask added in v1.26.8 

func (c *FSx) CreateDataRepositoryTask(input *CreateDataRepositoryTaskInput) (*CreateDataRepositoryTaskOutput, error)

CreateDataRepositoryTask API operation for Amazon FSx.

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

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 CreateDataRepositoryTask for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

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

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • InternalServerError A generic error indicating a server-side failure.

  • DataRepositoryTaskExecuting An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.

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

func (*FSx) CreateDataRepositoryTaskRequest added in v1.26.8 

func (c *FSx) CreateDataRepositoryTaskRequest(input *CreateDataRepositoryTaskInput) (req *request.Request, output *CreateDataRepositoryTaskOutput)

CreateDataRepositoryTaskRequest generates a "aws/request.Request" representing the client's request for the CreateDataRepositoryTask 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 CreateDataRepositoryTask for more information on using the CreateDataRepositoryTask 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 CreateDataRepositoryTaskRequest method.
req, resp := client.CreateDataRepositoryTaskRequest(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/CreateDataRepositoryTask

func (*FSx) CreateDataRepositoryTaskWithContext added in v1.26.8 

func (c *FSx) CreateDataRepositoryTaskWithContext(ctx aws.Context, input *CreateDataRepositoryTaskInput, opts ...request.Option) (*CreateDataRepositoryTaskOutput, error)

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

See CreateDataRepositoryTask 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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • ActiveDirectoryError An Active Directory error.

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

  • InvalidImportPath The path provided for data repository import isn't valid.

  • InvalidExportPath The path provided for data repository export isn't valid.

  • InvalidNetworkSettings One or more network settings specified in the request are invalid.

  • InvalidPerUnitStorageThroughput An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • InternalServerError A generic error indicating a server-side failure.

  • MissingFileSystemConfiguration A 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 Amazon FSx for Windows File Server file system. 

package main

import (
	"fmt"

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

func main() {
	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/1111abcd-2222-3333-4444-55556666eeff"),
		SecurityGroupIds: []*string{
			aws.String("sg-edcd9784"),
		},
		StorageCapacity: aws.Int64(3200),
		StorageType:     aws.String("HDD"),
		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"),
			Aliases: []*string{
				aws.String("accounting.corp.example.com"),
			},
			AutomaticBackupRetentionDays:  aws.Int64(30),
			DailyAutomaticBackupStartTime: aws.String("05:00"),
			ThroughputCapacity:            aws.Int64(32),
			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.ErrCodeInvalidPerUnitStorageThroughput:
				fmt.Println(fsx.ErrCodeInvalidPerUnitStorageThroughput, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*FSx) CreateFileSystemFromBackup 

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

CreateFileSystemFromBackup API operation for Amazon FSx.

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

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

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

  • Returns the description of the file system.

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

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

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

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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • ActiveDirectoryError An Active Directory error.

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

  • InvalidNetworkSettings One or more network settings specified in the request are invalid.

  • InvalidPerUnitStorageThroughput An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • BackupNotFound No Amazon FSx backups were found based upon the supplied parameters.

  • InternalServerError A generic error indicating a server-side failure.

  • MissingFileSystemConfiguration A 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. 

package main

import (
	"fmt"

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

func main() {
	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.ErrCodeInvalidPerUnitStorageThroughput:
				fmt.Println(fsx.ErrCodeInvalidPerUnitStorageThroughput, aerr.Error())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			case fsx.ErrCodeMissingFileSystemConfiguration:
				fmt.Println(fsx.ErrCodeMissingFileSystemConfiguration, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*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) CreateStorageVirtualMachine added in v1.40.36 

func (c *FSx) CreateStorageVirtualMachine(input *CreateStorageVirtualMachineInput) (*CreateStorageVirtualMachineOutput, error)

CreateStorageVirtualMachine API operation for Amazon FSx.

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

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 CreateStorageVirtualMachine for usage and error information.

Returned Error Types:

  • ActiveDirectoryError An Active Directory error.

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

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

  • InternalServerError A generic error indicating a server-side failure.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

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

func (*FSx) CreateStorageVirtualMachineRequest added in v1.40.36 

func (c *FSx) CreateStorageVirtualMachineRequest(input *CreateStorageVirtualMachineInput) (req *request.Request, output *CreateStorageVirtualMachineOutput)

CreateStorageVirtualMachineRequest generates a "aws/request.Request" representing the client's request for the CreateStorageVirtualMachine 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 CreateStorageVirtualMachine for more information on using the CreateStorageVirtualMachine 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 CreateStorageVirtualMachineRequest method.
req, resp := client.CreateStorageVirtualMachineRequest(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/CreateStorageVirtualMachine

func (*FSx) CreateStorageVirtualMachineWithContext added in v1.40.36 

func (c *FSx) CreateStorageVirtualMachineWithContext(ctx aws.Context, input *CreateStorageVirtualMachineInput, opts ...request.Option) (*CreateStorageVirtualMachineOutput, error)

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

See CreateStorageVirtualMachine 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) CreateVolume added in v1.40.36 

func (c *FSx) CreateVolume(input *CreateVolumeInput) (*CreateVolumeOutput, error)

CreateVolume API operation for Amazon FSx.

Creates an Amazon FSx for NetApp ONTAP storage volume.

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 CreateVolume for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

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

  • InternalServerError A generic error indicating a server-side failure.

  • MissingVolumeConfiguration A volume configuration is required for this operation.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • StorageVirtualMachineNotFound No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

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

func (*FSx) CreateVolumeFromBackup added in v1.40.36 

func (c *FSx) CreateVolumeFromBackup(input *CreateVolumeFromBackupInput) (*CreateVolumeFromBackupOutput, error)

CreateVolumeFromBackup API operation for Amazon FSx.

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

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 CreateVolumeFromBackup for usage and error information.

Returned Error Types:

  • BackupNotFound No Amazon FSx backups were found based upon the supplied parameters.

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

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

  • InternalServerError A generic error indicating a server-side failure.

  • MissingVolumeConfiguration A volume configuration is required for this operation.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

  • StorageVirtualMachineNotFound No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

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

func (*FSx) CreateVolumeFromBackupRequest added in v1.40.36 

func (c *FSx) CreateVolumeFromBackupRequest(input *CreateVolumeFromBackupInput) (req *request.Request, output *CreateVolumeFromBackupOutput)

CreateVolumeFromBackupRequest generates a "aws/request.Request" representing the client's request for the CreateVolumeFromBackup 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 CreateVolumeFromBackup for more information on using the CreateVolumeFromBackup 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 CreateVolumeFromBackupRequest method.
req, resp := client.CreateVolumeFromBackupRequest(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/CreateVolumeFromBackup

func (*FSx) CreateVolumeFromBackupWithContext added in v1.40.36 

func (c *FSx) CreateVolumeFromBackupWithContext(ctx aws.Context, input *CreateVolumeFromBackupInput, opts ...request.Option) (*CreateVolumeFromBackupOutput, error)

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

See CreateVolumeFromBackup 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) CreateVolumeRequest added in v1.40.36 

func (c *FSx) CreateVolumeRequest(input *CreateVolumeInput) (req *request.Request, output *CreateVolumeOutput)

CreateVolumeRequest generates a "aws/request.Request" representing the client's request for the CreateVolume 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 CreateVolume for more information on using the CreateVolume 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 CreateVolumeRequest method.
req, resp := client.CreateVolumeRequest(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/CreateVolume

func (*FSx) CreateVolumeWithContext added in v1.40.36 

func (c *FSx) CreateVolumeWithContext(ctx aws.Context, input *CreateVolumeInput, opts ...request.Option) (*CreateVolumeOutput, error)

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

See CreateVolume 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 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 Types:

  • BadRequest A generic error indicating a failure with a client request.

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

  • BackupNotFound No Amazon FSx backups were found based upon the supplied parameters.

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

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

  • InternalServerError A generic error indicating a server-side failure.

  • BackupBeingCopied You can't delete a backup while it's being copied.

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. 

package main

import (
	"fmt"

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

func main() {
	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())
			case fsx.ErrCodeBackupBeingCopied:
				fmt.Println(fsx.ErrCodeBackupBeingCopied, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*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.

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system. Then provide a FileSystemId value to the DeleFileSystem operation.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.

The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.

Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.

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

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 Types:

  • BadRequest A generic error indicating a failure with a client request.

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

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

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

package main

import (
	"fmt"

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

func main() {
	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)
}

Output:

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) DeleteStorageVirtualMachine added in v1.40.36 

func (c *FSx) DeleteStorageVirtualMachine(input *DeleteStorageVirtualMachineInput) (*DeleteStorageVirtualMachineOutput, error)

DeleteStorageVirtualMachine API operation for Amazon FSx.

Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.

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 DeleteStorageVirtualMachine for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

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

  • InternalServerError A generic error indicating a server-side failure.

  • StorageVirtualMachineNotFound No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

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

func (*FSx) DeleteStorageVirtualMachineRequest added in v1.40.36 

func (c *FSx) DeleteStorageVirtualMachineRequest(input *DeleteStorageVirtualMachineInput) (req *request.Request, output *DeleteStorageVirtualMachineOutput)

DeleteStorageVirtualMachineRequest generates a "aws/request.Request" representing the client's request for the DeleteStorageVirtualMachine 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 DeleteStorageVirtualMachine for more information on using the DeleteStorageVirtualMachine 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 DeleteStorageVirtualMachineRequest method.
req, resp := client.DeleteStorageVirtualMachineRequest(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/DeleteStorageVirtualMachine

func (*FSx) DeleteStorageVirtualMachineWithContext added in v1.40.36 

func (c *FSx) DeleteStorageVirtualMachineWithContext(ctx aws.Context, input *DeleteStorageVirtualMachineInput, opts ...request.Option) (*DeleteStorageVirtualMachineOutput, error)

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

See DeleteStorageVirtualMachine 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) DeleteVolume added in v1.40.36 

func (c *FSx) DeleteVolume(input *DeleteVolumeInput) (*DeleteVolumeOutput, error)

DeleteVolume API operation for Amazon FSx.

Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, you have the option of creating a final backup. If you create a final backup, you have the option to apply Tags to the backup. You need to have fsx:TagResource permission in order to apply tags to the backup.

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 DeleteVolume for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

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

  • InternalServerError A generic error indicating a server-side failure.

  • VolumeNotFound No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

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

func (*FSx) DeleteVolumeRequest added in v1.40.36 

func (c *FSx) DeleteVolumeRequest(input *DeleteVolumeInput) (req *request.Request, output *DeleteVolumeOutput)

DeleteVolumeRequest generates a "aws/request.Request" representing the client's request for the DeleteVolume 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 DeleteVolume for more information on using the DeleteVolume 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 DeleteVolumeRequest method.
req, resp := client.DeleteVolumeRequest(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/DeleteVolume

func (*FSx) DeleteVolumeWithContext added in v1.40.36 

func (c *FSx) DeleteVolumeWithContext(ctx aws.Context, input *DeleteVolumeInput, opts ...request.Option) (*DeleteVolumeOutput, error)

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

See DeleteVolume 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 backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services 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 backup 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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • VolumeNotFound No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

  • BackupNotFound No Amazon FSx backups were found based upon the supplied parameters.

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

package main

import (
	"fmt"

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

func main() {
	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.ErrCodeVolumeNotFound:
				fmt.Println(fsx.ErrCodeVolumeNotFound, aerr.Error())
			case fsx.ErrCodeBackupNotFound:
				fmt.Println(fsx.ErrCodeBackupNotFound, aerr.Error())
			case fsx.ErrCodeInternalServerError:
				fmt.Println(fsx.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*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) DescribeDataRepositoryTasks added in v1.26.8 

func (c *FSx) DescribeDataRepositoryTasks(input *DescribeDataRepositoryTasksInput) (*DescribeDataRepositoryTasksOutput, error)

DescribeDataRepositoryTasks API operation for Amazon FSx.

Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

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 DescribeDataRepositoryTasks for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • DataRepositoryTaskNotFound The data repository task or tasks you specified could not be found.

  • InternalServerError A generic error indicating a server-side failure.

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

func (*FSx) DescribeDataRepositoryTasksPages added in v1.26.8 

func (c *FSx) DescribeDataRepositoryTasksPages(input *DescribeDataRepositoryTasksInput, fn func(*DescribeDataRepositoryTasksOutput, bool) bool) error

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

See DescribeDataRepositoryTasks 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 DescribeDataRepositoryTasks operation.
pageNum := 0
err := client.DescribeDataRepositoryTasksPages(params,
    func(page *fsx.DescribeDataRepositoryTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeDataRepositoryTasksPagesWithContext added in v1.26.8 

func (c *FSx) DescribeDataRepositoryTasksPagesWithContext(ctx aws.Context, input *DescribeDataRepositoryTasksInput, fn func(*DescribeDataRepositoryTasksOutput, bool) bool, opts ...request.Option) error

DescribeDataRepositoryTasksPagesWithContext same as DescribeDataRepositoryTasksPages 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) DescribeDataRepositoryTasksRequest added in v1.26.8 

func (c *FSx) DescribeDataRepositoryTasksRequest(input *DescribeDataRepositoryTasksInput) (req *request.Request, output *DescribeDataRepositoryTasksOutput)

DescribeDataRepositoryTasksRequest generates a "aws/request.Request" representing the client's request for the DescribeDataRepositoryTasks 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 DescribeDataRepositoryTasks for more information on using the DescribeDataRepositoryTasks 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 DescribeDataRepositoryTasksRequest method.
req, resp := client.DescribeDataRepositoryTasksRequest(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/DescribeDataRepositoryTasks

func (*FSx) DescribeDataRepositoryTasksWithContext added in v1.26.8 

func (c *FSx) DescribeDataRepositoryTasksWithContext(ctx aws.Context, input *DescribeDataRepositoryTasksInput, opts ...request.Option) (*DescribeDataRepositoryTasksOutput, error)

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

See DescribeDataRepositoryTasks 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) DescribeFileSystemAliases added in v1.35.24 

func (c *FSx) DescribeFileSystemAliases(input *DescribeFileSystemAliasesInput) (*DescribeFileSystemAliasesOutput, error)

DescribeFileSystemAliases API operation for Amazon FSx.

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

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 DescribeFileSystemAliases for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • InternalServerError A generic error indicating a server-side failure.

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

func (*FSx) DescribeFileSystemAliasesPages added in v1.35.24 

func (c *FSx) DescribeFileSystemAliasesPages(input *DescribeFileSystemAliasesInput, fn func(*DescribeFileSystemAliasesOutput, bool) bool) error

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

See DescribeFileSystemAliases 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 DescribeFileSystemAliases operation.
pageNum := 0
err := client.DescribeFileSystemAliasesPages(params,
    func(page *fsx.DescribeFileSystemAliasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeFileSystemAliasesPagesWithContext added in v1.35.24 

func (c *FSx) DescribeFileSystemAliasesPagesWithContext(ctx aws.Context, input *DescribeFileSystemAliasesInput, fn func(*DescribeFileSystemAliasesOutput, bool) bool, opts ...request.Option) error

DescribeFileSystemAliasesPagesWithContext same as DescribeFileSystemAliasesPages 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) DescribeFileSystemAliasesRequest added in v1.35.24 

func (c *FSx) DescribeFileSystemAliasesRequest(input *DescribeFileSystemAliasesInput) (req *request.Request, output *DescribeFileSystemAliasesOutput)

DescribeFileSystemAliasesRequest generates a "aws/request.Request" representing the client's request for the DescribeFileSystemAliases 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 DescribeFileSystemAliases for more information on using the DescribeFileSystemAliases 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 DescribeFileSystemAliasesRequest method.
req, resp := client.DescribeFileSystemAliasesRequest(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/DescribeFileSystemAliases

func (*FSx) DescribeFileSystemAliasesWithContext added in v1.35.24 

func (c *FSx) DescribeFileSystemAliasesWithContext(ctx aws.Context, input *DescribeFileSystemAliasesInput, opts ...request.Option) (*DescribeFileSystemAliasesOutput, error)

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

See DescribeFileSystemAliases 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 Amazon Web Services account in the Amazon Web Services 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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

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

package main

import (
	"fmt"

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

func main() {
	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)
}

Output:

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) DescribeStorageVirtualMachines added in v1.40.36 

func (c *FSx) DescribeStorageVirtualMachines(input *DescribeStorageVirtualMachinesInput) (*DescribeStorageVirtualMachinesOutput, error)

DescribeStorageVirtualMachines API operation for Amazon FSx.

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

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 DescribeStorageVirtualMachines for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • InternalServerError A generic error indicating a server-side failure.

  • StorageVirtualMachineNotFound No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

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

func (*FSx) DescribeStorageVirtualMachinesPages added in v1.40.36 

func (c *FSx) DescribeStorageVirtualMachinesPages(input *DescribeStorageVirtualMachinesInput, fn func(*DescribeStorageVirtualMachinesOutput, bool) bool) error

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

See DescribeStorageVirtualMachines 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 DescribeStorageVirtualMachines operation.
pageNum := 0
err := client.DescribeStorageVirtualMachinesPages(params,
    func(page *fsx.DescribeStorageVirtualMachinesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeStorageVirtualMachinesPagesWithContext added in v1.40.36 

func (c *FSx) DescribeStorageVirtualMachinesPagesWithContext(ctx aws.Context, input *DescribeStorageVirtualMachinesInput, fn func(*DescribeStorageVirtualMachinesOutput, bool) bool, opts ...request.Option) error

DescribeStorageVirtualMachinesPagesWithContext same as DescribeStorageVirtualMachinesPages 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) DescribeStorageVirtualMachinesRequest added in v1.40.36 

func (c *FSx) DescribeStorageVirtualMachinesRequest(input *DescribeStorageVirtualMachinesInput) (req *request.Request, output *DescribeStorageVirtualMachinesOutput)

DescribeStorageVirtualMachinesRequest generates a "aws/request.Request" representing the client's request for the DescribeStorageVirtualMachines 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 DescribeStorageVirtualMachines for more information on using the DescribeStorageVirtualMachines 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 DescribeStorageVirtualMachinesRequest method.
req, resp := client.DescribeStorageVirtualMachinesRequest(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/DescribeStorageVirtualMachines

func (*FSx) DescribeStorageVirtualMachinesWithContext added in v1.40.36 

func (c *FSx) DescribeStorageVirtualMachinesWithContext(ctx aws.Context, input *DescribeStorageVirtualMachinesInput, opts ...request.Option) (*DescribeStorageVirtualMachinesOutput, error)

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

See DescribeStorageVirtualMachines 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) DescribeVolumes added in v1.40.36 

func (c *FSx) DescribeVolumes(input *DescribeVolumesInput) (*DescribeVolumesOutput, error)

DescribeVolumes API operation for Amazon FSx.

Describes one or more Amazon FSx for NetApp ONTAP volumes.

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 DescribeVolumes for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • InternalServerError A generic error indicating a server-side failure.

  • VolumeNotFound No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

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

func (*FSx) DescribeVolumesPages added in v1.40.36 

func (c *FSx) DescribeVolumesPages(input *DescribeVolumesInput, fn func(*DescribeVolumesOutput, bool) bool) error

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

See DescribeVolumes 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 DescribeVolumes operation.
pageNum := 0
err := client.DescribeVolumesPages(params,
    func(page *fsx.DescribeVolumesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeVolumesPagesWithContext added in v1.40.36 

func (c *FSx) DescribeVolumesPagesWithContext(ctx aws.Context, input *DescribeVolumesInput, fn func(*DescribeVolumesOutput, bool) bool, opts ...request.Option) error

DescribeVolumesPagesWithContext same as DescribeVolumesPages 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) DescribeVolumesRequest added in v1.40.36 

func (c *FSx) DescribeVolumesRequest(input *DescribeVolumesInput) (req *request.Request, output *DescribeVolumesOutput)

DescribeVolumesRequest generates a "aws/request.Request" representing the client's request for the DescribeVolumes 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 DescribeVolumes for more information on using the DescribeVolumes 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 DescribeVolumesRequest method.
req, resp := client.DescribeVolumesRequest(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/DescribeVolumes

func (*FSx) DescribeVolumesWithContext added in v1.40.36 

func (c *FSx) DescribeVolumesWithContext(ctx aws.Context, input *DescribeVolumesInput, opts ...request.Option) (*DescribeVolumesOutput, error)

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

See DescribeVolumes 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) DisassociateFileSystemAliases added in v1.35.24 

func (c *FSx) DisassociateFileSystemAliases(input *DisassociateFileSystemAliasesInput) (*DisassociateFileSystemAliasesOutput, error)

DisassociateFileSystemAliases API operation for Amazon FSx.

Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html).

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

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 DisassociateFileSystemAliases for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • InternalServerError A generic error indicating a server-side failure.

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

func (*FSx) DisassociateFileSystemAliasesRequest added in v1.35.24 

func (c *FSx) DisassociateFileSystemAliasesRequest(input *DisassociateFileSystemAliasesInput) (req *request.Request, output *DisassociateFileSystemAliasesOutput)

DisassociateFileSystemAliasesRequest generates a "aws/request.Request" representing the client's request for the DisassociateFileSystemAliases 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 DisassociateFileSystemAliases for more information on using the DisassociateFileSystemAliases 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 DisassociateFileSystemAliasesRequest method.
req, resp := client.DisassociateFileSystemAliasesRequest(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/DisassociateFileSystemAliases

func (*FSx) DisassociateFileSystemAliasesWithContext added in v1.35.24 

func (c *FSx) DisassociateFileSystemAliasesWithContext(ctx aws.Context, input *DisassociateFileSystemAliasesInput, opts ...request.Option) (*DisassociateFileSystemAliasesOutput, error)

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

See DisassociateFileSystemAliases 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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • InternalServerError A generic error indicating a server-side failure.

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

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

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

package main

import (
	"fmt"

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

func main() {
	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)
}

Output:

func (*FSx) ListTagsForResourcePages added in v1.40.36 

func (c *FSx) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

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

See ListTagsForResource 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 ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *fsx.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) ListTagsForResourcePagesWithContext added in v1.40.36 

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

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages 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) 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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • InternalServerError A generic error indicating a server-side failure.

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

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

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

package main

import (
	"fmt"

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

func main() {
	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)
}

Output:

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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • InternalServerError A generic error indicating a server-side failure.

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

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

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

package main

import (
	"fmt"

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

func main() {
	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)
}

Output:

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.

Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.

For Amazon FSx for Windows File Server file systems, you can update the following properties:

  • AuditLogConfiguration

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • SelfManagedActiveDirectoryConfiguration

  • StorageCapacity

  • ThroughputCapacity

  • WeeklyMaintenanceStartTime

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

  • AutoImportPolicy

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DataCompressionType

  • StorageCapacity

  • WeeklyMaintenanceStartTime

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

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • FsxAdminPassword

  • WeeklyMaintenanceStartTime

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 Types:

  • BadRequest A generic error indicating a failure with a client request.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

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

  • InternalServerError A generic error indicating a server-side failure.

  • FileSystemNotFound No Amazon FSx file systems were found based upon supplied parameters.

  • MissingFileSystemConfiguration A file system configuration is required for this operation.

  • ServiceLimitExceeded An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

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. 

package main

import (
	"fmt"

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

func main() {
	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())
			case fsx.ErrCodeServiceLimitExceeded:
				fmt.Println(fsx.ErrCodeServiceLimitExceeded, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

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.

func (*FSx) UpdateStorageVirtualMachine added in v1.40.36 

func (c *FSx) UpdateStorageVirtualMachine(input *UpdateStorageVirtualMachineInput) (*UpdateStorageVirtualMachineOutput, error)

UpdateStorageVirtualMachine API operation for Amazon FSx.

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

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 UpdateStorageVirtualMachine for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

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

  • InternalServerError A generic error indicating a server-side failure.

  • StorageVirtualMachineNotFound No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

  • UnsupportedOperation The requested operation is not supported for this resource or API.

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

func (*FSx) UpdateStorageVirtualMachineRequest added in v1.40.36 

func (c *FSx) UpdateStorageVirtualMachineRequest(input *UpdateStorageVirtualMachineInput) (req *request.Request, output *UpdateStorageVirtualMachineOutput)

UpdateStorageVirtualMachineRequest generates a "aws/request.Request" representing the client's request for the UpdateStorageVirtualMachine 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 UpdateStorageVirtualMachine for more information on using the UpdateStorageVirtualMachine 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 UpdateStorageVirtualMachineRequest method.
req, resp := client.UpdateStorageVirtualMachineRequest(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/UpdateStorageVirtualMachine

func (*FSx) UpdateStorageVirtualMachineWithContext added in v1.40.36 

func (c *FSx) UpdateStorageVirtualMachineWithContext(ctx aws.Context, input *UpdateStorageVirtualMachineInput, opts ...request.Option) (*UpdateStorageVirtualMachineOutput, error)

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

See UpdateStorageVirtualMachine 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) UpdateVolume added in v1.40.36 

func (c *FSx) UpdateVolume(input *UpdateVolumeInput) (*UpdateVolumeOutput, error)

UpdateVolume API operation for Amazon FSx.

Updates an Amazon FSx for NetApp ONTAP volume's 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 UpdateVolume for usage and error information.

Returned Error Types:

  • BadRequest A generic error indicating a failure with a client request.

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

  • InternalServerError A generic error indicating a server-side failure.

  • MissingVolumeConfiguration A volume configuration is required for this operation.

  • VolumeNotFound No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

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

func (*FSx) UpdateVolumeRequest added in v1.40.36 

func (c *FSx) UpdateVolumeRequest(input *UpdateVolumeInput) (req *request.Request, output *UpdateVolumeOutput)

UpdateVolumeRequest generates a "aws/request.Request" representing the client's request for the UpdateVolume 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 UpdateVolume for more information on using the UpdateVolume 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 UpdateVolumeRequest method.
req, resp := client.UpdateVolumeRequest(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/UpdateVolume

func (*FSx) UpdateVolumeWithContext added in v1.40.36 

func (c *FSx) UpdateVolumeWithContext(ctx aws.Context, input *UpdateVolumeInput, opts ...request.Option) (*UpdateVolumeOutput, error)

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

See UpdateVolume 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 {

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

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

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

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

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

	// The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, or ONTAP.
	FileSystemType *string `type:"string" enum:"FileSystemType"`

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

	// The lifecycle status of the file system, following are the possible values
	// and what they mean:
	//
	//    * AVAILABLE - The file system is in a healthy state, and is reachable
	//    and available for use.
	//
	//    * CREATING - Amazon FSx is creating the new file system.
	//
	//    * DELETING - Amazon FSx is deleting an existing file system.
	//
	//    * FAILED - An existing file system has experienced an unrecoverable failure.
	//    When creating a new file system, Amazon FSx was unable to create the file
	//    system.
	//
	//    * MISCONFIGURED indicates that the file system is in a failed but recoverable
	//    state.
	//
	//    * UPDATING indicates that the file system is undergoing a customer initiated
	//    update.
	Lifecycle *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 configuration for this FSx for NetApp ONTAP file system.
	OntapConfiguration *OntapFileSystemConfiguration `type:"structure"`

	// The Amazon Web Services account that created the file system. If the file
	// system was created by an Identity and Access Management (IAM) user, the Amazon
	// Web Services 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 gibibytes (GiB).
	StorageCapacity *int64 `type:"integer"`

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

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

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

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

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

A description of a specific Amazon FSx file system.

func (FileSystem) GoString 

func (s FileSystem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystem) SetAdministrativeActions added in v1.31.8 

func (s *FileSystem) SetAdministrativeActions(v []*AdministrativeAction) *FileSystem

SetAdministrativeActions sets the AdministrativeActions field's value.

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) SetOntapConfiguration added in v1.40.36 

func (s *FileSystem) SetOntapConfiguration(v *OntapFileSystemConfiguration) *FileSystem

SetOntapConfiguration sets the OntapConfiguration 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) SetStorageType added in v1.29.33 

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

SetStorageType sets the StorageType 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemEndpoint added in v1.40.36 

type FileSystemEndpoint struct {

	// The Domain Name Service (DNS) name for the file system. You can mount your
	// file system using its DNS name.
	DNSName *string `min:"16" type:"string"`

	// IP addresses of the file system endpoint.
	IpAddresses []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

An Amazon FSx for NetApp ONTAP file system has two endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. They are the Management and Intercluster endpoints.

func (FileSystemEndpoint) GoString added in v1.40.36 

func (s FileSystemEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemEndpoint) SetDNSName added in v1.40.36 

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

SetDNSName sets the DNSName field's value.

func (*FileSystemEndpoint) SetIpAddresses added in v1.40.36 

func (s *FileSystemEndpoint) SetIpAddresses(v []*string) *FileSystemEndpoint

SetIpAddresses sets the IpAddresses field's value.

func (FileSystemEndpoint) String added in v1.40.36 

func (s FileSystemEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemEndpoints added in v1.40.36 

type FileSystemEndpoints struct {

	// An endpoint for managing your file system by setting up NetApp SnapMirror
	// with other ONTAP systems.
	Intercluster *FileSystemEndpoint `type:"structure"`

	// An endpoint for managing your file system using the NetApp ONTAP CLI and
	// NetApp ONTAP API.
	Management *FileSystemEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

An Amazon FSx for NetApp ONTAP file system has the following endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

func (FileSystemEndpoints) GoString added in v1.40.36 

func (s FileSystemEndpoints) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemEndpoints) SetIntercluster added in v1.40.36 

func (s *FileSystemEndpoints) SetIntercluster(v *FileSystemEndpoint) *FileSystemEndpoints

SetIntercluster sets the Intercluster field's value.

func (*FileSystemEndpoints) SetManagement added in v1.40.36 

func (s *FileSystemEndpoints) SetManagement(v *FileSystemEndpoint) *FileSystemEndpoints

SetManagement sets the Management field's value.

func (FileSystemEndpoints) String added in v1.40.36 

func (s FileSystemEndpoints) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FileSystemNotFound added in v1.28.0 

type FileSystemNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

No Amazon FSx file systems were found based upon supplied parameters.

func (*FileSystemNotFound) Code added in v1.28.0 

func (s *FileSystemNotFound) Code() string

Code returns the exception type name.

func (*FileSystemNotFound) Error added in v1.28.0 

func (s *FileSystemNotFound) Error() string

func (FileSystemNotFound) GoString added in v1.28.0 

func (s FileSystemNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileSystemNotFound) Message added in v1.28.0 

func (s *FileSystemNotFound) Message() string

Message returns the exception's message.

func (*FileSystemNotFound) OrigErr added in v1.28.0 

func (s *FileSystemNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FileSystemNotFound) RequestID added in v1.28.0 

func (s *FileSystemNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FileSystemNotFound) StatusCode added in v1.28.0 

func (s *FileSystemNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FileSystemNotFound) String added in v1.28.0 

func (s FileSystemNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncompatibleParameterError added in v1.28.0 

type IncompatibleParameterError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A detailed error message.
	Message_ *string `locationName:"Message" min:"1" type:"string"`

	// A parameter that is incompatible with the earlier request.
	//
	// Parameter is a required field
	Parameter *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (*IncompatibleParameterError) Code added in v1.28.0 

func (s *IncompatibleParameterError) Code() string

Code returns the exception type name.

func (*IncompatibleParameterError) Error added in v1.28.0 

func (s *IncompatibleParameterError) Error() string

func (IncompatibleParameterError) GoString added in v1.28.0 

func (s IncompatibleParameterError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncompatibleParameterError) Message added in v1.28.0 

func (s *IncompatibleParameterError) Message() string

Message returns the exception's message.

func (*IncompatibleParameterError) OrigErr added in v1.28.0 

func (s *IncompatibleParameterError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncompatibleParameterError) RequestID added in v1.28.0 

func (s *IncompatibleParameterError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncompatibleParameterError) StatusCode added in v1.28.0 

func (s *IncompatibleParameterError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncompatibleParameterError) String added in v1.28.0 

func (s IncompatibleParameterError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncompatibleRegionForMultiAZ added in v1.38.18 

type IncompatibleRegionForMultiAZ struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the destination Region, so the copied backup can't be restored.

func (*IncompatibleRegionForMultiAZ) Code added in v1.38.18 

func (s *IncompatibleRegionForMultiAZ) Code() string

Code returns the exception type name.

func (*IncompatibleRegionForMultiAZ) Error added in v1.38.18 

func (s *IncompatibleRegionForMultiAZ) Error() string

func (IncompatibleRegionForMultiAZ) GoString added in v1.38.18 

func (s IncompatibleRegionForMultiAZ) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncompatibleRegionForMultiAZ) Message added in v1.38.18 

func (s *IncompatibleRegionForMultiAZ) Message() string

Message returns the exception's message.

func (*IncompatibleRegionForMultiAZ) OrigErr added in v1.38.18 

func (s *IncompatibleRegionForMultiAZ) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncompatibleRegionForMultiAZ) RequestID added in v1.38.18 

func (s *IncompatibleRegionForMultiAZ) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncompatibleRegionForMultiAZ) StatusCode added in v1.38.18 

func (s *IncompatibleRegionForMultiAZ) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncompatibleRegionForMultiAZ) String added in v1.38.18 

func (s IncompatibleRegionForMultiAZ) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError added in v1.28.0 

type InternalServerError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

A generic error indicating a server-side failure.

func (*InternalServerError) Code added in v1.28.0 

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error added in v1.28.0 

func (s *InternalServerError) Error() string

func (InternalServerError) GoString added in v1.28.0 

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message added in v1.28.0 

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr added in v1.28.0 

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID added in v1.28.0 

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode added in v1.28.0 

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String added in v1.28.0 

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidDestinationKmsKey added in v1.38.18 

type InvalidDestinationKmsKey struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The Key Management Service (KMS) key of the destination backup is invalid.

func (*InvalidDestinationKmsKey) Code added in v1.38.18 

func (s *InvalidDestinationKmsKey) Code() string

Code returns the exception type name.

func (*InvalidDestinationKmsKey) Error added in v1.38.18 

func (s *InvalidDestinationKmsKey) Error() string

func (InvalidDestinationKmsKey) GoString added in v1.38.18 

func (s InvalidDestinationKmsKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidDestinationKmsKey) Message added in v1.38.18 

func (s *InvalidDestinationKmsKey) Message() string

Message returns the exception's message.

func (*InvalidDestinationKmsKey) OrigErr added in v1.38.18 

func (s *InvalidDestinationKmsKey) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidDestinationKmsKey) RequestID added in v1.38.18 

func (s *InvalidDestinationKmsKey) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidDestinationKmsKey) StatusCode added in v1.38.18 

func (s *InvalidDestinationKmsKey) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidDestinationKmsKey) String added in v1.38.18 

func (s InvalidDestinationKmsKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidExportPath added in v1.28.0 

type InvalidExportPath struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The path provided for data repository export isn't valid.

func (*InvalidExportPath) Code added in v1.28.0 

func (s *InvalidExportPath) Code() string

Code returns the exception type name.

func (*InvalidExportPath) Error added in v1.28.0 

func (s *InvalidExportPath) Error() string

func (InvalidExportPath) GoString added in v1.28.0 

func (s InvalidExportPath) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidExportPath) Message added in v1.28.0 

func (s *InvalidExportPath) Message() string

Message returns the exception's message.

func (*InvalidExportPath) OrigErr added in v1.28.0 

func (s *InvalidExportPath) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidExportPath) RequestID added in v1.28.0 

func (s *InvalidExportPath) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidExportPath) StatusCode added in v1.28.0 

func (s *InvalidExportPath) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidExportPath) String added in v1.28.0 

func (s InvalidExportPath) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidImportPath added in v1.28.0 

type InvalidImportPath struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The path provided for data repository import isn't valid.

func (*InvalidImportPath) Code added in v1.28.0 

func (s *InvalidImportPath) Code() string

Code returns the exception type name.

func (*InvalidImportPath) Error added in v1.28.0 

func (s *InvalidImportPath) Error() string

func (InvalidImportPath) GoString added in v1.28.0 

func (s InvalidImportPath) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidImportPath) Message added in v1.28.0 

func (s *InvalidImportPath) Message() string

Message returns the exception's message.

func (*InvalidImportPath) OrigErr added in v1.28.0 

func (s *InvalidImportPath) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidImportPath) RequestID added in v1.28.0 

func (s *InvalidImportPath) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidImportPath) StatusCode added in v1.28.0 

func (s *InvalidImportPath) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidImportPath) String added in v1.28.0 

func (s InvalidImportPath) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidNetworkSettings added in v1.28.0 

type InvalidNetworkSettings struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The route table ID is either invalid or not part of the VPC specified.
	InvalidRouteTableId *string `min:"12" type:"string"`

	// The security group ID is either invalid or not part of the VPC specified.
	InvalidSecurityGroupId *string `min:"11" type:"string"`

	// The subnet ID that is either invalid or not part of the VPC specified.
	InvalidSubnetId *string `min:"15" type:"string"`

	// Error message explaining what's wrong with network settings.
	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

One or more network settings specified in the request are invalid.

func (*InvalidNetworkSettings) Code added in v1.28.0 

func (s *InvalidNetworkSettings) Code() string

Code returns the exception type name.

func (*InvalidNetworkSettings) Error added in v1.28.0 

func (s *InvalidNetworkSettings) Error() string

func (InvalidNetworkSettings) GoString added in v1.28.0 

func (s InvalidNetworkSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidNetworkSettings) Message added in v1.28.0 

func (s *InvalidNetworkSettings) Message() string

Message returns the exception's message.

func (*InvalidNetworkSettings) OrigErr added in v1.28.0 

func (s *InvalidNetworkSettings) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNetworkSettings) RequestID added in v1.28.0 

func (s *InvalidNetworkSettings) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNetworkSettings) StatusCode added in v1.28.0 

func (s *InvalidNetworkSettings) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidNetworkSettings) String added in v1.28.0 

func (s InvalidNetworkSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidPerUnitStorageThroughput added in v1.29.9 

type InvalidPerUnitStorageThroughput struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

func (*InvalidPerUnitStorageThroughput) Code added in v1.29.9 

func (s *InvalidPerUnitStorageThroughput) Code() string

Code returns the exception type name.

func (*InvalidPerUnitStorageThroughput) Error added in v1.29.9 

func (s *InvalidPerUnitStorageThroughput) Error() string

func (InvalidPerUnitStorageThroughput) GoString added in v1.29.9 

func (s InvalidPerUnitStorageThroughput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidPerUnitStorageThroughput) Message added in v1.29.9 

func (s *InvalidPerUnitStorageThroughput) Message() string

Message returns the exception's message.

func (*InvalidPerUnitStorageThroughput) OrigErr added in v1.29.9 

func (s *InvalidPerUnitStorageThroughput) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidPerUnitStorageThroughput) RequestID added in v1.29.9 

func (s *InvalidPerUnitStorageThroughput) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidPerUnitStorageThroughput) StatusCode added in v1.29.9 

func (s *InvalidPerUnitStorageThroughput) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidPerUnitStorageThroughput) String added in v1.29.9 

func (s InvalidPerUnitStorageThroughput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRegion added in v1.38.18 

type InvalidRegion struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The Region provided for Source Region is invalid or is in a different Amazon Web Services partition.

func (*InvalidRegion) Code added in v1.38.18 

func (s *InvalidRegion) Code() string

Code returns the exception type name.

func (*InvalidRegion) Error added in v1.38.18 

func (s *InvalidRegion) Error() string

func (InvalidRegion) GoString added in v1.38.18 

func (s InvalidRegion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRegion) Message added in v1.38.18 

func (s *InvalidRegion) Message() string

Message returns the exception's message.

func (*InvalidRegion) OrigErr added in v1.38.18 

func (s *InvalidRegion) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRegion) RequestID added in v1.38.18 

func (s *InvalidRegion) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRegion) StatusCode added in v1.38.18 

func (s *InvalidRegion) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRegion) String added in v1.38.18 

func (s InvalidRegion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidSourceKmsKey added in v1.38.18 

type InvalidSourceKmsKey struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The Key Management Service (KMS) key of the source backup is invalid.

func (*InvalidSourceKmsKey) Code added in v1.38.18 

func (s *InvalidSourceKmsKey) Code() string

Code returns the exception type name.

func (*InvalidSourceKmsKey) Error added in v1.38.18 

func (s *InvalidSourceKmsKey) Error() string

func (InvalidSourceKmsKey) GoString added in v1.38.18 

func (s InvalidSourceKmsKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidSourceKmsKey) Message added in v1.38.18 

func (s *InvalidSourceKmsKey) Message() string

Message returns the exception's message.

func (*InvalidSourceKmsKey) OrigErr added in v1.38.18 

func (s *InvalidSourceKmsKey) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidSourceKmsKey) RequestID added in v1.38.18 

func (s *InvalidSourceKmsKey) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidSourceKmsKey) StatusCode added in v1.38.18 

func (s *InvalidSourceKmsKey) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidSourceKmsKey) String added in v1.38.18 

func (s InvalidSourceKmsKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LifecycleTransitionReason added in v1.40.36 

type LifecycleTransitionReason struct {

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

Describes why a resource lifecycle state changed.

func (LifecycleTransitionReason) GoString added in v1.40.36 

func (s LifecycleTransitionReason) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LifecycleTransitionReason) SetMessage added in v1.40.36 

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

SetMessage sets the Message field's value.

func (LifecycleTransitionReason) String added in v1.40.36 

func (s LifecycleTransitionReason) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

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

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

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

The request object for ListTagsForResource operation.

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LustreFileSystemConfiguration 

type LustreFileSystemConfiguration struct {

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

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

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

	// The data compression configuration for the file system. DataCompressionType
	// can have the following values:
	//
	//    * NONE - Data compression is turned off for the file system.
	//
	//    * LZ4 - Data compression is turned on with the LZ4 algorithm.
	//
	// For more information, see Lustre data compression (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html).
	DataCompressionType *string `type:"string" enum:"DataCompressionType"`

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

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

	// The type of drive cache used by PERSISTENT_1 file systems that are provisioned
	// with HDD storage devices. This parameter is required when storage type is
	// HDD. Set to READ, improve the performance for frequently accessed files and
	// allows 20% of the total storage capacity of the file system to be cached.
	//
	// This parameter is required when StorageType is set to HDD.
	DriveCacheType *string `type:"string" enum:"DriveCacheType"`

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

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

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

The configuration for the Amazon FSx for Lustre file system.

func (LustreFileSystemConfiguration) GoString 

func (s LustreFileSystemConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LustreFileSystemConfiguration) SetAutomaticBackupRetentionDays added in v1.32.9 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*LustreFileSystemConfiguration) SetCopyTagsToBackups added in v1.32.9 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*LustreFileSystemConfiguration) SetDailyAutomaticBackupStartTime added in v1.32.9 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*LustreFileSystemConfiguration) SetDataCompressionType added in v1.38.50 

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

SetDataCompressionType sets the DataCompressionType field's value.

func (*LustreFileSystemConfiguration) SetDataRepositoryConfiguration 

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

SetDataRepositoryConfiguration sets the DataRepositoryConfiguration field's value.

func (*LustreFileSystemConfiguration) SetDeploymentType added in v1.29.9 

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

SetDeploymentType sets the DeploymentType field's value.

func (*LustreFileSystemConfiguration) SetDriveCacheType added in v1.34.3 

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

SetDriveCacheType sets the DriveCacheType field's value.

func (*LustreFileSystemConfiguration) SetMountName added in v1.29.9 

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

SetMountName sets the MountName field's value.

func (*LustreFileSystemConfiguration) SetPerUnitStorageThroughput added in v1.29.9 

func (s *LustreFileSystemConfiguration) SetPerUnitStorageThroughput(v int64) *LustreFileSystemConfiguration

SetPerUnitStorageThroughput sets the PerUnitStorageThroughput 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MissingFileSystemConfiguration added in v1.28.0 

type MissingFileSystemConfiguration struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

A file system configuration is required for this operation.

func (*MissingFileSystemConfiguration) Code added in v1.28.0 

func (s *MissingFileSystemConfiguration) Code() string

Code returns the exception type name.

func (*MissingFileSystemConfiguration) Error added in v1.28.0 

func (s *MissingFileSystemConfiguration) Error() string

func (MissingFileSystemConfiguration) GoString added in v1.28.0 

func (s MissingFileSystemConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MissingFileSystemConfiguration) Message added in v1.28.0 

func (s *MissingFileSystemConfiguration) Message() string

Message returns the exception's message.

func (*MissingFileSystemConfiguration) OrigErr added in v1.28.0 

func (s *MissingFileSystemConfiguration) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingFileSystemConfiguration) RequestID added in v1.28.0 

func (s *MissingFileSystemConfiguration) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingFileSystemConfiguration) StatusCode added in v1.28.0 

func (s *MissingFileSystemConfiguration) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MissingFileSystemConfiguration) String added in v1.28.0 

func (s MissingFileSystemConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MissingVolumeConfiguration added in v1.40.36 

type MissingVolumeConfiguration struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

A volume configuration is required for this operation.

func (*MissingVolumeConfiguration) Code added in v1.40.36 

func (s *MissingVolumeConfiguration) Code() string

Code returns the exception type name.

func (*MissingVolumeConfiguration) Error added in v1.40.36 

func (s *MissingVolumeConfiguration) Error() string

func (MissingVolumeConfiguration) GoString added in v1.40.36 

func (s MissingVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MissingVolumeConfiguration) Message added in v1.40.36 

func (s *MissingVolumeConfiguration) Message() string

Message returns the exception's message.

func (*MissingVolumeConfiguration) OrigErr added in v1.40.36 

func (s *MissingVolumeConfiguration) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingVolumeConfiguration) RequestID added in v1.40.36 

func (s *MissingVolumeConfiguration) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingVolumeConfiguration) StatusCode added in v1.40.36 

func (s *MissingVolumeConfiguration) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MissingVolumeConfiguration) String added in v1.40.36 

func (s MissingVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotServiceResourceError added in v1.28.0 

type NotServiceResourceError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A detailed error message.
	Message_ *string `locationName:"Message" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the non-Amazon FSx resource.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (*NotServiceResourceError) Code added in v1.28.0 

func (s *NotServiceResourceError) Code() string

Code returns the exception type name.

func (*NotServiceResourceError) Error added in v1.28.0 

func (s *NotServiceResourceError) Error() string

func (NotServiceResourceError) GoString added in v1.28.0 

func (s NotServiceResourceError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotServiceResourceError) Message added in v1.28.0 

func (s *NotServiceResourceError) Message() string

Message returns the exception's message.

func (*NotServiceResourceError) OrigErr added in v1.28.0 

func (s *NotServiceResourceError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotServiceResourceError) RequestID added in v1.28.0 

func (s *NotServiceResourceError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotServiceResourceError) StatusCode added in v1.28.0 

func (s *NotServiceResourceError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotServiceResourceError) String added in v1.28.0 

func (s NotServiceResourceError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OntapFileSystemConfiguration added in v1.40.36 

type OntapFileSystemConfiguration 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 90 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

	// The ONTAP file system deployment type.
	DeploymentType *string `type:"string" enum:"OntapDeploymentType"`

	// The SSD IOPS configuration for the ONTAP file system, specifying the number
	// of provisioned IOPS and the provision mode.
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

	// The IP address range in which the endpoints to access your file system are
	// created.
	EndpointIpAddressRange *string `min:"9" type:"string"`

	// The Management and Intercluster endpoints that are used to access data or
	// to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp
	// SnapMirror.
	Endpoints *FileSystemEndpoints `type:"structure"`

	// The ID for a subnet. A subnet is a range of IP addresses in your virtual
	// private cloud (VPC). For more information, see VPC and Subnets (https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html)
	// in the Amazon VPC User Guide.
	PreferredSubnetId *string `min:"15" type:"string"`

	// The VPC route tables in which your file system's endpoints are created.
	RouteTableIds []*string `type:"list"`

	// Sustained throughput of an Amazon FSx file system in MBps.
	ThroughputCapacity *int64 `min:"8" type:"integer"`

	// A recurring weekly time, in the format D:HH:MM.
	//
	// D is the day of the week, for which 1 represents Monday and 7 represents
	// Sunday. For further details, see the ISO-8601 spec as described on Wikipedia
	// (https://en.wikipedia.org/wiki/ISO_week_date).
	//
	// HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute
	// of the hour.
	//
	// For example, 1:05:00 specifies maintenance at 5 AM Monday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

Configuration for the FSx for NetApp ONTAP file system.

func (OntapFileSystemConfiguration) GoString added in v1.40.36 

func (s OntapFileSystemConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OntapFileSystemConfiguration) SetAutomaticBackupRetentionDays added in v1.40.36 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*OntapFileSystemConfiguration) SetDailyAutomaticBackupStartTime added in v1.40.36 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*OntapFileSystemConfiguration) SetDeploymentType added in v1.40.36 

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

SetDeploymentType sets the DeploymentType field's value.

func (*OntapFileSystemConfiguration) SetDiskIopsConfiguration added in v1.40.36 

func (s *OntapFileSystemConfiguration) SetDiskIopsConfiguration(v *DiskIopsConfiguration) *OntapFileSystemConfiguration

SetDiskIopsConfiguration sets the DiskIopsConfiguration field's value.

func (*OntapFileSystemConfiguration) SetEndpointIpAddressRange added in v1.40.36 

func (s *OntapFileSystemConfiguration) SetEndpointIpAddressRange(v string) *OntapFileSystemConfiguration

SetEndpointIpAddressRange sets the EndpointIpAddressRange field's value.

func (*OntapFileSystemConfiguration) SetEndpoints added in v1.40.36 

func (s *OntapFileSystemConfiguration) SetEndpoints(v *FileSystemEndpoints) *OntapFileSystemConfiguration

SetEndpoints sets the Endpoints field's value.

func (*OntapFileSystemConfiguration) SetPreferredSubnetId added in v1.40.36 

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

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*OntapFileSystemConfiguration) SetRouteTableIds added in v1.40.36 

func (s *OntapFileSystemConfiguration) SetRouteTableIds(v []*string) *OntapFileSystemConfiguration

SetRouteTableIds sets the RouteTableIds field's value.

func (*OntapFileSystemConfiguration) SetThroughputCapacity added in v1.40.36 

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

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*OntapFileSystemConfiguration) SetWeeklyMaintenanceStartTime added in v1.40.36 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (OntapFileSystemConfiguration) String added in v1.40.36 

func (s OntapFileSystemConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OntapVolumeConfiguration added in v1.40.36 

type OntapVolumeConfiguration struct {

	// Specifies the FlexCache endpoint type of the volume. Valid values are the
	// following:
	//
	//    * NONE specifies that the volume doesn't have a FlexCache configuration.
	//    NONE is the default.
	//
	//    * ORIGIN specifies that the volume is the origin volume for a FlexCache
	//    volume.
	//
	//    * CACHE specifies that the volume is a FlexCache volume.
	FlexCacheEndpointType *string `type:"string" enum:"FlexCacheEndpointType"`

	// Specifies the directory that NAS clients use to mount the volume, along with
	// the SVM DNS name or IP address. You can create a JunctionPath directly below
	// a parent volume junction or on a directory within a volume. A JunctionPath
	// for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or
	// even /dir1/dir2/vol3..
	JunctionPath *string `min:"1" type:"string"`

	// Specifies the type of volume. Valid values are the following:
	//
	//    * RW specifies a read-write volume. RW is the default.
	//
	//    * DP specifies a data protection volume. You can protect data by replicating
	//    it to data protection mirror copies and use data protection mirror copies
	//    to recover data when a disaster occurs.
	//
	//    * LS specifies a load-sharing mirror volume. A load-sharing mirror reduces
	//    the network traffic to a FlexVol volume by providing additional read-only
	//    access to clients.
	OntapVolumeType *string `type:"string" enum:"OntapVolumeType"`

	// The security style for the volume, which can be UNIX, NTFS, or MIXED.
	SecurityStyle *string `type:"string" enum:"SecurityStyle"`

	// The configured size of the volume, in megabytes (MBs).
	SizeInMegabytes *int64 `type:"integer"`

	// The volume's storage efficiency setting.
	StorageEfficiencyEnabled *bool `type:"boolean"`

	// The ID of the volume's storage virtual machine.
	StorageVirtualMachineId *string `min:"21" type:"string"`

	// A boolean flag indicating whether this volume is the root volume for its
	// storage virtual machine (SVM). Only one volume on an SVM can be the root
	// volume. This value defaults to false. If this value is true, then this is
	// the SVM root volume.
	//
	// This flag is useful when you're deleting an SVM, because you must first delete
	// all non-root volumes. This flag, when set to false, helps you identify which
	// volumes to delete before you can delete the SVM.
	StorageVirtualMachineRoot *bool `type:"boolean"`

	// The volume's TieringPolicy setting.
	TieringPolicy *TieringPolicy `type:"structure"`

	// The volume's UUID (universally unique identifier).
	UUID *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration of an Amazon FSx for NetApp ONTAP volume

func (OntapVolumeConfiguration) GoString added in v1.40.36 

func (s OntapVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OntapVolumeConfiguration) SetFlexCacheEndpointType added in v1.40.36 

func (s *OntapVolumeConfiguration) SetFlexCacheEndpointType(v string) *OntapVolumeConfiguration

SetFlexCacheEndpointType sets the FlexCacheEndpointType field's value.

func (*OntapVolumeConfiguration) SetJunctionPath added in v1.40.36 

func (s *OntapVolumeConfiguration) SetJunctionPath(v string) *OntapVolumeConfiguration

SetJunctionPath sets the JunctionPath field's value.

func (*OntapVolumeConfiguration) SetOntapVolumeType added in v1.40.36 

func (s *OntapVolumeConfiguration) SetOntapVolumeType(v string) *OntapVolumeConfiguration

SetOntapVolumeType sets the OntapVolumeType field's value.

func (*OntapVolumeConfiguration) SetSecurityStyle added in v1.40.36 

func (s *OntapVolumeConfiguration) SetSecurityStyle(v string) *OntapVolumeConfiguration

SetSecurityStyle sets the SecurityStyle field's value.

func (*OntapVolumeConfiguration) SetSizeInMegabytes added in v1.40.36 

func (s *OntapVolumeConfiguration) SetSizeInMegabytes(v int64) *OntapVolumeConfiguration

SetSizeInMegabytes sets the SizeInMegabytes field's value.

func (*OntapVolumeConfiguration) SetStorageEfficiencyEnabled added in v1.40.36 

func (s *OntapVolumeConfiguration) SetStorageEfficiencyEnabled(v bool) *OntapVolumeConfiguration

SetStorageEfficiencyEnabled sets the StorageEfficiencyEnabled field's value.

func (*OntapVolumeConfiguration) SetStorageVirtualMachineId added in v1.40.36 

func (s *OntapVolumeConfiguration) SetStorageVirtualMachineId(v string) *OntapVolumeConfiguration

SetStorageVirtualMachineId sets the StorageVirtualMachineId field's value.

func (*OntapVolumeConfiguration) SetStorageVirtualMachineRoot added in v1.40.36 

func (s *OntapVolumeConfiguration) SetStorageVirtualMachineRoot(v bool) *OntapVolumeConfiguration

SetStorageVirtualMachineRoot sets the StorageVirtualMachineRoot field's value.

func (*OntapVolumeConfiguration) SetTieringPolicy added in v1.40.36 

func (s *OntapVolumeConfiguration) SetTieringPolicy(v *TieringPolicy) *OntapVolumeConfiguration

SetTieringPolicy sets the TieringPolicy field's value.

func (*OntapVolumeConfiguration) SetUUID added in v1.40.36 

func (s *OntapVolumeConfiguration) SetUUID(v string) *OntapVolumeConfiguration

SetUUID sets the UUID field's value.

func (OntapVolumeConfiguration) String added in v1.40.36 

func (s OntapVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceDoesNotSupportTagging added in v1.28.0 

type ResourceDoesNotSupportTagging struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A detailed error message.
	Message_ *string `locationName:"Message" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the resource that doesn't support tagging.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The resource specified does not support tagging.

func (*ResourceDoesNotSupportTagging) Code added in v1.28.0 

func (s *ResourceDoesNotSupportTagging) Code() string

Code returns the exception type name.

func (*ResourceDoesNotSupportTagging) Error added in v1.28.0 

func (s *ResourceDoesNotSupportTagging) Error() string

func (ResourceDoesNotSupportTagging) GoString added in v1.28.0 

func (s ResourceDoesNotSupportTagging) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceDoesNotSupportTagging) Message added in v1.28.0 

func (s *ResourceDoesNotSupportTagging) Message() string

Message returns the exception's message.

func (*ResourceDoesNotSupportTagging) OrigErr added in v1.28.0 

func (s *ResourceDoesNotSupportTagging) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceDoesNotSupportTagging) RequestID added in v1.28.0 

func (s *ResourceDoesNotSupportTagging) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceDoesNotSupportTagging) StatusCode added in v1.28.0 

func (s *ResourceDoesNotSupportTagging) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceDoesNotSupportTagging) String added in v1.28.0 

func (s ResourceDoesNotSupportTagging) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFound added in v1.28.0 

type ResourceNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A detailed error message.
	Message_ *string `locationName:"Message" min:"1" type:"string"`

	// The resource ARN of the resource that can't be found.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFound) Code added in v1.28.0 

func (s *ResourceNotFound) Code() string

Code returns the exception type name.

func (*ResourceNotFound) Error added in v1.28.0 

func (s *ResourceNotFound) Error() string

func (ResourceNotFound) GoString added in v1.28.0 

func (s ResourceNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFound) Message added in v1.28.0 

func (s *ResourceNotFound) Message() string

Message returns the exception's message.

func (*ResourceNotFound) OrigErr added in v1.28.0 

func (s *ResourceNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFound) RequestID added in v1.28.0 

func (s *ResourceNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFound) StatusCode added in v1.28.0 

func (s *ResourceNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFound) String added in v1.28.0 

func (s ResourceNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SelfManagedActiveDirectoryAttributes added in v1.20.7 

type SelfManagedActiveDirectoryAttributes struct {

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

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

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

	// The fully qualified distinguished name of the organizational unit within
	// the self-managed AD directory to which the Windows File Server or ONTAP storage
	// virtual machine (SVM) 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 or ONTAP storage virtual machine (SVM) instance is joined.

func (SelfManagedActiveDirectoryAttributes) GoString added in v1.20.7 

func (s SelfManagedActiveDirectoryAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelfManagedActiveDirectoryAttributes) SetDnsIps added in v1.20.7 

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

SetDnsIps sets the DnsIps field's value.

func (*SelfManagedActiveDirectoryAttributes) SetDomainName added in v1.20.7 

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

SetDomainName sets the DomainName field's value.

func (*SelfManagedActiveDirectoryAttributes) SetFileSystemAdministratorsGroup added in v1.20.7 

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

SetFileSystemAdministratorsGroup sets the FileSystemAdministratorsGroup field's value.

func (*SelfManagedActiveDirectoryAttributes) SetOrganizationalUnitDistinguishedName added in v1.20.7 

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

SetOrganizationalUnitDistinguishedName sets the OrganizationalUnitDistinguishedName field's value.

func (*SelfManagedActiveDirectoryAttributes) SetUserName added in v1.20.7 

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

SetUserName sets the UserName field's value.

func (SelfManagedActiveDirectoryAttributes) String added in v1.20.7 

func (s SelfManagedActiveDirectoryAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SelfManagedActiveDirectoryConfiguration added in v1.20.7 

type SelfManagedActiveDirectoryConfiguration struct {

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

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

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

	// (Optional) The fully qualified distinguished name of the organizational unit
	// within your self-managed AD directory. 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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SelfManagedActiveDirectoryConfiguration's
	// String and GoString methods.
	//
	// 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 a Amazon FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) or Managing SVMs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html).

func (SelfManagedActiveDirectoryConfiguration) GoString added in v1.20.7 

func (s SelfManagedActiveDirectoryConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelfManagedActiveDirectoryConfiguration) SetDnsIps added in v1.20.7 

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

SetDnsIps sets the DnsIps field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetDomainName added in v1.20.7 

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

SetDomainName sets the DomainName field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetFileSystemAdministratorsGroup added in v1.20.7 

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

SetFileSystemAdministratorsGroup sets the FileSystemAdministratorsGroup field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetOrganizationalUnitDistinguishedName added in v1.20.7 

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

SetOrganizationalUnitDistinguishedName sets the OrganizationalUnitDistinguishedName field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetPassword added in v1.20.7 

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

SetPassword sets the Password field's value.

func (*SelfManagedActiveDirectoryConfiguration) SetUserName added in v1.20.7 

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

SetUserName sets the UserName field's value.

func (SelfManagedActiveDirectoryConfiguration) String added in v1.20.7 

func (s SelfManagedActiveDirectoryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelfManagedActiveDirectoryConfiguration) Validate added in v1.20.7 

func (s *SelfManagedActiveDirectoryConfiguration) Validate() error

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

type SelfManagedActiveDirectoryConfigurationUpdates added in v1.20.7 

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SelfManagedActiveDirectoryConfigurationUpdates's
	// String and GoString methods.
	Password *string `min:"1" type:"string" sensitive:"true"`

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

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

func (SelfManagedActiveDirectoryConfigurationUpdates) GoString added in v1.20.7 

func (s SelfManagedActiveDirectoryConfigurationUpdates) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetDnsIps added in v1.20.7 

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

SetDnsIps sets the DnsIps field's value.

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetPassword added in v1.20.7 

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

SetPassword sets the Password field's value.

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetUserName added in v1.20.7 

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

SetUserName sets the UserName field's value.

func (SelfManagedActiveDirectoryConfigurationUpdates) String added in v1.20.7 

func (s SelfManagedActiveDirectoryConfigurationUpdates) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelfManagedActiveDirectoryConfigurationUpdates) Validate added in v1.20.7 

func (s *SelfManagedActiveDirectoryConfigurationUpdates) Validate() error

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

type ServiceLimitExceeded added in v1.28.0 

type ServiceLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Enumeration of the service limit that was exceeded.
	//
	// Limit is a required field
	Limit *string `type:"string" required:"true" enum:"ServiceLimit"`

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

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

func (*ServiceLimitExceeded) Code added in v1.28.0 

func (s *ServiceLimitExceeded) Code() string

Code returns the exception type name.

func (*ServiceLimitExceeded) Error added in v1.28.0 

func (s *ServiceLimitExceeded) Error() string

func (ServiceLimitExceeded) GoString added in v1.28.0 

func (s ServiceLimitExceeded) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceLimitExceeded) Message added in v1.28.0 

func (s *ServiceLimitExceeded) Message() string

Message returns the exception's message.

func (*ServiceLimitExceeded) OrigErr added in v1.28.0 

func (s *ServiceLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceLimitExceeded) RequestID added in v1.28.0 

func (s *ServiceLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceLimitExceeded) StatusCode added in v1.28.0 

func (s *ServiceLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceLimitExceeded) String added in v1.28.0 

func (s ServiceLimitExceeded) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SourceBackupUnavailable added in v1.38.18 

type SourceBackupUnavailable struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The ID of the source backup. Specifies the backup you are copying.
	BackupId *string `min:"12" type:"string"`

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

The request was rejected because the lifecycle status of the source backup is not AVAILABLE.

func (*SourceBackupUnavailable) Code added in v1.38.18 

func (s *SourceBackupUnavailable) Code() string

Code returns the exception type name.

func (*SourceBackupUnavailable) Error added in v1.38.18 

func (s *SourceBackupUnavailable) Error() string

func (SourceBackupUnavailable) GoString added in v1.38.18 

func (s SourceBackupUnavailable) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceBackupUnavailable) Message added in v1.38.18 

func (s *SourceBackupUnavailable) Message() string

Message returns the exception's message.

func (*SourceBackupUnavailable) OrigErr added in v1.38.18 

func (s *SourceBackupUnavailable) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SourceBackupUnavailable) RequestID added in v1.38.18 

func (s *SourceBackupUnavailable) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SourceBackupUnavailable) StatusCode added in v1.38.18 

func (s *SourceBackupUnavailable) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (SourceBackupUnavailable) String added in v1.38.18 

func (s SourceBackupUnavailable) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageVirtualMachine added in v1.40.36 

type StorageVirtualMachine struct {

	// Describes the Microsoft Active Directory configuration to which the SVM is
	// joined, if applicable.
	ActiveDirectoryConfiguration *SvmActiveDirectoryConfiguration `type:"structure"`

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

	// The endpoints that are used to access data or to manage the SVM using the
	// NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management,
	// Nfs, and Smb endpoints.
	Endpoints *SvmEndpoints `type:"structure"`

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

	// Describes the SVM's lifecycle status.
	//
	//    * CREATED - The SVM is fully available for use.
	//
	//    * CREATING - Amazon FSx is creating the new SVM.
	//
	//    * DELETING - Amazon FSx is deleting an existing SVM.
	//
	//    * FAILED - Amazon FSx was unable to create the SVM.
	//
	//    * MISCONFIGURED - The SVM is in a failed but recoverable state.
	//
	//    * PENDING - Amazon FSx has not started creating the SVM.
	Lifecycle *string `type:"string" enum:"StorageVirtualMachineLifecycle"`

	// Describes why the SVM lifecycle state changed.
	LifecycleTransitionReason *LifecycleTransitionReason `type:"structure"`

	// The name of the SVM, if provisioned.
	Name *string `min:"1" type:"string"`

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

	// The security style of the root volume of the SVM.
	RootVolumeSecurityStyle *string `type:"string" enum:"StorageVirtualMachineRootVolumeSecurityStyle"`

	// The SVM's system generated unique ID.
	StorageVirtualMachineId *string `min:"21" type:"string"`

	// Describes the SVM's subtype.
	Subtype *string `type:"string" enum:"StorageVirtualMachineSubtype"`

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

	// The SVM's UUID (universally unique identifier).
	UUID *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuraton.

func (StorageVirtualMachine) GoString added in v1.40.36 

func (s StorageVirtualMachine) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageVirtualMachine) SetActiveDirectoryConfiguration added in v1.40.36 

func (s *StorageVirtualMachine) SetActiveDirectoryConfiguration(v *SvmActiveDirectoryConfiguration) *StorageVirtualMachine

SetActiveDirectoryConfiguration sets the ActiveDirectoryConfiguration field's value.

func (*StorageVirtualMachine) SetCreationTime added in v1.40.36 

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

SetCreationTime sets the CreationTime field's value.

func (*StorageVirtualMachine) SetEndpoints added in v1.40.36 

func (s *StorageVirtualMachine) SetEndpoints(v *SvmEndpoints) *StorageVirtualMachine

SetEndpoints sets the Endpoints field's value.

func (*StorageVirtualMachine) SetFileSystemId added in v1.40.36 

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

SetFileSystemId sets the FileSystemId field's value.

func (*StorageVirtualMachine) SetLifecycle added in v1.40.36 

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

SetLifecycle sets the Lifecycle field's value.

func (*StorageVirtualMachine) SetLifecycleTransitionReason added in v1.40.36 

func (s *StorageVirtualMachine) SetLifecycleTransitionReason(v *LifecycleTransitionReason) *StorageVirtualMachine

SetLifecycleTransitionReason sets the LifecycleTransitionReason field's value.

func (*StorageVirtualMachine) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (*StorageVirtualMachine) SetResourceARN added in v1.40.36 

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

SetResourceARN sets the ResourceARN field's value.

func (*StorageVirtualMachine) SetRootVolumeSecurityStyle added in v1.40.36 

func (s *StorageVirtualMachine) SetRootVolumeSecurityStyle(v string) *StorageVirtualMachine

SetRootVolumeSecurityStyle sets the RootVolumeSecurityStyle field's value.

func (*StorageVirtualMachine) SetStorageVirtualMachineId added in v1.40.36 

func (s *StorageVirtualMachine) SetStorageVirtualMachineId(v string) *StorageVirtualMachine

SetStorageVirtualMachineId sets the StorageVirtualMachineId field's value.

func (*StorageVirtualMachine) SetSubtype added in v1.40.36 

func (s *StorageVirtualMachine) SetSubtype(v string) *StorageVirtualMachine

SetSubtype sets the Subtype field's value.

func (*StorageVirtualMachine) SetTags added in v1.40.36 

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

SetTags sets the Tags field's value.

func (*StorageVirtualMachine) SetUUID added in v1.40.36 

func (s *StorageVirtualMachine) SetUUID(v string) *StorageVirtualMachine

SetUUID sets the UUID field's value.

func (StorageVirtualMachine) String added in v1.40.36 

func (s StorageVirtualMachine) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageVirtualMachineFilter added in v1.40.36 

type StorageVirtualMachineFilter struct {

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

	// 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 for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements.

func (StorageVirtualMachineFilter) GoString added in v1.40.36 

func (s StorageVirtualMachineFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageVirtualMachineFilter) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (*StorageVirtualMachineFilter) SetValues added in v1.40.36 

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

SetValues sets the Values field's value.

func (StorageVirtualMachineFilter) String added in v1.40.36 

func (s StorageVirtualMachineFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageVirtualMachineNotFound added in v1.40.36 

type StorageVirtualMachineNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.

func (*StorageVirtualMachineNotFound) Code added in v1.40.36 

func (s *StorageVirtualMachineNotFound) Code() string

Code returns the exception type name.

func (*StorageVirtualMachineNotFound) Error added in v1.40.36 

func (s *StorageVirtualMachineNotFound) Error() string

func (StorageVirtualMachineNotFound) GoString added in v1.40.36 

func (s StorageVirtualMachineNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageVirtualMachineNotFound) Message added in v1.40.36 

func (s *StorageVirtualMachineNotFound) Message() string

Message returns the exception's message.

func (*StorageVirtualMachineNotFound) OrigErr added in v1.40.36 

func (s *StorageVirtualMachineNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*StorageVirtualMachineNotFound) RequestID added in v1.40.36 

func (s *StorageVirtualMachineNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*StorageVirtualMachineNotFound) StatusCode added in v1.40.36 

func (s *StorageVirtualMachineNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (StorageVirtualMachineNotFound) String added in v1.40.36 

func (s StorageVirtualMachineNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SvmActiveDirectoryConfiguration added in v1.40.36 

type SvmActiveDirectoryConfiguration struct {

	// The NetBIOS name of the Active Directory computer object that is joined to
	// your SVM.
	NetBiosName *string `min:"1" type:"string"`

	// The configuration of the self-managed Microsoft Active Directory (AD) directory
	// to which the Windows File Server or ONTAP storage virtual machine (SVM) instance
	// is joined.
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryAttributes `type:"structure"`
	// contains filtered or unexported fields
}

Describes the configuration of the Microsoft Active Directory (AD) directory to which the Amazon FSx for ONTAP storage virtual machine (SVM) is joined. Pleae note, account credentials are not returned in the response payload.

func (SvmActiveDirectoryConfiguration) GoString added in v1.40.36 

func (s SvmActiveDirectoryConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SvmActiveDirectoryConfiguration) SetNetBiosName added in v1.40.36 

func (s *SvmActiveDirectoryConfiguration) SetNetBiosName(v string) *SvmActiveDirectoryConfiguration

SetNetBiosName sets the NetBiosName field's value.

func (*SvmActiveDirectoryConfiguration) SetSelfManagedActiveDirectoryConfiguration added in v1.40.36 

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

SetSelfManagedActiveDirectoryConfiguration sets the SelfManagedActiveDirectoryConfiguration field's value.

func (SvmActiveDirectoryConfiguration) String added in v1.40.36 

func (s SvmActiveDirectoryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SvmEndpoint added in v1.40.36 

type SvmEndpoint struct {

	// The Domain Name Service (DNS) name for the file system. You can mount your
	// file system using its DNS name.
	DNSName *string `min:"16" type:"string"`

	// The SVM endpoint's IP addresses.
	IpAddresses []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

func (SvmEndpoint) GoString added in v1.40.36 

func (s SvmEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SvmEndpoint) SetDNSName added in v1.40.36 

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

SetDNSName sets the DNSName field's value.

func (*SvmEndpoint) SetIpAddresses added in v1.40.36 

func (s *SvmEndpoint) SetIpAddresses(v []*string) *SvmEndpoint

SetIpAddresses sets the IpAddresses field's value.

func (SvmEndpoint) String added in v1.40.36 

func (s SvmEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SvmEndpoints added in v1.40.36 

type SvmEndpoints struct {

	// An endpoint for connecting using the Internet Small Computer Systems Interface
	// (iSCSI) protocol.
	Iscsi *SvmEndpoint `type:"structure"`

	// An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API,
	// or NetApp CloudManager.
	Management *SvmEndpoint `type:"structure"`

	// An endpoint for connecting using the Network File System (NFS) protocol.
	Nfs *SvmEndpoint `type:"structure"`

	// An endpoint for connecting using the Server Message Block (SMB) protocol.
	Smb *SvmEndpoint `type:"structure"`
	// contains filtered or unexported fields
}

An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the following endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.

func (SvmEndpoints) GoString added in v1.40.36 

func (s SvmEndpoints) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SvmEndpoints) SetIscsi added in v1.40.36 

func (s *SvmEndpoints) SetIscsi(v *SvmEndpoint) *SvmEndpoints

SetIscsi sets the Iscsi field's value.

func (*SvmEndpoints) SetManagement added in v1.40.36 

func (s *SvmEndpoints) SetManagement(v *SvmEndpoint) *SvmEndpoints

SetManagement sets the Management field's value.

func (*SvmEndpoints) SetNfs added in v1.40.36 

func (s *SvmEndpoints) SetNfs(v *SvmEndpoint) *SvmEndpoints

SetNfs sets the Nfs field's value.

func (*SvmEndpoints) SetSmb added in v1.40.36 

func (s *SvmEndpoints) SetSmb(v *SvmEndpoint) *SvmEndpoints

SetSmb sets the Smb field's value.

func (SvmEndpoints) String added in v1.40.36 

func (s SvmEndpoints) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 is a required field
	Key *string `min:"1" type:"string" required:"true"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TieringPolicy added in v1.40.36 

type TieringPolicy struct {

	// Specifies the number of days that user data in a volume must remain inactive
	// before it is considered "cold" and moved to the capacity pool. Used with
	// the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between
	// 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
	CoolingPeriod *int64 `min:"2" type:"integer"`

	// Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
	//
	//    * SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
	//
	//    * AUTO - moves cold user data and snapshots to the capacity pool storage
	//    tier based on your access patterns.
	//
	//    * ALL - moves all user data blocks in both the active file system and
	//    Snapshot copies to the storage pool tier.
	//
	//    * NONE - keeps a volume's data in the primary storage tier, preventing
	//    it from being moved to the capacity pool tier.
	Name *string `type:"string" enum:"TieringPolicyName"`
	// contains filtered or unexported fields
}

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

func (TieringPolicy) GoString added in v1.40.36 

func (s TieringPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TieringPolicy) SetCoolingPeriod added in v1.40.36 

func (s *TieringPolicy) SetCoolingPeriod(v int64) *TieringPolicy

SetCoolingPeriod sets the CoolingPeriod field's value.

func (*TieringPolicy) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (TieringPolicy) String added in v1.40.36 

func (s TieringPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TieringPolicy) Validate added in v1.40.36 

func (s *TieringPolicy) Validate() error

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

type UnsupportedOperation added in v1.28.0 

type UnsupportedOperation struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The requested operation is not supported for this resource or API.

func (*UnsupportedOperation) Code added in v1.28.0 

func (s *UnsupportedOperation) Code() string

Code returns the exception type name.

func (*UnsupportedOperation) Error added in v1.28.0 

func (s *UnsupportedOperation) Error() string

func (UnsupportedOperation) GoString added in v1.28.0 

func (s UnsupportedOperation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedOperation) Message added in v1.28.0 

func (s *UnsupportedOperation) Message() string

Message returns the exception's message.

func (*UnsupportedOperation) OrigErr added in v1.28.0 

func (s *UnsupportedOperation) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedOperation) RequestID added in v1.28.0 

func (s *UnsupportedOperation) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedOperation) StatusCode added in v1.28.0 

func (s *UnsupportedOperation) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedOperation) String added in v1.28.0 

func (s UnsupportedOperation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFileSystemInput 

type UpdateFileSystemInput struct {

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

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

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

	// The configuration updates for an Amazon FSx for NetApp ONTAP file system.
	OntapConfiguration *UpdateFileSystemOntapConfiguration `type:"structure"`

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

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

The request object for the UpdateFileSystem operation.

func (UpdateFileSystemInput) GoString 

func (s UpdateFileSystemInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetOntapConfiguration added in v1.40.36 

func (s *UpdateFileSystemInput) SetOntapConfiguration(v *UpdateFileSystemOntapConfiguration) *UpdateFileSystemInput

SetOntapConfiguration sets the OntapConfiguration field's value.

func (*UpdateFileSystemInput) SetStorageCapacity added in v1.31.8 

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

SetStorageCapacity sets the StorageCapacity 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// (Optional) When you create your file system, your existing S3 objects appear
	// as file and directory listings. Use this property to choose how Amazon FSx
	// keeps your file and directory listing up to date as you add or modify objects
	// in your linked S3 bucket. AutoImportPolicy can have the following values:
	//
	//    * NONE - (Default) AutoImport is off. Amazon FSx only updates file and
	//    directory listings from the linked S3 bucket when the file system is created.
	//    FSx does not update the file and directory listing for any new or changed
	//    objects after choosing this option.
	//
	//    * NEW - AutoImport is on. Amazon FSx automatically imports directory listings
	//    of any new objects added to the linked S3 bucket that do not currently
	//    exist in the FSx file system.
	//
	//    * NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file
	//    and directory listings of any new objects added to the S3 bucket and any
	//    existing objects that are changed in the S3 bucket after you choose this
	//    option.
	//
	// For more information, see Automatically import updates from your S3 bucket
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html).
	AutoImportPolicy *string `type:"string" enum:"AutoImportPolicyType"`

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

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

	// Sets the data compression configuration for the file system. DataCompressionType
	// can have the following values:
	//
	//    * NONE - Data compression is turned off for the file system.
	//
	//    * LZ4 - Data compression is turned on with the LZ4 algorithm.
	//
	// If you don't use DataCompressionType, the file system retains its current
	// data compression configuration.
	//
	// For more information, see Lustre data compression (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html).
	DataCompressionType *string `type:"string" enum:"DataCompressionType"`

	// (Optional) The preferred start time to perform weekly maintenance, formatted
	// d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7,
	// beginning with Monday and ending with Sunday.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemLustreConfiguration) SetAutoImportPolicy added in v1.33.11 

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

SetAutoImportPolicy sets the AutoImportPolicy field's value.

func (*UpdateFileSystemLustreConfiguration) SetAutomaticBackupRetentionDays added in v1.32.9 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*UpdateFileSystemLustreConfiguration) SetDailyAutomaticBackupStartTime added in v1.32.9 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*UpdateFileSystemLustreConfiguration) SetDataCompressionType added in v1.38.50 

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

SetDataCompressionType sets the DataCompressionType field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemLustreConfiguration) Validate 

func (s *UpdateFileSystemLustreConfiguration) Validate() error

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

type UpdateFileSystemOntapConfiguration added in v1.40.36 

type UpdateFileSystemOntapConfiguration 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 90 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

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

	// The ONTAP administrative password for the fsxadmin user.
	//
	// FsxAdminPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateFileSystemOntapConfiguration's
	// String and GoString methods.
	FsxAdminPassword *string `min:"8" type:"string" sensitive:"true"`

	// A recurring weekly time, in the format D:HH:MM.
	//
	// D is the day of the week, for which 1 represents Monday and 7 represents
	// Sunday. For further details, see the ISO-8601 spec as described on Wikipedia
	// (https://en.wikipedia.org/wiki/ISO_week_date).
	//
	// HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute
	// of the hour.
	//
	// For example, 1:05:00 specifies maintenance at 5 AM Monday.
	WeeklyMaintenanceStartTime *string `min:"7" type:"string"`
	// contains filtered or unexported fields
}

The configuration updates for an Amazon FSx for NetApp ONTAP file system.

func (UpdateFileSystemOntapConfiguration) GoString added in v1.40.36 

func (s UpdateFileSystemOntapConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemOntapConfiguration) SetAutomaticBackupRetentionDays added in v1.40.36 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*UpdateFileSystemOntapConfiguration) SetDailyAutomaticBackupStartTime added in v1.40.36 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*UpdateFileSystemOntapConfiguration) SetFsxAdminPassword added in v1.40.36 

func (s *UpdateFileSystemOntapConfiguration) SetFsxAdminPassword(v string) *UpdateFileSystemOntapConfiguration

SetFsxAdminPassword sets the FsxAdminPassword field's value.

func (*UpdateFileSystemOntapConfiguration) SetWeeklyMaintenanceStartTime added in v1.40.36 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (UpdateFileSystemOntapConfiguration) String added in v1.40.36 

func (s UpdateFileSystemOntapConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemOntapConfiguration) Validate added in v1.40.36 

func (s *UpdateFileSystemOntapConfiguration) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFileSystemWindowsConfiguration 

type UpdateFileSystemWindowsConfiguration struct {

	// The configuration that Amazon FSx for Windows File Server uses to audit and
	// log user accesses of files, folders, and file shares on the Amazon FSx for
	// Windows File Server file system..
	AuditLogConfiguration *WindowsAuditLogCreateConfiguration `type:"structure"`

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

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

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

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

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

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

func (UpdateFileSystemWindowsConfiguration) GoString 

func (s UpdateFileSystemWindowsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemWindowsConfiguration) SetAuditLogConfiguration added in v1.38.57 

func (s *UpdateFileSystemWindowsConfiguration) SetAuditLogConfiguration(v *WindowsAuditLogCreateConfiguration) *UpdateFileSystemWindowsConfiguration

SetAuditLogConfiguration sets the AuditLogConfiguration field's value.

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 added in v1.20.7 

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

SetSelfManagedActiveDirectoryConfiguration sets the SelfManagedActiveDirectoryConfiguration field's value.

func (*UpdateFileSystemWindowsConfiguration) SetThroughputCapacity added in v1.31.8 

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

SetThroughputCapacity sets the ThroughputCapacity 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFileSystemWindowsConfiguration) Validate 

func (s *UpdateFileSystemWindowsConfiguration) Validate() error

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

type UpdateOntapVolumeConfiguration added in v1.40.36 

type UpdateOntapVolumeConfiguration struct {

	// Specifies the location in the SVM's namespace where the volume is mounted.
	// The JunctionPath must have a leading forward slash, such as /vol3.
	JunctionPath *string `min:"1" type:"string"`

	// The security style for the volume, which can be UNIX. NTFS, or MIXED.
	SecurityStyle *string `type:"string" enum:"SecurityStyle"`

	// Specifies the size of the volume in megabytes.
	SizeInMegabytes *int64 `type:"integer"`

	// Default is false. Set to true to enable the deduplication, compression, and
	// compaction storage efficiency features on the volume.
	StorageEfficiencyEnabled *bool `type:"boolean"`

	// Update the volume's data tiering policy.
	TieringPolicy *TieringPolicy `type:"structure"`
	// contains filtered or unexported fields
}

Used to specify changes to the ONTAP configuration for the volume you are updating.

func (UpdateOntapVolumeConfiguration) GoString added in v1.40.36 

func (s UpdateOntapVolumeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateOntapVolumeConfiguration) SetJunctionPath added in v1.40.36 

func (s *UpdateOntapVolumeConfiguration) SetJunctionPath(v string) *UpdateOntapVolumeConfiguration

SetJunctionPath sets the JunctionPath field's value.

func (*UpdateOntapVolumeConfiguration) SetSecurityStyle added in v1.40.36 

func (s *UpdateOntapVolumeConfiguration) SetSecurityStyle(v string) *UpdateOntapVolumeConfiguration

SetSecurityStyle sets the SecurityStyle field's value.

func (*UpdateOntapVolumeConfiguration) SetSizeInMegabytes added in v1.40.36 

func (s *UpdateOntapVolumeConfiguration) SetSizeInMegabytes(v int64) *UpdateOntapVolumeConfiguration

SetSizeInMegabytes sets the SizeInMegabytes field's value.

func (*UpdateOntapVolumeConfiguration) SetStorageEfficiencyEnabled added in v1.40.36 

func (s *UpdateOntapVolumeConfiguration) SetStorageEfficiencyEnabled(v bool) *UpdateOntapVolumeConfiguration

SetStorageEfficiencyEnabled sets the StorageEfficiencyEnabled field's value.

func (*UpdateOntapVolumeConfiguration) SetTieringPolicy added in v1.40.36 

func (s *UpdateOntapVolumeConfiguration) SetTieringPolicy(v *TieringPolicy) *UpdateOntapVolumeConfiguration

SetTieringPolicy sets the TieringPolicy field's value.

func (UpdateOntapVolumeConfiguration) String added in v1.40.36 

func (s UpdateOntapVolumeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateOntapVolumeConfiguration) Validate added in v1.40.36 

func (s *UpdateOntapVolumeConfiguration) Validate() error

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

type UpdateStorageVirtualMachineInput added in v1.40.36 

type UpdateStorageVirtualMachineInput struct {

	// Updates the Microsoft Active Directory (AD) configuration for an SVM that
	// is joined to an AD.
	ActiveDirectoryConfiguration *UpdateSvmActiveDirectoryConfiguration `type:"structure"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.
	//
	// StorageVirtualMachineId is a required field
	StorageVirtualMachineId *string `min:"21" type:"string" required:"true"`

	// Enter a new SvmAdminPassword if you are updating it.
	//
	// SvmAdminPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateStorageVirtualMachineInput's
	// String and GoString methods.
	SvmAdminPassword *string `min:"8" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateStorageVirtualMachineInput) GoString added in v1.40.36 

func (s UpdateStorageVirtualMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStorageVirtualMachineInput) SetActiveDirectoryConfiguration added in v1.40.36 

func (s *UpdateStorageVirtualMachineInput) SetActiveDirectoryConfiguration(v *UpdateSvmActiveDirectoryConfiguration) *UpdateStorageVirtualMachineInput

SetActiveDirectoryConfiguration sets the ActiveDirectoryConfiguration field's value.

func (*UpdateStorageVirtualMachineInput) SetClientRequestToken added in v1.40.36 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateStorageVirtualMachineInput) SetStorageVirtualMachineId added in v1.40.36 

func (s *UpdateStorageVirtualMachineInput) SetStorageVirtualMachineId(v string) *UpdateStorageVirtualMachineInput

SetStorageVirtualMachineId sets the StorageVirtualMachineId field's value.

func (*UpdateStorageVirtualMachineInput) SetSvmAdminPassword added in v1.40.36 

func (s *UpdateStorageVirtualMachineInput) SetSvmAdminPassword(v string) *UpdateStorageVirtualMachineInput

SetSvmAdminPassword sets the SvmAdminPassword field's value.

func (UpdateStorageVirtualMachineInput) String added in v1.40.36 

func (s UpdateStorageVirtualMachineInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStorageVirtualMachineInput) Validate added in v1.40.36 

func (s *UpdateStorageVirtualMachineInput) Validate() error

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

type UpdateStorageVirtualMachineOutput added in v1.40.36 

type UpdateStorageVirtualMachineOutput struct {

	// Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuraton.
	StorageVirtualMachine *StorageVirtualMachine `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateStorageVirtualMachineOutput) GoString added in v1.40.36 

func (s UpdateStorageVirtualMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStorageVirtualMachineOutput) SetStorageVirtualMachine added in v1.40.36 

func (s *UpdateStorageVirtualMachineOutput) SetStorageVirtualMachine(v *StorageVirtualMachine) *UpdateStorageVirtualMachineOutput

SetStorageVirtualMachine sets the StorageVirtualMachine field's value.

func (UpdateStorageVirtualMachineOutput) String added in v1.40.36 

func (s UpdateStorageVirtualMachineOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSvmActiveDirectoryConfiguration added in v1.40.36 

type UpdateSvmActiveDirectoryConfiguration struct {

	// The configuration that Amazon FSx uses to join the Windows File Server instance
	// to a self-managed Microsoft Active Directory (AD) directory.
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates `type:"structure"`
	// contains filtered or unexported fields
}

Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. Pleae note, account credentials are not returned in the response payload.

func (UpdateSvmActiveDirectoryConfiguration) GoString added in v1.40.36 

func (s UpdateSvmActiveDirectoryConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSvmActiveDirectoryConfiguration) SetSelfManagedActiveDirectoryConfiguration added in v1.40.36 

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

SetSelfManagedActiveDirectoryConfiguration sets the SelfManagedActiveDirectoryConfiguration field's value.

func (UpdateSvmActiveDirectoryConfiguration) String added in v1.40.36 

func (s UpdateSvmActiveDirectoryConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSvmActiveDirectoryConfiguration) Validate added in v1.40.36 

func (s *UpdateSvmActiveDirectoryConfiguration) Validate() error

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

type UpdateVolumeInput added in v1.40.36 

type UpdateVolumeInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 64 ASCII characters. This token is automatically filled on your behalf
	// when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The ONTAP configuration of the volume you are updating.
	OntapConfiguration *UpdateOntapVolumeConfiguration `type:"structure"`

	// Specifies the volume that you want to update, formatted fsvol-0123456789abcdef0.
	//
	// VolumeId is a required field
	VolumeId *string `min:"23" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateVolumeInput) GoString added in v1.40.36 

func (s UpdateVolumeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVolumeInput) SetClientRequestToken added in v1.40.36 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateVolumeInput) SetOntapConfiguration added in v1.40.36 

func (s *UpdateVolumeInput) SetOntapConfiguration(v *UpdateOntapVolumeConfiguration) *UpdateVolumeInput

SetOntapConfiguration sets the OntapConfiguration field's value.

func (*UpdateVolumeInput) SetVolumeId added in v1.40.36 

func (s *UpdateVolumeInput) SetVolumeId(v string) *UpdateVolumeInput

SetVolumeId sets the VolumeId field's value.

func (UpdateVolumeInput) String added in v1.40.36 

func (s UpdateVolumeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVolumeInput) Validate added in v1.40.36 

func (s *UpdateVolumeInput) Validate() error

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

type UpdateVolumeOutput added in v1.40.36 

type UpdateVolumeOutput struct {

	// Returned after a successful UpdateVolume API operation, describing the volume
	// just updated.
	Volume *Volume `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateVolumeOutput) GoString added in v1.40.36 

func (s UpdateVolumeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateVolumeOutput) SetVolume added in v1.40.36 

func (s *UpdateVolumeOutput) SetVolume(v *Volume) *UpdateVolumeOutput

SetVolume sets the Volume field's value.

func (UpdateVolumeOutput) String added in v1.40.36 

func (s UpdateVolumeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Volume added in v1.40.36 

type Volume struct {

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

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

	// The lifecycle status of the volume.
	//
	//    * CREATED - The volume is fully available for use.
	//
	//    * CREATING - Amazon FSx is creating the new volume.
	//
	//    * DELETING - Amazon FSx is deleting an existing volume.
	//
	//    * FAILED - Amazon FSx was unable to create the volume.
	//
	//    * MISCONFIGURED - The volume is in a failed but recoverable state.
	//
	//    * PENDING - Amazon FSx has not started creating the volume.
	Lifecycle *string `type:"string" enum:"VolumeLifecycle"`

	// Describes why the volume lifecycle state changed.
	LifecycleTransitionReason *LifecycleTransitionReason `type:"structure"`

	// The name of the volume.
	Name *string `min:"1" type:"string"`

	// The configuration of an Amazon FSx for NetApp ONTAP volume
	OntapConfiguration *OntapVolumeConfiguration `type:"structure"`

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

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

	// The system-generated, unique ID of the volume.
	VolumeId *string `min:"23" type:"string"`

	// The type of volume; ONTAP is the only valid volume type.
	VolumeType *string `type:"string" enum:"VolumeType"`
	// contains filtered or unexported fields
}

Describes an Amazon FSx for NetApp ONTAP volume.

func (Volume) GoString added in v1.40.36 

func (s Volume) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Volume) SetCreationTime added in v1.40.36 

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

SetCreationTime sets the CreationTime field's value.

func (*Volume) SetFileSystemId added in v1.40.36 

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

SetFileSystemId sets the FileSystemId field's value.

func (*Volume) SetLifecycle added in v1.40.36 

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

SetLifecycle sets the Lifecycle field's value.

func (*Volume) SetLifecycleTransitionReason added in v1.40.36 

func (s *Volume) SetLifecycleTransitionReason(v *LifecycleTransitionReason) *Volume

SetLifecycleTransitionReason sets the LifecycleTransitionReason field's value.

func (*Volume) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (*Volume) SetOntapConfiguration added in v1.40.36 

func (s *Volume) SetOntapConfiguration(v *OntapVolumeConfiguration) *Volume

SetOntapConfiguration sets the OntapConfiguration field's value.

func (*Volume) SetResourceARN added in v1.40.36 

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

SetResourceARN sets the ResourceARN field's value.

func (*Volume) SetTags added in v1.40.36 

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

SetTags sets the Tags field's value.

func (*Volume) SetVolumeId added in v1.40.36 

func (s *Volume) SetVolumeId(v string) *Volume

SetVolumeId sets the VolumeId field's value.

func (*Volume) SetVolumeType added in v1.40.36 

func (s *Volume) SetVolumeType(v string) *Volume

SetVolumeType sets the VolumeType field's value.

func (Volume) String added in v1.40.36 

func (s Volume) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VolumeFilter added in v1.40.36 

type VolumeFilter struct {

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

	// 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 for Amazon FSx for NetApp ONTAP volumes. You can use multiple filters to return results that meet all applied filter requirements.

func (VolumeFilter) GoString added in v1.40.36 

func (s VolumeFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VolumeFilter) SetName added in v1.40.36 

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

SetName sets the Name field's value.

func (*VolumeFilter) SetValues added in v1.40.36 

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

SetValues sets the Values field's value.

func (VolumeFilter) String added in v1.40.36 

func (s VolumeFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VolumeNotFound added in v1.40.36 

type VolumeNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.

func (*VolumeNotFound) Code added in v1.40.36 

func (s *VolumeNotFound) Code() string

Code returns the exception type name.

func (*VolumeNotFound) Error added in v1.40.36 

func (s *VolumeNotFound) Error() string

func (VolumeNotFound) GoString added in v1.40.36 

func (s VolumeNotFound) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VolumeNotFound) Message added in v1.40.36 

func (s *VolumeNotFound) Message() string

Message returns the exception's message.

func (*VolumeNotFound) OrigErr added in v1.40.36 

func (s *VolumeNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*VolumeNotFound) RequestID added in v1.40.36 

func (s *VolumeNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*VolumeNotFound) StatusCode added in v1.40.36 

func (s *VolumeNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (VolumeNotFound) String added in v1.40.36 

func (s VolumeNotFound) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WindowsAuditLogConfiguration added in v1.38.57 

type WindowsAuditLogConfiguration struct {

	// The Amazon Resource Name (ARN) for the destination of the audit logs. The
	// destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis
	// Data Firehose delivery stream ARN.
	//
	// The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx
	// prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must
	// begin with the aws-fsx prefix.
	//
	// The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose
	// delivery stream) must be in the same Amazon Web Services partition, Amazon
	// Web Services Region, and Amazon Web Services account as your Amazon FSx file
	// system.
	AuditLogDestination *string `min:"8" type:"string"`

	// Sets which attempt type is logged by Amazon FSx for file and folder accesses.
	//
	//    * SUCCESS_ONLY - only successful attempts to access files or folders are
	//    logged.
	//
	//    * FAILURE_ONLY - only failed attempts to access files or folders are logged.
	//
	//    * SUCCESS_AND_FAILURE - both successful attempts and failed attempts to
	//    access files or folders are logged.
	//
	//    * DISABLED - access auditing of files and folders is turned off.
	//
	// FileAccessAuditLogLevel is a required field
	FileAccessAuditLogLevel *string `type:"string" required:"true" enum:"WindowsAccessAuditLogLevel"`

	// Sets which attempt type is logged by Amazon FSx for file share accesses.
	//
	//    * SUCCESS_ONLY - only successful attempts to access file shares are logged.
	//
	//    * FAILURE_ONLY - only failed attempts to access file shares are logged.
	//
	//    * SUCCESS_AND_FAILURE - both successful attempts and failed attempts to
	//    access file shares are logged.
	//
	//    * DISABLED - access auditing of file shares is turned off.
	//
	// FileShareAccessAuditLogLevel is a required field
	FileShareAccessAuditLogLevel *string `type:"string" required:"true" enum:"WindowsAccessAuditLogLevel"`
	// contains filtered or unexported fields
}

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. For more information, see File access auditing (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/file-access-auditing.html).

func (WindowsAuditLogConfiguration) GoString added in v1.38.57 

func (s WindowsAuditLogConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WindowsAuditLogConfiguration) SetAuditLogDestination added in v1.38.57 

func (s *WindowsAuditLogConfiguration) SetAuditLogDestination(v string) *WindowsAuditLogConfiguration

SetAuditLogDestination sets the AuditLogDestination field's value.

func (*WindowsAuditLogConfiguration) SetFileAccessAuditLogLevel added in v1.38.57 

func (s *WindowsAuditLogConfiguration) SetFileAccessAuditLogLevel(v string) *WindowsAuditLogConfiguration

SetFileAccessAuditLogLevel sets the FileAccessAuditLogLevel field's value.

func (*WindowsAuditLogConfiguration) SetFileShareAccessAuditLogLevel added in v1.38.57 

func (s *WindowsAuditLogConfiguration) SetFileShareAccessAuditLogLevel(v string) *WindowsAuditLogConfiguration

SetFileShareAccessAuditLogLevel sets the FileShareAccessAuditLogLevel field's value.

func (WindowsAuditLogConfiguration) String added in v1.38.57 

func (s WindowsAuditLogConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WindowsAuditLogCreateConfiguration added in v1.38.57 

type WindowsAuditLogCreateConfiguration struct {

	// The Amazon Resource Name (ARN) that specifies the destination of the audit
	// logs.
	//
	// The destination can be any Amazon CloudWatch Logs log group ARN or Amazon
	// Kinesis Data Firehose delivery stream ARN, with the following requirements:
	//
	//    * The destination ARN that you provide (either CloudWatch Logs log group
	//    or Kinesis Data Firehose delivery stream) must be in the same Amazon Web
	//    Services partition, Amazon Web Services Region, and Amazon Web Services
	//    account as your Amazon FSx file system.
	//
	//    * The name of the Amazon CloudWatch Logs log group must begin with the
	//    /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery
	//    stream must begin with the aws-fsx prefix.
	//
	//    * If you do not provide a destination in AuditLogDestination, Amazon FSx
	//    will create and use a log stream in the CloudWatch Logs /aws/fsx/windows
	//    log group.
	//
	//    * If AuditLogDestination is provided and the resource does not exist,
	//    the request will fail with a BadRequest error.
	//
	//    * If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both
	//    set to DISABLED, you cannot specify a destination in AuditLogDestination.
	AuditLogDestination *string `min:"8" type:"string"`

	// Sets which attempt type is logged by Amazon FSx for file and folder accesses.
	//
	//    * SUCCESS_ONLY - only successful attempts to access files or folders are
	//    logged.
	//
	//    * FAILURE_ONLY - only failed attempts to access files or folders are logged.
	//
	//    * SUCCESS_AND_FAILURE - both successful attempts and failed attempts to
	//    access files or folders are logged.
	//
	//    * DISABLED - access auditing of files and folders is turned off.
	//
	// FileAccessAuditLogLevel is a required field
	FileAccessAuditLogLevel *string `type:"string" required:"true" enum:"WindowsAccessAuditLogLevel"`

	// Sets which attempt type is logged by Amazon FSx for file share accesses.
	//
	//    * SUCCESS_ONLY - only successful attempts to access file shares are logged.
	//
	//    * FAILURE_ONLY - only failed attempts to access file shares are logged.
	//
	//    * SUCCESS_AND_FAILURE - both successful attempts and failed attempts to
	//    access file shares are logged.
	//
	//    * DISABLED - access auditing of file shares is turned off.
	//
	// FileShareAccessAuditLogLevel is a required field
	FileShareAccessAuditLogLevel *string `type:"string" required:"true" enum:"WindowsAccessAuditLogLevel"`
	// contains filtered or unexported fields
}

The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.

func (WindowsAuditLogCreateConfiguration) GoString added in v1.38.57 

func (s WindowsAuditLogCreateConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WindowsAuditLogCreateConfiguration) SetAuditLogDestination added in v1.38.57 

func (s *WindowsAuditLogCreateConfiguration) SetAuditLogDestination(v string) *WindowsAuditLogCreateConfiguration

SetAuditLogDestination sets the AuditLogDestination field's value.

func (*WindowsAuditLogCreateConfiguration) SetFileAccessAuditLogLevel added in v1.38.57 

func (s *WindowsAuditLogCreateConfiguration) SetFileAccessAuditLogLevel(v string) *WindowsAuditLogCreateConfiguration

SetFileAccessAuditLogLevel sets the FileAccessAuditLogLevel field's value.

func (*WindowsAuditLogCreateConfiguration) SetFileShareAccessAuditLogLevel added in v1.38.57 

func (s *WindowsAuditLogCreateConfiguration) SetFileShareAccessAuditLogLevel(v string) *WindowsAuditLogCreateConfiguration

SetFileShareAccessAuditLogLevel sets the FileShareAccessAuditLogLevel field's value.

func (WindowsAuditLogCreateConfiguration) String added in v1.38.57 

func (s WindowsAuditLogCreateConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WindowsAuditLogCreateConfiguration) Validate added in v1.38.57 

func (s *WindowsAuditLogCreateConfiguration) 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 Amazon Web Services Managed Microsoft Active Directory
	// instance that the file system is joined to.
	ActiveDirectoryId *string `min:"12" type:"string"`

	// An array of one or more DNS aliases that are currently associated with the
	// Amazon FSx file system. Aliases allow you to use existing DNS names to access
	// the data in your Amazon FSx file system. You can associate up to 50 aliases
	// with a file system at any time. You can associate additional DNS aliases
	// after you create the file system using the AssociateFileSystemAliases operation.
	// You can remove DNS aliases from the file system after it is created using
	// the DisassociateFileSystemAliases operation. You only need to specify the
	// alias name in the request payload. For more information, see DNS aliases
	// (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html).
	Aliases []*Alias `type:"list"`

	// The configuration that Amazon FSx for Windows File Server uses to audit and
	// log user accesses of files, folders, and file shares on the Amazon FSx for
	// Windows File Server file system.
	AuditLogConfiguration *WindowsAuditLogConfiguration `type:"structure"`

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

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

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

	// Specifies the file system deployment type, valid values are the following:
	//
	//    * MULTI_AZ_1 - Specifies a high availability file system that is configured
	//    for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability,
	//    and supports SSD and HDD storage.
	//
	//    * SINGLE_AZ_1 - (Default) Specifies a file system that is configured for
	//    single AZ redundancy, only supports SSD storage.
	//
	//    * SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file
	//    system that is configured for single AZ redundancy and supports SSD and
	//    HDD storage.
	//
	// For more information, see Single-AZ and Multi-AZ File Systems (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html).
	DeploymentType *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 all Windows file system deployment types. This IP address
	// is temporarily unavailable when the file system is undergoing maintenance.
	// For Linux and Windows SMB clients that are joined to an Active Directory,
	// use the file system's DNSName instead. For more information on mapping and
	// mounting file shares, see Accessing File Shares (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html).
	PreferredFileServerIp *string `min:"7" type:"string"`

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

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

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

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

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

The configuration for this Microsoft Windows file system.

func (WindowsFileSystemConfiguration) GoString 

func (s WindowsFileSystemConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WindowsFileSystemConfiguration) SetActiveDirectoryId 

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

SetActiveDirectoryId sets the ActiveDirectoryId field's value.

func (*WindowsFileSystemConfiguration) SetAliases added in v1.35.24 

func (s *WindowsFileSystemConfiguration) SetAliases(v []*Alias) *WindowsFileSystemConfiguration

SetAliases sets the Aliases field's value.

func (*WindowsFileSystemConfiguration) SetAuditLogConfiguration added in v1.38.57 

func (s *WindowsFileSystemConfiguration) SetAuditLogConfiguration(v *WindowsAuditLogConfiguration) *WindowsFileSystemConfiguration

SetAuditLogConfiguration sets the AuditLogConfiguration 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 added in v1.25.39 

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 added in v1.25.39 

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

SetPreferredFileServerIp sets the PreferredFileServerIp field's value.

func (*WindowsFileSystemConfiguration) SetPreferredSubnetId added in v1.25.39 

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

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*WindowsFileSystemConfiguration) SetRemoteAdministrationEndpoint added in v1.25.39 

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

SetRemoteAdministrationEndpoint sets the RemoteAdministrationEndpoint field's value.

func (*WindowsFileSystemConfiguration) SetSelfManagedActiveDirectoryConfiguration added in v1.20.7 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

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