fsx

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 91

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"

	// AdministrativeActionTypeVolumeUpdate is a AdministrativeActionType enum value
	AdministrativeActionTypeVolumeUpdate = "VOLUME_UPDATE"

	// AdministrativeActionTypeSnapshotUpdate is a AdministrativeActionType enum value
	AdministrativeActionTypeSnapshotUpdate = "SNAPSHOT_UPDATE"

	// AdministrativeActionTypeReleaseNfsV3Locks is a AdministrativeActionType enum value
	AdministrativeActionTypeReleaseNfsV3Locks = "RELEASE_NFS_V3_LOCKS"

	// AdministrativeActionTypeVolumeRestore is a AdministrativeActionType enum value
	AdministrativeActionTypeVolumeRestore = "VOLUME_RESTORE"

	// AdministrativeActionTypeThroughputOptimization is a AdministrativeActionType enum value
	AdministrativeActionTypeThroughputOptimization = "THROUGHPUT_OPTIMIZATION"

	// AdministrativeActionTypeIopsOptimization is a AdministrativeActionType enum value
	AdministrativeActionTypeIopsOptimization = "IOPS_OPTIMIZATION"

	// AdministrativeActionTypeStorageTypeOptimization is a AdministrativeActionType enum value
	AdministrativeActionTypeStorageTypeOptimization = "STORAGE_TYPE_OPTIMIZATION"

	// AdministrativeActionTypeMisconfiguredStateRecovery is a AdministrativeActionType enum value
	AdministrativeActionTypeMisconfiguredStateRecovery = "MISCONFIGURED_STATE_RECOVERY"

	// AdministrativeActionTypeVolumeUpdateWithSnapshot is a AdministrativeActionType enum value
	AdministrativeActionTypeVolumeUpdateWithSnapshot = "VOLUME_UPDATE_WITH_SNAPSHOT"

	// AdministrativeActionTypeVolumeInitializeWithSnapshot is a AdministrativeActionType enum value
	AdministrativeActionTypeVolumeInitializeWithSnapshot = "VOLUME_INITIALIZE_WITH_SNAPSHOT"

	// AdministrativeActionTypeDownloadDataFromBackup is a AdministrativeActionType enum value
	AdministrativeActionTypeDownloadDataFromBackup = "DOWNLOAD_DATA_FROM_BACKUP"
)

Describes the type of administrative action, as follows:

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

  • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts. You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html) in the Amazon FSx for Windows File Server User Guide.

  • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts. For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer 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 has been completed 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, Managing storage capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html) in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html) in the Amazon FSx for NetApp ONTAP User Guide.

  • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases (https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html).

  • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html).

  • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts. You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-provisioned-ssd-iops.html) in the Amazon FSx for Windows File Server User Guide.

  • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts. You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

  • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

  • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

  • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

  • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

  • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

  • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

  • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

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"

	// AutoImportPolicyTypeNewChangedDeleted is a AutoImportPolicyType enum value
	AutoImportPolicyTypeNewChangedDeleted = "NEW_CHANGED_DELETED"
)
View Source 
const (
	// AutocommitPeriodTypeMinutes is a AutocommitPeriodType enum value
	AutocommitPeriodTypeMinutes = "MINUTES"

	// AutocommitPeriodTypeHours is a AutocommitPeriodType enum value
	AutocommitPeriodTypeHours = "HOURS"

	// AutocommitPeriodTypeDays is a AutocommitPeriodType enum value
	AutocommitPeriodTypeDays = "DAYS"

	// AutocommitPeriodTypeMonths is a AutocommitPeriodType enum value
	AutocommitPeriodTypeMonths = "MONTHS"

	// AutocommitPeriodTypeYears is a AutocommitPeriodType enum value
	AutocommitPeriodTypeYears = "YEARS"

	// AutocommitPeriodTypeNone is a AutocommitPeriodType enum value
	AutocommitPeriodTypeNone = "NONE"
)
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 hasn't started creating the backup.

  • CREATING - Amazon FSx is creating the new user-initiated 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's no longer available.

  • FAILED - Amazon FSx couldn't finish 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"

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

	// DataRepositoryTaskFilterNameTaskLifecycle is a DataRepositoryTaskFilterName enum value
	DataRepositoryTaskFilterNameTaskLifecycle = "task-lifecycle"

	// DataRepositoryTaskFilterNameDataRepositoryAssociationId is a DataRepositoryTaskFilterName enum value
	DataRepositoryTaskFilterNameDataRepositoryAssociationId = "data-repository-association-id"

	// DataRepositoryTaskFilterNameFileCacheId is a DataRepositoryTaskFilterName enum value
	DataRepositoryTaskFilterNameFileCacheId = "file-cache-id"
)
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 (
	// DataRepositoryTaskTypeExportToRepository is a DataRepositoryTaskType enum value
	DataRepositoryTaskTypeExportToRepository = "EXPORT_TO_REPOSITORY"

	// DataRepositoryTaskTypeImportMetadataFromRepository is a DataRepositoryTaskType enum value
	DataRepositoryTaskTypeImportMetadataFromRepository = "IMPORT_METADATA_FROM_REPOSITORY"

	// DataRepositoryTaskTypeReleaseDataFromFilesystem is a DataRepositoryTaskType enum value
	DataRepositoryTaskTypeReleaseDataFromFilesystem = "RELEASE_DATA_FROM_FILESYSTEM"

	// DataRepositoryTaskTypeAutoReleaseData is a DataRepositoryTaskType enum value
	DataRepositoryTaskTypeAutoReleaseData = "AUTO_RELEASE_DATA"
)
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 (
	// EventTypeNew is a EventType enum value
	EventTypeNew = "NEW"

	// EventTypeChanged is a EventType enum value
	EventTypeChanged = "CHANGED"

	// EventTypeDeleted is a EventType enum value
	EventTypeDeleted = "DELETED"
)
View Source 
const (
	// FileCacheLifecycleAvailable is a FileCacheLifecycle enum value
	FileCacheLifecycleAvailable = "AVAILABLE"

	// FileCacheLifecycleCreating is a FileCacheLifecycle enum value
	FileCacheLifecycleCreating = "CREATING"

	// FileCacheLifecycleDeleting is a FileCacheLifecycle enum value
	FileCacheLifecycleDeleting = "DELETING"

	// FileCacheLifecycleUpdating is a FileCacheLifecycle enum value
	FileCacheLifecycleUpdating = "UPDATING"

	// FileCacheLifecycleFailed is a FileCacheLifecycle enum value
	FileCacheLifecycleFailed = "FAILED"
)
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"

	// FileSystemLifecycleMisconfiguredUnavailable is a FileSystemLifecycle enum value
	FileSystemLifecycleMisconfiguredUnavailable = "MISCONFIGURED_UNAVAILABLE"
)

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"

	// FileSystemTypeOpenzfs is a FileSystemType enum value
	FileSystemTypeOpenzfs = "OPENZFS"
)

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"

	// FilterNameDataRepositoryType is a FilterName enum value
	FilterNameDataRepositoryType = "data-repository-type"

	// FilterNameFileCacheId is a FilterName enum value
	FilterNameFileCacheId = "file-cache-id"

	// FilterNameFileCacheType is a FilterName enum value
	FilterNameFileCacheType = "file-cache-type"
)

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 (
	// InputOntapVolumeTypeRw is a InputOntapVolumeType enum value
	InputOntapVolumeTypeRw = "RW"

	// InputOntapVolumeTypeDp is a InputOntapVolumeType enum value
	InputOntapVolumeTypeDp = "DP"
)
View Source 
const (
	// LustreAccessAuditLogLevelDisabled is a LustreAccessAuditLogLevel enum value
	LustreAccessAuditLogLevelDisabled = "DISABLED"

	// LustreAccessAuditLogLevelWarnOnly is a LustreAccessAuditLogLevel enum value
	LustreAccessAuditLogLevelWarnOnly = "WARN_ONLY"

	// LustreAccessAuditLogLevelErrorOnly is a LustreAccessAuditLogLevel enum value
	LustreAccessAuditLogLevelErrorOnly = "ERROR_ONLY"

	// LustreAccessAuditLogLevelWarnError is a LustreAccessAuditLogLevel enum value
	LustreAccessAuditLogLevelWarnError = "WARN_ERROR"
)
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"

	// LustreDeploymentTypePersistent2 is a LustreDeploymentType enum value
	LustreDeploymentTypePersistent2 = "PERSISTENT_2"
)
View Source 
const (
	// MetadataConfigurationModeAutomatic is a MetadataConfigurationMode enum value
	MetadataConfigurationModeAutomatic = "AUTOMATIC"

	// MetadataConfigurationModeUserProvisioned is a MetadataConfigurationMode enum value
	MetadataConfigurationModeUserProvisioned = "USER_PROVISIONED"
)
View Source 
const (
	// OntapDeploymentTypeMultiAz1 is a OntapDeploymentType enum value
	OntapDeploymentTypeMultiAz1 = "MULTI_AZ_1"

	// OntapDeploymentTypeSingleAz1 is a OntapDeploymentType enum value
	OntapDeploymentTypeSingleAz1 = "SINGLE_AZ_1"

	// OntapDeploymentTypeSingleAz2 is a OntapDeploymentType enum value
	OntapDeploymentTypeSingleAz2 = "SINGLE_AZ_2"

	// OntapDeploymentTypeMultiAz2 is a OntapDeploymentType enum value
	OntapDeploymentTypeMultiAz2 = "MULTI_AZ_2"
)
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 (
	// OpenZFSCopyStrategyClone is a OpenZFSCopyStrategy enum value
	OpenZFSCopyStrategyClone = "CLONE"

	// OpenZFSCopyStrategyFullCopy is a OpenZFSCopyStrategy enum value
	OpenZFSCopyStrategyFullCopy = "FULL_COPY"

	// OpenZFSCopyStrategyIncrementalCopy is a OpenZFSCopyStrategy enum value
	OpenZFSCopyStrategyIncrementalCopy = "INCREMENTAL_COPY"
)
View Source 
const (
	// OpenZFSDataCompressionTypeNone is a OpenZFSDataCompressionType enum value
	OpenZFSDataCompressionTypeNone = "NONE"

	// OpenZFSDataCompressionTypeZstd is a OpenZFSDataCompressionType enum value
	OpenZFSDataCompressionTypeZstd = "ZSTD"

	// OpenZFSDataCompressionTypeLz4 is a OpenZFSDataCompressionType enum value
	OpenZFSDataCompressionTypeLz4 = "LZ4"
)
View Source 
const (
	// OpenZFSDeploymentTypeSingleAz1 is a OpenZFSDeploymentType enum value
	OpenZFSDeploymentTypeSingleAz1 = "SINGLE_AZ_1"

	// OpenZFSDeploymentTypeSingleAz2 is a OpenZFSDeploymentType enum value
	OpenZFSDeploymentTypeSingleAz2 = "SINGLE_AZ_2"

	// OpenZFSDeploymentTypeSingleAzHa1 is a OpenZFSDeploymentType enum value
	OpenZFSDeploymentTypeSingleAzHa1 = "SINGLE_AZ_HA_1"

	// OpenZFSDeploymentTypeSingleAzHa2 is a OpenZFSDeploymentType enum value
	OpenZFSDeploymentTypeSingleAzHa2 = "SINGLE_AZ_HA_2"

	// OpenZFSDeploymentTypeMultiAz1 is a OpenZFSDeploymentType enum value
	OpenZFSDeploymentTypeMultiAz1 = "MULTI_AZ_1"
)
View Source 
const (
	// OpenZFSQuotaTypeUser is a OpenZFSQuotaType enum value
	OpenZFSQuotaTypeUser = "USER"

	// OpenZFSQuotaTypeGroup is a OpenZFSQuotaType enum value
	OpenZFSQuotaTypeGroup = "GROUP"
)
View Source 
const (
	// PrivilegedDeleteDisabled is a PrivilegedDelete enum value
	PrivilegedDeleteDisabled = "DISABLED"

	// PrivilegedDeleteEnabled is a PrivilegedDelete enum value
	PrivilegedDeleteEnabled = "ENABLED"

	// PrivilegedDeletePermanentlyDisabled is a PrivilegedDelete enum value
	PrivilegedDeletePermanentlyDisabled = "PERMANENTLY_DISABLED"
)
View Source 
const (
	// ResourceTypeFileSystem is a ResourceType enum value
	ResourceTypeFileSystem = "FILE_SYSTEM"

	// ResourceTypeVolume is a ResourceType enum value
	ResourceTypeVolume = "VOLUME"
)
View Source 
const (
	// RestoreOpenZFSVolumeOptionDeleteIntermediateSnapshots is a RestoreOpenZFSVolumeOption enum value
	RestoreOpenZFSVolumeOptionDeleteIntermediateSnapshots = "DELETE_INTERMEDIATE_SNAPSHOTS"

	// RestoreOpenZFSVolumeOptionDeleteClonedVolumes is a RestoreOpenZFSVolumeOption enum value
	RestoreOpenZFSVolumeOptionDeleteClonedVolumes = "DELETE_CLONED_VOLUMES"
)
View Source 
const (
	// RetentionPeriodTypeSeconds is a RetentionPeriodType enum value
	RetentionPeriodTypeSeconds = "SECONDS"

	// RetentionPeriodTypeMinutes is a RetentionPeriodType enum value
	RetentionPeriodTypeMinutes = "MINUTES"

	// RetentionPeriodTypeHours is a RetentionPeriodType enum value
	RetentionPeriodTypeHours = "HOURS"

	// RetentionPeriodTypeDays is a RetentionPeriodType enum value
	RetentionPeriodTypeDays = "DAYS"

	// RetentionPeriodTypeMonths is a RetentionPeriodType enum value
	RetentionPeriodTypeMonths = "MONTHS"

	// RetentionPeriodTypeYears is a RetentionPeriodType enum value
	RetentionPeriodTypeYears = "YEARS"

	// RetentionPeriodTypeInfinite is a RetentionPeriodType enum value
	RetentionPeriodTypeInfinite = "INFINITE"

	// RetentionPeriodTypeUnspecified is a RetentionPeriodType enum value
	RetentionPeriodTypeUnspecified = "UNSPECIFIED"
)
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"

	// ServiceLimitFileCacheCount is a ServiceLimit enum value
	ServiceLimitFileCacheCount = "FILE_CACHE_COUNT"
)

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 (
	// SnaplockTypeCompliance is a SnaplockType enum value
	SnaplockTypeCompliance = "COMPLIANCE"

	// SnaplockTypeEnterprise is a SnaplockType enum value
	SnaplockTypeEnterprise = "ENTERPRISE"
)
View Source 
const (
	// SnapshotFilterNameFileSystemId is a SnapshotFilterName enum value
	SnapshotFilterNameFileSystemId = "file-system-id"

	// SnapshotFilterNameVolumeId is a SnapshotFilterName enum value
	SnapshotFilterNameVolumeId = "volume-id"
)
View Source 
const (
	// SnapshotLifecyclePending is a SnapshotLifecycle enum value
	SnapshotLifecyclePending = "PENDING"

	// SnapshotLifecycleCreating is a SnapshotLifecycle enum value
	SnapshotLifecycleCreating = "CREATING"

	// SnapshotLifecycleDeleting is a SnapshotLifecycle enum value
	SnapshotLifecycleDeleting = "DELETING"

	// SnapshotLifecycleAvailable is a SnapshotLifecycle enum value
	SnapshotLifecycleAvailable = "AVAILABLE"
)
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"

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

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

Specifies the file system's storage type.

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 (
	// UpdateOpenZFSVolumeOptionDeleteIntermediateSnapshots is a UpdateOpenZFSVolumeOption enum value
	UpdateOpenZFSVolumeOptionDeleteIntermediateSnapshots = "DELETE_INTERMEDIATE_SNAPSHOTS"

	// UpdateOpenZFSVolumeOptionDeleteClonedVolumes is a UpdateOpenZFSVolumeOption enum value
	UpdateOpenZFSVolumeOptionDeleteClonedVolumes = "DELETE_CLONED_VOLUMES"

	// UpdateOpenZFSVolumeOptionDeleteIntermediateData is a UpdateOpenZFSVolumeOption enum value
	UpdateOpenZFSVolumeOptionDeleteIntermediateData = "DELETE_INTERMEDIATE_DATA"
)
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"

	// VolumeLifecycleAvailable is a VolumeLifecycle enum value
	VolumeLifecycleAvailable = "AVAILABLE"
)
View Source 
const (
	// VolumeStyleFlexvol is a VolumeStyle enum value
	VolumeStyleFlexvol = "FLEXVOL"

	// VolumeStyleFlexgroup is a VolumeStyle enum value
	VolumeStyleFlexgroup = "FLEXGROUP"
)
View Source 
const (
	// VolumeTypeOntap is a VolumeType enum value
	VolumeTypeOntap = "ONTAP"

	// VolumeTypeOpenzfs is a VolumeType enum value
	VolumeTypeOpenzfs = "OPENZFS"
)
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"

	// ErrCodeDataRepositoryAssociationNotFound for service response error code
	// "DataRepositoryAssociationNotFound".
	//
	// No data repository associations were found based upon the supplied parameters.
	ErrCodeDataRepositoryAssociationNotFound = "DataRepositoryAssociationNotFound"

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

	// ErrCodeFileCacheNotFound for service response error code
	// "FileCacheNotFound".
	//
	// No caches were found based upon supplied parameters.
	ErrCodeFileCacheNotFound = "FileCacheNotFound"

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

	// ErrCodeInvalidDataRepositoryType for service response error code
	// "InvalidDataRepositoryType".
	//
	// You have filtered the response to a data repository type that is not supported.
	ErrCodeInvalidDataRepositoryType = "InvalidDataRepositoryType"

	// ErrCodeInvalidDestinationKmsKey for service response error code
	// "InvalidDestinationKmsKey".
	//
	// The Key Management Service (KMS) key of the destination backup is not valid.
	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 SourceRegion is not valid 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 not valid.
	ErrCodeInvalidSourceKmsKey = "InvalidSourceKmsKey"

	// ErrCodeMissingFileCacheConfiguration for service response error code
	// "MissingFileCacheConfiguration".
	//
	// A cache configuration is required for this operation.
	ErrCodeMissingFileCacheConfiguration = "MissingFileCacheConfiguration"

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

	// ErrCodeSnapshotNotFound for service response error code
	// "SnapshotNotFound".
	//
	// No Amazon FSx snapshots were found based on the supplied parameters.
	ErrCodeSnapshotNotFound = "SnapshotNotFound"

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

	// ErrCodeStorageVirtualMachineNotFound for service response error code
	// "StorageVirtualMachineNotFound".
	//
	// No FSx for 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 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 (
	// DeleteFileSystemOpenZFSOptionDeleteChildVolumesAndSnapshots is a DeleteFileSystemOpenZFSOption enum value
	DeleteFileSystemOpenZFSOptionDeleteChildVolumesAndSnapshots = "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"
)
View Source 
const (
	// DeleteOpenZFSVolumeOptionDeleteChildVolumesAndSnapshots is a DeleteOpenZFSVolumeOption enum value
	DeleteOpenZFSVolumeOptionDeleteChildVolumesAndSnapshots = "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"
)
View Source 
const (
	// FileCacheLustreDeploymentTypeCache1 is a FileCacheLustreDeploymentType enum value
	FileCacheLustreDeploymentTypeCache1 = "CACHE_1"
)
View Source 
const (
	// FileCacheTypeLustre is a FileCacheType enum value
	FileCacheTypeLustre = "LUSTRE"
)
View Source 
const (
	// NfsVersionNfs3 is a NfsVersion enum value
	NfsVersionNfs3 = "NFS3"
)
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 (
	// UnitDays is a Unit enum value
	UnitDays = "DAYS"
)

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

func AutocommitPeriodType_Values() []string

AutocommitPeriodType_Values returns all elements of the AutocommitPeriodType 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 DeleteFileSystemOpenZFSOption_Values added in v1.43.8 

func DeleteFileSystemOpenZFSOption_Values() []string

DeleteFileSystemOpenZFSOption_Values returns all elements of the DeleteFileSystemOpenZFSOption enum

func DeleteOpenZFSVolumeOption_Values added in v1.42.16 

func DeleteOpenZFSVolumeOption_Values() []string

DeleteOpenZFSVolumeOption_Values returns all elements of the DeleteOpenZFSVolumeOption 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 EventType_Values added in v1.42.16 

func EventType_Values() []string

EventType_Values returns all elements of the EventType enum

func FileCacheLifecycle_Values added in v1.44.108 

func FileCacheLifecycle_Values() []string

FileCacheLifecycle_Values returns all elements of the FileCacheLifecycle enum

func FileCacheLustreDeploymentType_Values added in v1.44.108 

func FileCacheLustreDeploymentType_Values() []string

FileCacheLustreDeploymentType_Values returns all elements of the FileCacheLustreDeploymentType enum

func FileCacheType_Values added in v1.44.108 

func FileCacheType_Values() []string

FileCacheType_Values returns all elements of the FileCacheType 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 InputOntapVolumeType_Values added in v1.44.147 

func InputOntapVolumeType_Values() []string

InputOntapVolumeType_Values returns all elements of the InputOntapVolumeType enum

func LustreAccessAuditLogLevel_Values added in v1.42.16 

func LustreAccessAuditLogLevel_Values() []string

LustreAccessAuditLogLevel_Values returns all elements of the LustreAccessAuditLogLevel enum

func LustreDeploymentType_Values added in v1.34.3 

func LustreDeploymentType_Values() []string

LustreDeploymentType_Values returns all elements of the LustreDeploymentType enum

func MetadataConfigurationMode_Values added in v1.53.18 

func MetadataConfigurationMode_Values() []string

MetadataConfigurationMode_Values returns all elements of the MetadataConfigurationMode enum

func NfsVersion_Values added in v1.44.108 

func NfsVersion_Values() []string

NfsVersion_Values returns all elements of the NfsVersion 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 OpenZFSCopyStrategy_Values added in v1.42.16 

func OpenZFSCopyStrategy_Values() []string

OpenZFSCopyStrategy_Values returns all elements of the OpenZFSCopyStrategy enum

func OpenZFSDataCompressionType_Values added in v1.42.16 

func OpenZFSDataCompressionType_Values() []string

OpenZFSDataCompressionType_Values returns all elements of the OpenZFSDataCompressionType enum

func OpenZFSDeploymentType_Values added in v1.42.16 

func OpenZFSDeploymentType_Values() []string

OpenZFSDeploymentType_Values returns all elements of the OpenZFSDeploymentType enum

func OpenZFSQuotaType_Values added in v1.42.16 

func OpenZFSQuotaType_Values() []string

OpenZFSQuotaType_Values returns all elements of the OpenZFSQuotaType enum

func PrivilegedDelete_Values added in v1.44.300 

func PrivilegedDelete_Values() []string

PrivilegedDelete_Values returns all elements of the PrivilegedDelete 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 RestoreOpenZFSVolumeOption_Values added in v1.42.16 

func RestoreOpenZFSVolumeOption_Values() []string

RestoreOpenZFSVolumeOption_Values returns all elements of the RestoreOpenZFSVolumeOption enum

func RetentionPeriodType_Values added in v1.44.300 

func RetentionPeriodType_Values() []string

RetentionPeriodType_Values returns all elements of the RetentionPeriodType 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 SnaplockType_Values added in v1.44.300 

func SnaplockType_Values() []string

SnaplockType_Values returns all elements of the SnaplockType enum

func SnapshotFilterName_Values added in v1.42.16 

func SnapshotFilterName_Values() []string

SnapshotFilterName_Values returns all elements of the SnapshotFilterName enum

func SnapshotLifecycle_Values added in v1.42.16 

func SnapshotLifecycle_Values() []string

SnapshotLifecycle_Values returns all elements of the SnapshotLifecycle 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 Unit_Values added in v1.44.320 

func Unit_Values() []string

Unit_Values returns all elements of the Unit enum

func UpdateOpenZFSVolumeOption_Values added in v1.48.4 

func UpdateOpenZFSVolumeOption_Values() []string

UpdateOpenZFSVolumeOption_Values returns all elements of the UpdateOpenZFSVolumeOption 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 VolumeStyle_Values added in v1.48.4 

func VolumeStyle_Values() []string

VolumeStyle_Values returns all elements of the VolumeStyle 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 Active Directory 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 Active Directory 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
	//    from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
	//
	//    * THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase
	//    a file system's throughput capacity has been completed successfully, a
	//    THROUGHPUT_OPTIMIZATION task starts. You can track the storage-optimization
	//    progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION
	//    has been completed successfully, the parent FILE_SYSTEM_UPDATE action
	//    status changes to COMPLETED. For more information, see Managing throughput
	//    capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html)
	//    in the Amazon FSx for Windows File Server User Guide.
	//
	//    * STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase
	//    a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION
	//    task starts. For Windows and ONTAP, storage optimization is the process
	//    of migrating the file system data to newer 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 has been
	//    completed 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, Managing storage
	//    capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html)
	//    in the Amazon FSx for Lustre User Guide, and Managing storage capacity
	//    and provisioned IOPS (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html)
	//    in the Amazon FSx for NetApp ONTAP User Guide.
	//
	//    * FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a
	//    new Domain Name System (DNS) alias with the file system. For more information,
	//    see AssociateFileSystemAliases (https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html).
	//
	//    * FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate
	//    a DNS alias from the file system. For more information, see DisassociateFileSystemAliases
	//    (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html).
	//
	//    * IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a
	//    file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION
	//    task starts. You can track the storage-optimization progress using the
	//    ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully,
	//    the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For
	//    more information, see Managing provisioned SSD IOPS (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-provisioned-ssd-iops.html)
	//    in the Amazon FSx for Windows File Server User Guide.
	//
	//    * STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase
	//    a file system's throughput capacity has been completed successfully, a
	//    STORAGE_TYPE_OPTIMIZATION task starts. You can track the storage-optimization
	//    progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION
	//    has been completed successfully, the parent FILE_SYSTEM_UPDATE action
	//    status changes to COMPLETED.
	//
	//    * VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume
	//    initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).
	//
	//    * VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the
	//    state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot)
	//    or CLI (restore-volume-from-snapshot).
	//
	//    * SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume
	//    initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).
	//
	//    * RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS)
	//    V3 locks on an Amazon FSx for OpenZFS file system.
	//
	//    * DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored
	//    to a new volume on a second-generation file system. Once the all the file
	//    metadata is loaded onto the volume, you can mount the volume with read-only
	//    access. during this process.
	//
	//    * VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot
	//    on a different FSx for OpenZFS file system. You can initiate this from
	//    the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when
	//    using the using the FULL_COPY strategy.
	//
	//    * VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot
	//    on a different FSx for OpenZFS file system. You can initiate this from
	//    the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).
	AdministrativeActionType *string `type:"string" enum:"AdministrativeActionType"`

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

	// The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP
	// administrative action. Does not apply to any other administrative action
	// type.
	ProgressPercent *int64 `type:"integer"`

	// The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're
	// copying.
	RemainingTransferBytes *int64 `type:"long"`

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

	// 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.
	//    For a backup restore to a second-generation FSx for ONTAP file system,
	//    indicates that all data has been downloaded to the volume, and clients
	//    now have read-write access to volume.
	//
	//    * 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.
	//
	//    * PENDING - For a backup restore to a second-generation FSx for ONTAP
	//    file system, indicates that the file metadata is being downloaded onto
	//    the volume. The volume's Lifecycle state is CREATING.
	//
	//    * IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP
	//    file system, indicates that all metadata has been downloaded to the new
	//    volume and client can access data with read-only access while Amazon FSx
	//    downloads the file data to the volume. Track the progress of this process
	//    with the ProgressPercent element.
	Status *string `type:"string" enum:"Status"`

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

	// A snapshot of an Amazon FSx for OpenZFS volume.
	TargetSnapshotValues *Snapshot `type:"structure"`

	// Describes an Amazon FSx volume.
	TargetVolumeValues *Volume `type:"structure"`

	// The number of bytes that have transferred for the FSx for OpenZFS snapshot
	// that you're copying.
	TotalTransferBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

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

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) SetRemainingTransferBytes added in v1.48.4 

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

SetRemainingTransferBytes sets the RemainingTransferBytes 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) SetTargetSnapshotValues added in v1.42.16 

func (s *AdministrativeAction) SetTargetSnapshotValues(v *Snapshot) *AdministrativeAction

SetTargetSnapshotValues sets the TargetSnapshotValues 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) SetTotalTransferBytes added in v1.48.4 

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

SetTotalTransferBytes sets the TotalTransferBytes 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 AggregateConfiguration added in v1.48.4 

type AggregateConfiguration struct {

	// The list of aggregates that this volume resides on. Aggregates are storage
	// pools which make up your primary storage tier. Each high-availability (HA)
	// pair has one aggregate. The names of the aggregates map to the names of the
	// aggregates in the ONTAP CLI and REST API. For FlexVols, there will always
	// be a single entry.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The strings in the value of Aggregates are not are not formatted as
	//    aggrX, where X is a number between 1 and 12.
	//
	//    * The value of Aggregates contains aggregates that are not present.
	//
	//    * One or more of the aggregates supplied are too close to the volume limit
	//    to support adding more volumes.
	Aggregates []*string `type:"list"`

	// The total number of constituents this FlexGroup volume has. Not applicable
	// for FlexVols.
	TotalConstituents *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Used to specify configuration options for a volume’s storage aggregate or aggregates.

func (AggregateConfiguration) GoString added in v1.48.4 

func (s AggregateConfiguration) 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 (*AggregateConfiguration) SetAggregates added in v1.48.4 

func (s *AggregateConfiguration) SetAggregates(v []*string) *AggregateConfiguration

SetAggregates sets the Aggregates field's value.

func (*AggregateConfiguration) SetTotalConstituents added in v1.48.4 

func (s *AggregateConfiguration) SetTotalConstituents(v int64) *AggregateConfiguration

SetTotalConstituents sets the TotalConstituents field's value.

func (AggregateConfiguration) String added in v1.48.4 

func (s AggregateConfiguration) 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 63 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 AutoExportPolicy added in v1.42.16 

type AutoExportPolicy struct {

	// The AutoExportPolicy can have the following event values:
	//
	//    * NEW - New files and directories are automatically exported to the data
	//    repository as they are added to the file system.
	//
	//    * CHANGED - Changes to files and directories on the file system are automatically
	//    exported to the data repository.
	//
	//    * DELETED - Files and directories are automatically deleted on the data
	//    repository when they are deleted on the file system.
	//
	// You can define any combination of event types for your AutoExportPolicy.
	Events []*string `type:"list" enum:"EventType"`
	// contains filtered or unexported fields
}

Describes a data repository association's automatic export policy. The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.

The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

func (AutoExportPolicy) GoString added in v1.42.16 

func (s AutoExportPolicy) 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 (*AutoExportPolicy) SetEvents added in v1.42.16 

func (s *AutoExportPolicy) SetEvents(v []*string) *AutoExportPolicy

SetEvents sets the Events field's value.

func (AutoExportPolicy) String added in v1.42.16 

func (s AutoExportPolicy) 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 AutoImportPolicy added in v1.42.16 

type AutoImportPolicy struct {

	// The AutoImportPolicy can have the following event values:
	//
	//    * NEW - Amazon FSx automatically imports metadata of files added to the
	//    linked S3 bucket that do not currently exist in the FSx file system.
	//
	//    * CHANGED - Amazon FSx automatically updates file metadata and invalidates
	//    existing file content on the file system as files change in the data repository.
	//
	//    * DELETED - Amazon FSx automatically deletes files on the file system
	//    as corresponding files are deleted in the data repository.
	//
	// You can define any combination of event types for your AutoImportPolicy.
	Events []*string `type:"list" enum:"EventType"`
	// contains filtered or unexported fields
}

Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.

The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

func (AutoImportPolicy) GoString added in v1.42.16 

func (s AutoImportPolicy) 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 (*AutoImportPolicy) SetEvents added in v1.42.16 

func (s *AutoImportPolicy) SetEvents(v []*string) *AutoImportPolicy

SetEvents sets the Events field's value.

func (AutoImportPolicy) String added in v1.42.16 

func (s AutoImportPolicy) 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 AutocommitPeriod added in v1.44.300 

type AutocommitPeriod struct {

	// Defines the type of time for the autocommit period of a file in an FSx for
	// ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The
	// default value is NONE.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"AutocommitPeriodType"`

	// Defines the amount of time for the autocommit period of a file in an FSx
	// for ONTAP SnapLock volume. The following ranges are valid:
	//
	//    * Minutes: 5 - 65,535
	//
	//    * Hours: 1 - 65,535
	//
	//    * Days: 1 - 3,650
	//
	//    * Months: 1 - 120
	//
	//    * Years: 1 - 10
	Value *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Sets the autocommit period of files in an FSx for ONTAP SnapLock volume, which determines how long the files must remain unmodified before they're automatically transitioned to the write once, read many (WORM) state.

For more information, see Autocommit (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-autocommit).

func (AutocommitPeriod) GoString added in v1.44.300 

func (s AutocommitPeriod) 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 (*AutocommitPeriod) SetType added in v1.44.300 

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

SetType sets the Type field's value.

func (*AutocommitPeriod) SetValue added in v1.44.300 

func (s *AutocommitPeriod) SetValue(v int64) *AutocommitPeriod

SetValue sets the Value field's value.

func (AutocommitPeriod) String added in v1.44.300 

func (s AutocommitPeriod) 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 (*AutocommitPeriod) Validate added in v1.44.300 

func (s *AutocommitPeriod) Validate() error

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

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 directory
	// to which the Windows File Server instance is joined.
	DirectoryInformation *ActiveDirectoryBackupAttributes `type:"structure"`

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

	// The 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 hasn't 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 Amazon S3.
	//
	//    * COPYING - Amazon FSx is copying the backup.
	//
	//    * DELETED - Amazon FSx deleted the backup and it's no longer available.
	//
	//    * FAILED - Amazon FSx couldn't finish 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"`

	// Displays 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's backed up.
	ResourceType *string `type:"string" enum:"ResourceType"`

	// The ID of the source backup. Specifies the backup that 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"`

	// The 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 volume.
	Volume *Volume `type:"structure"`
	// contains filtered or unexported fields
}

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

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 that 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.
	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 63 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"`

	// Specifies the ID of the Key Management Service (KMS) key to use for encrypting
	// data on Amazon FSx file systems, as follows:
	//
	//    * Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types
	//    only. SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx
	//    service KMS key for your account.
	//
	//    * Amazon FSx for NetApp ONTAP
	//
	//    * Amazon FSx for OpenZFS
	//
	//    * Amazon FSx for Windows File Server
	//
	// If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account
	// is used. For more information, see Encrypt (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's 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, SourceRegion 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, Amazon FSx for Lustre
	// file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS
	// file system.
	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 CopySnapshotAndUpdateVolumeInput added in v1.48.4 

type CopySnapshotAndUpdateVolumeInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 strategy to use when copying data from a snapshot to the volume.
	//
	//    * FULL_COPY - Copies all data from the snapshot to the volume.
	//
	//    * INCREMENTAL_COPY - Copies only the snapshot data that's changed since
	//    the previous replication.
	//
	// CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume
	// operation.
	CopyStrategy *string `type:"string" enum:"OpenZFSCopyStrategy"`

	// Confirms that you want to delete data on the destination volume that wasn’t
	// there during the previous snapshot replication.
	//
	// Your replication will fail if you don’t include an option for a specific
	// type of data and that data is on your destination. For example, if you don’t
	// include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots
	// on the destination, you can’t copy the snapshot.
	//
	//    * DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination
	//    volume that aren’t on the source volume.
	//
	//    * DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume
	//    that aren't on the source volume.
	//
	//    * DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume
	//    that don’t match the source snapshot that you’re copying.
	Options []*string `type:"list" enum:"UpdateOpenZFSVolumeOption"`

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

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

func (CopySnapshotAndUpdateVolumeInput) GoString added in v1.48.4 

func (s CopySnapshotAndUpdateVolumeInput) 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 (*CopySnapshotAndUpdateVolumeInput) SetClientRequestToken added in v1.48.4 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CopySnapshotAndUpdateVolumeInput) SetCopyStrategy added in v1.48.4 

func (s *CopySnapshotAndUpdateVolumeInput) SetCopyStrategy(v string) *CopySnapshotAndUpdateVolumeInput

SetCopyStrategy sets the CopyStrategy field's value.

func (*CopySnapshotAndUpdateVolumeInput) SetOptions added in v1.48.4 

func (s *CopySnapshotAndUpdateVolumeInput) SetOptions(v []*string) *CopySnapshotAndUpdateVolumeInput

SetOptions sets the Options field's value.

func (*CopySnapshotAndUpdateVolumeInput) SetSourceSnapshotARN added in v1.48.4 

func (s *CopySnapshotAndUpdateVolumeInput) SetSourceSnapshotARN(v string) *CopySnapshotAndUpdateVolumeInput

SetSourceSnapshotARN sets the SourceSnapshotARN field's value.

func (*CopySnapshotAndUpdateVolumeInput) SetVolumeId added in v1.48.4 

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

SetVolumeId sets the VolumeId field's value.

func (CopySnapshotAndUpdateVolumeInput) String added in v1.48.4 

func (s CopySnapshotAndUpdateVolumeInput) 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 (*CopySnapshotAndUpdateVolumeInput) Validate added in v1.48.4 

func (s *CopySnapshotAndUpdateVolumeInput) Validate() error

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

type CopySnapshotAndUpdateVolumeOutput added in v1.48.4 

type CopySnapshotAndUpdateVolumeOutput 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 system.
	AdministrativeActions []*AdministrativeAction `type:"list"`

	// The lifecycle state of the destination volume.
	Lifecycle *string `type:"string" enum:"VolumeLifecycle"`

	// The ID of the volume that you copied the snapshot to.
	VolumeId *string `min:"23" type:"string"`
	// contains filtered or unexported fields
}

func (CopySnapshotAndUpdateVolumeOutput) GoString added in v1.48.4 

func (s CopySnapshotAndUpdateVolumeOutput) 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 (*CopySnapshotAndUpdateVolumeOutput) SetAdministrativeActions added in v1.48.4 

func (s *CopySnapshotAndUpdateVolumeOutput) SetAdministrativeActions(v []*AdministrativeAction) *CopySnapshotAndUpdateVolumeOutput

SetAdministrativeActions sets the AdministrativeActions field's value.

func (*CopySnapshotAndUpdateVolumeOutput) SetLifecycle added in v1.48.4 

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

SetLifecycle sets the Lifecycle field's value.

func (*CopySnapshotAndUpdateVolumeOutput) SetVolumeId added in v1.48.4 

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

SetVolumeId sets the VolumeId field's value.

func (CopySnapshotAndUpdateVolumeOutput) String added in v1.48.4 

func (s CopySnapshotAndUpdateVolumeOutput) 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 CreateAggregateConfiguration added in v1.48.4 

type CreateAggregateConfiguration struct {

	// Used to specify the names of aggregates on which the volume will be created.
	Aggregates []*string `type:"list"`

	// Used to explicitly set the number of constituents within the FlexGroup per
	// storage aggregate. This field is optional when creating a FlexGroup volume.
	// If unspecified, the default value will be 8. This field cannot be provided
	// when creating a FlexVol volume.
	ConstituentsPerAggregate *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.

func (CreateAggregateConfiguration) GoString added in v1.48.4 

func (s CreateAggregateConfiguration) 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 (*CreateAggregateConfiguration) SetAggregates added in v1.48.4 

func (s *CreateAggregateConfiguration) SetAggregates(v []*string) *CreateAggregateConfiguration

SetAggregates sets the Aggregates field's value.

func (*CreateAggregateConfiguration) SetConstituentsPerAggregate added in v1.48.4 

func (s *CreateAggregateConfiguration) SetConstituentsPerAggregate(v int64) *CreateAggregateConfiguration

SetConstituentsPerAggregate sets the ConstituentsPerAggregate field's value.

func (CreateAggregateConfiguration) String added in v1.48.4 

func (s CreateAggregateConfiguration) 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 (*CreateAggregateConfiguration) Validate added in v1.48.4 

func (s *CreateAggregateConfiguration) Validate() error

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

type CreateBackupInput 

type CreateBackupInput struct {

	// (Optional) A string of up to 63 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
	// operation, no existing file system tags are copied from the file system to
	// the backup.
	Tags []*Tag `min:"1" type:"list"`

	// (Optional) The ID of the FSx for 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 CreateDataRepositoryAssociationInput added in v1.42.16 

type CreateDataRepositoryAssociationInput struct {

	// Set to true to run an import data repository task to import metadata from
	// the data repository to the file system after the data repository association
	// is created. Default is false.
	BatchImportMetaDataOnCreate *bool `type:"boolean"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 path to the Amazon S3 data repository that will be linked to the file
	// system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
	// This path specifies where in the S3 data repository files will be imported
	// from or exported to.
	//
	// DataRepositoryPath is a required field
	DataRepositoryPath *string `min:"3" type:"string" required:"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"`

	// A path on the file system that points to a high-level directory (such as
	// /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with
	// DataRepositoryPath. The leading forward slash in the name is required. Two
	// data repository associations cannot have overlapping file system paths. For
	// example, if a data repository is associated with file system path /ns1/,
	// then you cannot link another data repository with file system path /ns1/ns2.
	//
	// This path specifies where in your file system files will be exported from
	// or imported to. This file system directory can be linked to only one Amazon
	// S3 bucket, and no other S3 bucket can be linked to the directory.
	//
	// If you specify only a forward slash (/) as the file system path, you can
	// link only one data repository to the file system. You can only specify "/"
	// as the file system path for the first data repository associated with a file
	// system.
	FileSystemPath *string `min:"1" 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"`

	// The configuration for an Amazon S3 data repository linked to an Amazon FSx
	// Lustre file system with a data repository association. The configuration
	// defines which file events (new, changed, or deleted files or directories)
	// are automatically imported from the linked data repository to the file system
	// or automatically exported from the file system to the data repository.
	S3 *S3DataRepositoryConfiguration `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 (CreateDataRepositoryAssociationInput) GoString added in v1.42.16 

func (s CreateDataRepositoryAssociationInput) 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 (*CreateDataRepositoryAssociationInput) SetBatchImportMetaDataOnCreate added in v1.42.16 

func (s *CreateDataRepositoryAssociationInput) SetBatchImportMetaDataOnCreate(v bool) *CreateDataRepositoryAssociationInput

SetBatchImportMetaDataOnCreate sets the BatchImportMetaDataOnCreate field's value.

func (*CreateDataRepositoryAssociationInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateDataRepositoryAssociationInput) SetDataRepositoryPath added in v1.42.16 

func (s *CreateDataRepositoryAssociationInput) SetDataRepositoryPath(v string) *CreateDataRepositoryAssociationInput

SetDataRepositoryPath sets the DataRepositoryPath field's value.

func (*CreateDataRepositoryAssociationInput) SetFileSystemId added in v1.42.16 

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

SetFileSystemId sets the FileSystemId field's value.

func (*CreateDataRepositoryAssociationInput) SetFileSystemPath added in v1.42.16 

func (s *CreateDataRepositoryAssociationInput) SetFileSystemPath(v string) *CreateDataRepositoryAssociationInput

SetFileSystemPath sets the FileSystemPath field's value.

func (*CreateDataRepositoryAssociationInput) SetImportedFileChunkSize added in v1.42.16 

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

SetImportedFileChunkSize sets the ImportedFileChunkSize field's value.

func (*CreateDataRepositoryAssociationInput) SetS3 added in v1.42.16 

func (s *CreateDataRepositoryAssociationInput) SetS3(v *S3DataRepositoryConfiguration) *CreateDataRepositoryAssociationInput

SetS3 sets the S3 field's value.

func (*CreateDataRepositoryAssociationInput) SetTags added in v1.42.16 

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

SetTags sets the Tags field's value.

func (CreateDataRepositoryAssociationInput) String added in v1.42.16 

func (s CreateDataRepositoryAssociationInput) 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 (*CreateDataRepositoryAssociationInput) Validate added in v1.42.16 

func (s *CreateDataRepositoryAssociationInput) Validate() error

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

type CreateDataRepositoryAssociationOutput added in v1.42.16 

type CreateDataRepositoryAssociationOutput struct {

	// The response object returned after the data repository association is created.
	Association *DataRepositoryAssociation `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDataRepositoryAssociationOutput) GoString added in v1.42.16 

func (s CreateDataRepositoryAssociationOutput) 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 (*CreateDataRepositoryAssociationOutput) SetAssociation added in v1.42.16 

func (s *CreateDataRepositoryAssociationOutput) SetAssociation(v *DataRepositoryAssociation) *CreateDataRepositoryAssociationOutput

SetAssociation sets the Association field's value.

func (CreateDataRepositoryAssociationOutput) String added in v1.42.16 

func (s CreateDataRepositoryAssociationOutput) 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 {

	// Specifies the amount of data to release, in GiB, by an Amazon File Cache
	// AUTO_RELEASE_DATA task that automatically releases files from the cache.
	CapacityToRelease *int64 `min:"1" type:"long"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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"`

	// A list of paths for the data repository task to use when the task is processed.
	// If a path that you provide isn't valid, the task fails. If you don't provide
	// paths, the default behavior is to export all files to S3 (for export tasks),
	// import all files from S3 (for import tasks), or release all exported files
	// that meet the last accessed time criteria (for release tasks).
	//
	//    * For export tasks, the list contains paths on the FSx for Lustre file
	//    system from which the files are exported to the Amazon S3 bucket. 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.
	//
	//    * For import tasks, the list contains paths in the Amazon S3 bucket from
	//    which POSIX metadata changes are imported to the FSx for Lustre file system.
	//    The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix
	//    (where myPrefix is optional).
	//
	//    * For release tasks, the list contains directory or file paths on the
	//    FSx for Lustre file system from which to release exported files. If a
	//    directory is specified, files within the directory are released. If a
	//    file path is specified, only that file is released. To release all exported
	//    files in the file system, specify a forward slash (/) as the path. A file
	//    must also meet the last accessed time criteria specified in for the file
	//    to be released.
	Paths []*string `type:"list"`

	// The configuration that specifies the last accessed time criteria for files
	// that will be released from an Amazon FSx for Lustre file system.
	ReleaseConfiguration *ReleaseConfiguration `type:"structure"`

	// 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.
	//
	//    * EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file
	//    system to a linked data repository.
	//
	//    * IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a
	//    linked S3 bucket to your Amazon FSx for Lustre file system.
	//
	//    * RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx
	//    for Lustre file system that have been exported to a linked S3 bucket and
	//    that meet your specified release criteria.
	//
	//    * AUTO_RELEASE_DATA tasks automatically release files from an Amazon File
	//    Cache resource.
	//
	// 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) SetCapacityToRelease added in v1.44.108 

func (s *CreateDataRepositoryTaskInput) SetCapacityToRelease(v int64) *CreateDataRepositoryTaskInput

SetCapacityToRelease sets the CapacityToRelease field's value.

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) SetReleaseConfiguration added in v1.44.320 

func (s *CreateDataRepositoryTaskInput) SetReleaseConfiguration(v *ReleaseConfiguration) *CreateDataRepositoryTaskInput

SetReleaseConfiguration sets the ReleaseConfiguration 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 CreateFileCacheInput added in v1.44.108 

type CreateFileCacheInput struct {

	// An idempotency token for resource creation, in a string of up to 63 ASCII
	// characters. This token is automatically filled on your behalf when you use
	// the Command Line Interface (CLI) or an Amazon Web Services SDK.
	//
	// By using the idempotent operation, you can retry a CreateFileCache operation
	// without the risk of creating an extra cache. This approach can be useful
	// when an initial call fails in a way that makes it unclear whether a cache
	// 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 cache, the client receives success as long as the parameters
	// are the same.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A boolean flag indicating whether tags for the cache should be copied to
	// data repository associations. This value defaults to false.
	CopyTagsToDataRepositoryAssociations *bool `type:"boolean"`

	// A list of up to 8 configurations for data repository associations (DRAs)
	// to be created during the cache creation. The DRAs link the cache to either
	// an Amazon S3 data repository or a Network File System (NFS) data repository
	// that supports the NFSv3 protocol.
	//
	// The DRA configurations must meet the following requirements:
	//
	//    * All configurations on the list must be of the same data repository type,
	//    either all S3 or all NFS. A cache can't link to different data repository
	//    types at the same time.
	//
	//    * An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
	//
	// DRA automatic import and automatic export is not supported.
	DataRepositoryAssociations []*FileCacheDataRepositoryAssociation `type:"list"`

	// The type of cache that you're creating, which must be LUSTRE.
	//
	// FileCacheType is a required field
	FileCacheType *string `type:"string" required:"true" enum:"FileCacheType"`

	// Sets the Lustre version for the cache that you're creating, which must be
	// 2.12.
	//
	// FileCacheTypeVersion is a required field
	FileCacheTypeVersion *string `min:"1" type:"string" required:"true"`

	// Specifies the ID of the Key Management Service (KMS) key to use for encrypting
	// data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed
	// KMS key for your account is used. 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 configuration for the Amazon File Cache resource being created.
	LustreConfiguration *CreateFileCacheLustreConfiguration `type:"structure"`

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

	// The storage capacity of the cache in gibibytes (GiB). Valid values are 1200
	// GiB, 2400 GiB, and increments of 2400 GiB.
	//
	// StorageCapacity is a required field
	StorageCapacity *int64 `type:"integer" required:"true"`

	// A list of subnet IDs that the cache will be accessible from. You can specify
	// only one subnet ID in a call to the CreateFileCache operation.
	//
	// SubnetIds is a required field
	SubnetIds []*string `type:"list" required:"true"`

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

func (CreateFileCacheInput) GoString added in v1.44.108 

func (s CreateFileCacheInput) 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 (*CreateFileCacheInput) SetClientRequestToken added in v1.44.108 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateFileCacheInput) SetCopyTagsToDataRepositoryAssociations added in v1.44.108 

func (s *CreateFileCacheInput) SetCopyTagsToDataRepositoryAssociations(v bool) *CreateFileCacheInput

SetCopyTagsToDataRepositoryAssociations sets the CopyTagsToDataRepositoryAssociations field's value.

func (*CreateFileCacheInput) SetDataRepositoryAssociations added in v1.44.108 

func (s *CreateFileCacheInput) SetDataRepositoryAssociations(v []*FileCacheDataRepositoryAssociation) *CreateFileCacheInput

SetDataRepositoryAssociations sets the DataRepositoryAssociations field's value.

func (*CreateFileCacheInput) SetFileCacheType added in v1.44.108 

func (s *CreateFileCacheInput) SetFileCacheType(v string) *CreateFileCacheInput

SetFileCacheType sets the FileCacheType field's value.

func (*CreateFileCacheInput) SetFileCacheTypeVersion added in v1.44.108 

func (s *CreateFileCacheInput) SetFileCacheTypeVersion(v string) *CreateFileCacheInput

SetFileCacheTypeVersion sets the FileCacheTypeVersion field's value.

func (*CreateFileCacheInput) SetKmsKeyId added in v1.44.108 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateFileCacheInput) SetLustreConfiguration added in v1.44.108 

func (s *CreateFileCacheInput) SetLustreConfiguration(v *CreateFileCacheLustreConfiguration) *CreateFileCacheInput

SetLustreConfiguration sets the LustreConfiguration field's value.

func (*CreateFileCacheInput) SetSecurityGroupIds added in v1.44.108 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateFileCacheInput) SetStorageCapacity added in v1.44.108 

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

SetStorageCapacity sets the StorageCapacity field's value.

func (*CreateFileCacheInput) SetSubnetIds added in v1.44.108 

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

SetSubnetIds sets the SubnetIds field's value.

func (*CreateFileCacheInput) SetTags added in v1.44.108 

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

SetTags sets the Tags field's value.

func (CreateFileCacheInput) String added in v1.44.108 

func (s CreateFileCacheInput) 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 (*CreateFileCacheInput) Validate added in v1.44.108 

func (s *CreateFileCacheInput) Validate() error

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

type CreateFileCacheLustreConfiguration added in v1.44.108 

type CreateFileCacheLustreConfiguration struct {

	// Specifies the cache deployment type, which must be CACHE_1.
	//
	// DeploymentType is a required field
	DeploymentType *string `type:"string" required:"true" enum:"FileCacheLustreDeploymentType"`

	// The configuration for a Lustre MDT (Metadata Target) storage volume.
	//
	// MetadataConfiguration is a required field
	MetadataConfiguration *FileCacheLustreMetadataConfiguration `type:"structure" required:"true"`

	// Provisions the amount of read and write throughput for each 1 tebibyte (TiB)
	// of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
	//
	// PerUnitStorageThroughput is a required field
	PerUnitStorageThroughput *int64 `min:"12" 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 Amazon File Cache configuration for the cache that you are creating.

func (CreateFileCacheLustreConfiguration) GoString added in v1.44.108 

func (s CreateFileCacheLustreConfiguration) 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 (*CreateFileCacheLustreConfiguration) SetDeploymentType added in v1.44.108 

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

SetDeploymentType sets the DeploymentType field's value.

func (*CreateFileCacheLustreConfiguration) SetMetadataConfiguration added in v1.44.108 

func (s *CreateFileCacheLustreConfiguration) SetMetadataConfiguration(v *FileCacheLustreMetadataConfiguration) *CreateFileCacheLustreConfiguration

SetMetadataConfiguration sets the MetadataConfiguration field's value.

func (*CreateFileCacheLustreConfiguration) SetPerUnitStorageThroughput added in v1.44.108 

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

SetPerUnitStorageThroughput sets the PerUnitStorageThroughput field's value.

func (*CreateFileCacheLustreConfiguration) SetWeeklyMaintenanceStartTime added in v1.44.108 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (CreateFileCacheLustreConfiguration) String added in v1.44.108 

func (s CreateFileCacheLustreConfiguration) 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 (*CreateFileCacheLustreConfiguration) Validate added in v1.44.108 

func (s *CreateFileCacheLustreConfiguration) Validate() error

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

type CreateFileCacheOutput added in v1.44.108 

type CreateFileCacheOutput struct {

	// A description of the cache that was created.
	FileCache *FileCacheCreating `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateFileCacheOutput) GoString added in v1.44.108 

func (s CreateFileCacheOutput) 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 (*CreateFileCacheOutput) SetFileCache added in v1.44.108 

func (s *CreateFileCacheOutput) SetFileCache(v *FileCacheCreating) *CreateFileCacheOutput

SetFileCache sets the FileCache field's value.

func (CreateFileCacheOutput) String added in v1.44.108 

func (s CreateFileCacheOutput) 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 that you are copying.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// A string of up to 63 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"`

	// Sets the version for the Amazon FSx for Lustre file system that you're creating
	// from a backup. Valid values are 2.10, 2.12, and 2.15.
	//
	// You don't need to specify FileSystemTypeVersion because it will be applied
	// using the backup's FileSystemTypeVersion setting. If you choose to specify
	// FileSystemTypeVersion when creating from backup, the value must match the
	// backup's FileSystemTypeVersion setting.
	FileSystemTypeVersion *string `min:"1" type:"string"`

	// Specifies the ID of the Key Management Service (KMS) key to use for encrypting
	// data on Amazon FSx file systems, as follows:
	//
	//    * Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types
	//    only. SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx
	//    service KMS key for your account.
	//
	//    * Amazon FSx for NetApp ONTAP
	//
	//    * Amazon FSx for OpenZFS
	//
	//    * Amazon FSx for Windows File Server
	//
	// If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account
	// is used. For more information, see Encrypt (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.
	//
	// The following parameters are not supported for file systems with a data repository
	// association created with .
	//
	//    * AutoImportPolicy
	//
	//    * ExportPath
	//
	//    * ImportedFileChunkSize
	//
	//    * ImportPath
	LustreConfiguration *CreateFileSystemLustreConfiguration `type:"structure"`

	// The OpenZFS configuration for the file system that's being created.
	OpenZFSConfiguration *CreateFileSystemOpenZFSConfiguration `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 capacity of the OpenZFS file system that you're creating
	// from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288
	// GiB (512 TiB). However, the value that you specify must be equal to or greater
	// than the backup's storage capacity value. If you don't use the StorageCapacity
	// parameter, the default is the backup's StorageCapacity value.
	//
	// If used to create a file system other than OpenZFS, you must provide a value
	// that matches the backup's StorageCapacity value. If you provide any other
	// value, Amazon FSx responds with with an HTTP status code 400 Bad Request.
	StorageCapacity *int64 `type:"integer"`

	// Sets the storage type for the Windows or OpenZFS file system that you're
	// creating from a backup. Valid values are SSD and HDD.
	//
	//    * Set to SSD to use solid state drive storage. SSD is supported on all
	//    Windows and OpenZFS deployment types.
	//
	//    * Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2
	//    and MULTI_AZ_1 FSx for Windows File Server file system deployment types.
	//
	// The default value is SSD.
	//
	// HDD and SSD storage types have different minimum storage capacity requirements.
	// A restored file system's storage capacity is tied to the file system that
	// was backed up. You can create a file system that uses HDD storage from a
	// backup of a file system that used SSD storage if the original SSD file system
	// had a storage capacity of at least 2000 GiB.
	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.
	//
	// Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre
	// file systems, and OpenZFS file systems provide exactly one subnet ID. The
	// file server is launched in that subnet's Availability Zone.
	//
	// 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) SetFileSystemTypeVersion added in v1.40.57 

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

SetFileSystemTypeVersion sets the FileSystemTypeVersion 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) SetOpenZFSConfiguration added in v1.42.16 

func (s *CreateFileSystemFromBackupInput) SetOpenZFSConfiguration(v *CreateFileSystemOpenZFSConfiguration) *CreateFileSystemFromBackupInput

SetOpenZFSConfiguration sets the OpenZFSConfiguration field's value.

func (*CreateFileSystemFromBackupInput) SetSecurityGroupIds 

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*CreateFileSystemFromBackupInput) SetStorageCapacity added in v1.44.108 

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

SetStorageCapacity sets the StorageCapacity 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 63 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,
	// ONTAP, and OPENZFS.
	//
	// FileSystemType is a required field
	FileSystemType *string `type:"string" required:"true" enum:"FileSystemType"`

	// For FSx for Lustre file systems, sets the Lustre version for the file system
	// that you're creating. Valid values are 2.10, 2.12, and 2.15:
	//
	//    * 2.10 is supported by the Scratch and Persistent_1 Lustre deployment
	//    types.
	//
	//    * 2.12 is supported by all Lustre deployment types, except for PERSISTENT_2
	//    with a metadata configuration mode.
	//
	//    * 2.15 is supported by all Lustre deployment types and is recommended
	//    for all new file systems.
	//
	// Default value is 2.10, except for the following deployments:
	//
	//    * Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without
	//    a metadata configuration mode.
	//
	//    * Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with
	//    a metadata configuration mode.
	FileSystemTypeVersion *string `min:"1" type:"string"`

	// Specifies the ID of the Key Management Service (KMS) key to use for encrypting
	// data on Amazon FSx file systems, as follows:
	//
	//    * Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types
	//    only. SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx
	//    service KMS key for your account.
	//
	//    * Amazon FSx for NetApp ONTAP
	//
	//    * Amazon FSx for OpenZFS
	//
	//    * Amazon FSx for Windows File Server
	//
	// If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account
	// is used. For more information, see Encrypt (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.
	//
	// The following parameters are not supported for file systems with a data repository
	// association created with .
	//
	//    * AutoImportPolicy
	//
	//    * ExportPath
	//
	//    * ImportedFileChunkSize
	//
	//    * ImportPath
	LustreConfiguration *CreateFileSystemLustreConfiguration `type:"structure"`

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

	// The OpenZFS configuration for the file system that's being created.
	OpenZFSConfiguration *CreateFileSystemOpenZFSConfiguration `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.
	//
	// You must specify a security group if you are creating a Multi-AZ FSx for
	// ONTAP file system in a VPC subnet that has been shared with you.
	SecurityGroupIds []*string `type:"list"`

	// Sets the storage capacity of the file system that you're creating, in gibibytes
	// (GiB).
	//
	// FSx for Lustre file systems - The amount of storage capacity that you can
	// configure depends on the value that you set for StorageType and the Lustre
	// DeploymentType, as follows:
	//
	//    * For SCRATCH_2, PERSISTENT_2, and PERSISTENT_1 deployment types using
	//    SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments
	//    of 2400 GiB.
	//
	//    * For PERSISTENT_1 HDD file systems, valid values are increments of 6000
	//    GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB
	//    file systems.
	//
	//    * For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB,
	//    and increments of 3600 GiB.
	//
	// FSx for ONTAP file systems - The amount of storage capacity that you can
	// configure depends on the value of the HAPairs property. The minimum value
	// is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288
	// * HAPairs.
	//
	// FSx for OpenZFS file systems - The amount of storage capacity that you can
	// configure is from 64 GiB up to 524,288 GiB (512 TiB).
	//
	// FSx for Windows File Server file systems - The amount of storage capacity
	// that you can configure depends on the value that you set for StorageType
	// as follows:
	//
	//    * For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
	//
	//    * For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
	//
	// StorageCapacity is a required field
	StorageCapacity *int64 `type:"integer" required:"true"`

	// Sets the storage type for the file system that you're creating. Valid values
	// are SSD and HDD.
	//
	//    * Set to SSD to use solid state drive storage. SSD is supported on all
	//    Windows, Lustre, ONTAP, and OpenZFS deployment types.
	//
	//    * Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2
	//    and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1
	//    Lustre file system deployment types.
	//
	// Default value is SSD. For more information, see Storage type options (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options)
	// in the FSx for Windows File Server User Guide and Multiple storage options
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options)
	// in the 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 deployment types,provide exactly two
	// subnet IDs, one for the preferred file server and one for the standby file
	// server. You specify one of these subnets as the preferred subnet using the
	// WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID
	// properties. For more information about Multi-AZ file system configuration,
	// see Availability and durability: Single-AZ and Multi-AZ file systems (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 and all Lustre deployment types,
	// 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 that's 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 that's 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) SetFileSystemTypeVersion added in v1.40.57 

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

SetFileSystemTypeVersion sets the FileSystemTypeVersion 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) SetOpenZFSConfiguration added in v1.42.16 

func (s *CreateFileSystemInput) SetOpenZFSConfiguration(v *CreateFileSystemOpenZFSConfiguration) *CreateFileSystemInput

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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 parameter 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.
	//
	//    * NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports
	//    file and directory listings of any new objects added to the S3 bucket,
	//    any existing objects that are changed in the S3 bucket, and any objects
	//    that were deleted in the S3 bucket.
	//
	// For more information, see Automatically import updates from your S3 bucket
	// (https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3).
	//
	// This parameter is not supported for file systems with a data repository association.
	AutoImportPolicy *string `type:"string" enum:"AutoImportPolicyType"`

	// The number of days to retain automatic backups. Setting this property 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 for 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 CopyTagsToBackups is
	// 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 CopyTagsToBackups
	// is set to 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.
	//
	// (Default = false)
	//
	// For more information, see Working with backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html)
	// in the Amazon FSx for Lustre User Guide.
	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)
	// in the Amazon FSx for Lustre User Guide.
	DataCompressionType *string `type:"string" enum:"DataCompressionType"`

	// (Optional) 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 for longer-term storage and for throughput-focused workloads
	// that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data
	// in transit, and is available in all Amazon Web Services Regions in which
	// FSx for Lustre is available.
	//
	// Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads
	// that require the highest levels of IOPS/throughput. PERSISTENT_2 supports
	// SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB).
	// You can optionally specify a metadata configuration mode for PERSISTENT_2
	// which supports increasing metadata performance. PERSISTENT_2 is available
	// in a limited number of Amazon Web Services Regions. For more information,
	// and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2
	// is available, see File system deployment options for FSx for Lustre (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types)
	// in the Amazon FSx for Lustre User Guide.
	//
	// If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the
	// CreateFileSystem operation fails.
	//
	// Encryption of data in transit is automatically turned on when you access
	// SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 file systems from Amazon EC2 instances
	// that support automatic encryption in the Amazon Web Services Regions where
	// they are available. For more information about encryption in transit for
	// FSx for Lustre file systems, see Encrypting data in transit (https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html)
	// in the Amazon FSx for Lustre User Guide.
	//
	// (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 this property to READ to improve the performance for frequently
	// accessed files by caching up to 20% of the total storage capacity of the
	// file system.
	//
	// This parameter is required when StorageType is set to HDD.
	DriveCacheType *string `type:"string" enum:"DriveCacheType"`

	// (Optional) Specifies the path in the Amazon S3 bucket 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 specify only 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.
	//
	// This parameter is not supported for file systems with a data repository association.
	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.
	//
	// This parameter is not supported for file systems with a data repository association.
	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.
	//
	// This parameter is not supported for file systems with a data repository association.
	ImportedFileChunkSize *int64 `min:"1" type:"integer"`

	// The Lustre logging configuration used when creating an Amazon FSx for Lustre
	// file system. When logging is enabled, Lustre logs error and warning events
	// for data repositories associated with your file system to Amazon CloudWatch
	// Logs.
	LogConfiguration *LustreLogCreateConfiguration `type:"structure"`

	// The Lustre metadata performance configuration for the creation of an FSx
	// for Lustre file system using a PERSISTENT_2 deployment type.
	MetadataConfiguration *CreateFileSystemLustreMetadataConfiguration `type:"structure"`

	// Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions
	// the amount of read and write throughput for each 1 tebibyte (TiB) of file
	// system storage capacity, 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 PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.
	//
	//    * For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.
	//
	//    * For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.
	PerUnitStorageThroughput *int64 `min:"12" type:"integer"`

	// The Lustre root squash configuration used when creating an Amazon FSx for
	// Lustre file system. When enabled, root squash restricts root-level access
	// from clients that try to access your file system as a root user.
	RootSquashConfiguration *LustreRootSquashConfiguration `type:"structure"`

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

The following parameters are not supported for file systems with a data repository association created with .

  • AutoImportPolicy

  • ExportPath

  • ImportedFileChunkSize

  • ImportPath

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) SetLogConfiguration added in v1.42.16 

func (s *CreateFileSystemLustreConfiguration) SetLogConfiguration(v *LustreLogCreateConfiguration) *CreateFileSystemLustreConfiguration

SetLogConfiguration sets the LogConfiguration field's value.

func (*CreateFileSystemLustreConfiguration) SetMetadataConfiguration added in v1.53.18 

func (s *CreateFileSystemLustreConfiguration) SetMetadataConfiguration(v *CreateFileSystemLustreMetadataConfiguration) *CreateFileSystemLustreConfiguration

SetMetadataConfiguration sets the MetadataConfiguration 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) SetRootSquashConfiguration added in v1.44.22 

func (s *CreateFileSystemLustreConfiguration) SetRootSquashConfiguration(v *LustreRootSquashConfiguration) *CreateFileSystemLustreConfiguration

SetRootSquashConfiguration sets the RootSquashConfiguration 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 CreateFileSystemLustreMetadataConfiguration added in v1.53.18 

type CreateFileSystemLustreMetadataConfiguration struct {

	// (USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision
	// for the file system. This parameter sets the maximum rate of metadata disk
	// IOPS supported by the file system. Valid values are 1500, 3000, 6000, 12000,
	// and multiples of 12000 up to a maximum of 192000.
	//
	// Iops doesn’t have a default value. If you're using USER_PROVISIONED mode,
	// you can choose to specify a valid value. If you're using AUTOMATIC mode,
	// you cannot specify a value because FSx for Lustre automatically sets the
	// value based on your file system storage capacity.
	Iops *int64 `min:"1500" type:"integer"`

	// The metadata configuration mode for provisioning Metadata IOPS for an FSx
	// for Lustre file system using a PERSISTENT_2 deployment type.
	//
	//    * In AUTOMATIC mode, FSx for Lustre automatically provisions and scales
	//    the number of Metadata IOPS for your file system based on your file system
	//    storage capacity.
	//
	//    * In USER_PROVISIONED mode, you specify the number of Metadata IOPS to
	//    provision for your file system.
	//
	// Mode is a required field
	Mode *string `type:"string" required:"true" enum:"MetadataConfigurationMode"`
	// contains filtered or unexported fields
}

The Lustre metadata performance configuration for the creation of an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. The configuration uses a Metadata IOPS value to set the maximum rate of metadata disk IOPS supported by the file system.

After creation, the file system supports increasing metadata performance. For more information on Metadata IOPS, see Lustre metadata performance configuration (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-metadata-performance.html#metadata-configuration) in the Amazon FSx for Lustre User Guide.

func (CreateFileSystemLustreMetadataConfiguration) GoString added in v1.53.18 

func (s CreateFileSystemLustreMetadataConfiguration) 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 (*CreateFileSystemLustreMetadataConfiguration) SetIops added in v1.53.18 

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

SetIops sets the Iops field's value.

func (*CreateFileSystemLustreMetadataConfiguration) SetMode added in v1.53.18 

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

SetMode sets the Mode field's value.

func (CreateFileSystemLustreMetadataConfiguration) String added in v1.53.18 

func (s CreateFileSystemLustreMetadataConfiguration) 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 (*CreateFileSystemLustreMetadataConfiguration) Validate added in v1.53.18 

func (s *CreateFileSystemLustreMetadataConfiguration) 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 property to
	// 0 disables automatic backups. You can retain automatic backups for a maximum
	// of 90 days. The default is 30.
	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 FSx for ONTAP file system deployment type to use in creating
	// the file system.
	//
	//    * MULTI_AZ_1 - A high availability file system configured for Multi-AZ
	//    redundancy to tolerate temporary Availability Zone (AZ) unavailability.
	//    This is a first-generation FSx for ONTAP file system.
	//
	//    * MULTI_AZ_2 - A high availability file system configured for Multi-AZ
	//    redundancy to tolerate temporary AZ unavailability. This is a second-generation
	//    FSx for ONTAP file system.
	//
	//    * SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This
	//    is a first-generation FSx for ONTAP file system.
	//
	//    * SINGLE_AZ_2 - A file system configured with multiple high-availability
	//    (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for
	//    ONTAP file system.
	//
	// For information about the use cases for Multi-AZ and Single-AZ deployments,
	// refer to Choosing a file system deployment type (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html).
	//
	// DeploymentType is a required field
	DeploymentType *string `type:"string" required:"true" enum:"OntapDeploymentType"`

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

	// (Multi-AZ only) Specifies the IP address range in which the endpoints to
	// access your file system will be created. By default in the Amazon FSx API,
	// Amazon FSx selects an unused IP address range for you from the 198.19.* range.
	// By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses
	// from the VPC’s primary CIDR range to use as the endpoint IP address range
	// for the file system. You can have overlapping endpoint IP addresses for file
	// systems deployed in the same VPC/route tables, as long as they don't overlap
	// with any subnet.
	EndpointIpAddressRange *string `min:"9" type:"string"`

	// The ONTAP administrative password for the fsxadmin user with which you administer
	// your file system using the NetApp 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"`

	// Specifies how many high-availability (HA) pairs of file servers will power
	// your file system. First-generation file systems are powered by 1 HA pair.
	// Second-generation multi-AZ file systems are powered by 1 HA pair. Second
	// generation single-AZ file systems are powered by up to 12 HA pairs. The default
	// value is 1. The value of this property affects the values of StorageCapacity,
	// Iops, and ThroughputCapacity. For more information, see High-availability
	// (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs)
	// in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and
	// NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For
	// more information, see Using block storage protocols (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage).
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The value of HAPairs is less than 1 or greater than 12.
	//
	//    * The value of HAPairs is greater than 1 and the value of DeploymentType
	//    is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.
	HAPairs *int64 `min:"1" type:"integer"`

	// Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This specifies
	// the subnet in which you want the preferred file server to be located.
	PreferredSubnetId *string `min:"15" type:"string"`

	// (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the
	// rules for routing traffic to the correct file server. You should specify
	// all virtual private cloud (VPC) route tables associated with the subnets
	// in which your clients are located. By default, Amazon FSx selects your VPC's
	// default route table.
	//
	// Amazon FSx manages these route tables for Multi-AZ file systems using tag-based
	// authentication. These route tables are tagged with Key: AmazonFSx; Value:
	// ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using
	// CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx
	// tag manually.
	RouteTableIds []*string `type:"list"`

	// Sets the throughput capacity for the file system that you're creating in
	// megabytes per second (MBps). For more information, see Managing throughput
	// capacity (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html)
	// in the FSx for ONTAP User Guide.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The value of ThroughputCapacity and ThroughputCapacityPerHAPair are
	//    not the same value.
	//
	//    * The value of ThroughputCapacity when divided by the value of HAPairs
	//    is outside of the valid range for ThroughputCapacity.
	ThroughputCapacity *int64 `min:"8" type:"integer"`

	// Use to choose the throughput capacity per HA pair, rather than the total
	// throughput for the file system.
	//
	// You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity
	// when creating a file system, but not both.
	//
	// This field and ThroughputCapacity are the same for file systems powered by
	// one HA pair.
	//
	//    * For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256,
	//    512, 1024, 2048, or 4096 MBps.
	//
	//    * For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.
	//
	//    * For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The value of ThroughputCapacity and ThroughputCapacityPerHAPair are
	//    not the same value for file systems with one HA pair.
	//
	//    * The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity /
	//    ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1
	//    and 12).
	//
	//    * The value of ThroughputCapacityPerHAPair is not a valid value.
	ThroughputCapacityPerHAPair *int64 `min:"128" 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
}

The ONTAP configuration properties of the FSx for 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) SetHAPairs added in v1.48.4 

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

SetHAPairs sets the HAPairs 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) SetThroughputCapacityPerHAPair added in v1.48.4 

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

SetThroughputCapacityPerHAPair sets the ThroughputCapacityPerHAPair 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 CreateFileSystemOpenZFSConfiguration added in v1.42.16 

type CreateFileSystemOpenZFSConfiguration struct {

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

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

	// A Boolean value indicating whether tags for the file system should be copied
	// to volumes. This value defaults to false. If it's set to true, all tags for
	// the file system are copied to volumes 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 volumes. If you specify one or more tags when creating
	// the volume, no tags are copied from the file system, regardless of this value.
	CopyTagsToVolumes *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"`

	// Specifies the file system deployment type. Valid values are the following:
	//
	//    * MULTI_AZ_1- Creates file systems with high availability and durability
	//    by replicating your data and supporting failover across multiple Availability
	//    Zones in the same Amazon Web Services Region.
	//
	//    * SINGLE_AZ_HA_2- Creates file systems with high availability and throughput
	//    capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying
	//    a primary and standby file system within the same Availability Zone.
	//
	//    * SINGLE_AZ_HA_1- Creates file systems with high availability and throughput
	//    capacities of 64 - 4,096 MB/s by deploying a primary and standby file
	//    system within the same Availability Zone.
	//
	//    * SINGLE_AZ_2- Creates file systems with throughput capacities of 160
	//    - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within
	//    a single Availability Zone.
	//
	//    * SINGLE_AZ_1- Creates file systems with throughput capacities of 64 -
	//    4,096 MBs that automatically recover within a single Availability Zone.
	//
	// For a list of which Amazon Web Services Regions each deployment type is available
	// in, see Deployment type availability (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions).
	// For more information on the differences in performance between deployment
	// types, see File system performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance)
	// in the Amazon FSx for OpenZFS User Guide.
	//
	// DeploymentType is a required field
	DeploymentType *string `type:"string" required:"true" enum:"OpenZFSDeploymentType"`

	// The SSD IOPS (input/output operations per second) configuration for an Amazon
	// FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS
	// file system. By default, Amazon FSx automatically provisions 3 IOPS per GB
	// of storage capacity. You can provision additional IOPS per GB of storage.
	// The configuration consists of the total number of provisioned SSD IOPS and
	// how it is was provisioned, or the mode (by the customer or by Amazon FSx).
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

	// (Multi-AZ only) Specifies the IP address range in which the endpoints to
	// access your file system will be created. By default in the Amazon FSx API
	// and Amazon FSx console, Amazon FSx selects an available /28 IP address range
	// for you from one of the VPC's CIDR ranges. You can have overlapping endpoint
	// IP addresses for file systems deployed in the same VPC/route tables.
	EndpointIpAddressRange *string `min:"9" type:"string"`

	// Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet
	// in which you want the preferred file server to be located.
	PreferredSubnetId *string `min:"15" type:"string"`

	// The configuration Amazon FSx uses when creating the root value of the Amazon
	// FSx for OpenZFS file system. All volumes are children of the root volume.
	RootVolumeConfiguration *OpenZFSCreateRootVolumeConfiguration `type:"structure"`

	// (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the
	// rules for routing traffic to the correct file server. You should specify
	// all virtual private cloud (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"`

	// Specifies the throughput of an Amazon FSx for OpenZFS file system, measured
	// in megabytes per second (MBps). Valid values depend on the DeploymentType
	// you choose, as follows:
	//
	//    * For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280,
	//    2560, 3840, 5120, 7680, or 10240 MBps.
	//
	//    * For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072,
	//    or 4096 MBps.
	//
	// You pay for additional throughput capacity that you provision.
	//
	// 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 Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

func (CreateFileSystemOpenZFSConfiguration) GoString added in v1.42.16 

func (s CreateFileSystemOpenZFSConfiguration) 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 (*CreateFileSystemOpenZFSConfiguration) SetAutomaticBackupRetentionDays added in v1.42.16 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetCopyTagsToBackups added in v1.42.16 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetCopyTagsToVolumes added in v1.42.16 

func (s *CreateFileSystemOpenZFSConfiguration) SetCopyTagsToVolumes(v bool) *CreateFileSystemOpenZFSConfiguration

SetCopyTagsToVolumes sets the CopyTagsToVolumes field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetDailyAutomaticBackupStartTime added in v1.42.16 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetDeploymentType added in v1.42.16 

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

SetDeploymentType sets the DeploymentType field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetDiskIopsConfiguration added in v1.42.16 

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

SetDiskIopsConfiguration sets the DiskIopsConfiguration field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetEndpointIpAddressRange added in v1.44.320 

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

SetEndpointIpAddressRange sets the EndpointIpAddressRange field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetPreferredSubnetId added in v1.44.320 

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

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetRootVolumeConfiguration added in v1.42.16 

func (s *CreateFileSystemOpenZFSConfiguration) SetRootVolumeConfiguration(v *OpenZFSCreateRootVolumeConfiguration) *CreateFileSystemOpenZFSConfiguration

SetRootVolumeConfiguration sets the RootVolumeConfiguration field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetRouteTableIds added in v1.44.320 

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

SetRouteTableIds sets the RouteTableIds field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetThroughputCapacity added in v1.42.16 

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

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*CreateFileSystemOpenZFSConfiguration) SetWeeklyMaintenanceStartTime added in v1.42.16 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (CreateFileSystemOpenZFSConfiguration) String added in v1.42.16 

func (s CreateFileSystemOpenZFSConfiguration) 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 (*CreateFileSystemOpenZFSConfiguration) Validate added in v1.42.16 

func (s *CreateFileSystemOpenZFSConfiguration) 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. Setting this property to
	// 0 disables automatic backups. You can retain automatic backups for a maximum
	// of 90 days. The default is 30.
	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"`

	// The SSD IOPS (input/output operations per second) configuration for an Amazon
	// FSx for Windows file system. By default, Amazon FSx automatically provisions
	// 3 IOPS per GiB of storage capacity. You can provision additional IOPS per
	// GiB of storage, up to the maximum limit associated with your chosen throughput
	// capacity.
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

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

	// Sets the throughput capacity of an Amazon FSx file system, measured in megabytes
	// per second (MB/s), 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) SetDiskIopsConfiguration added in v1.44.320 

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

SetDiskIopsConfiguration sets the DiskIopsConfiguration 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 {

	// Use to specify configuration options for a volume’s storage aggregate or
	// aggregates.
	AggregateConfiguration *CreateAggregateConfiguration `type:"structure"`

	// A boolean flag indicating whether tags for the volume should be copied to
	// backups. This value defaults to false. If it's set to true, all tags for
	// the volume 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 volume, regardless of this value.
	CopyTagsToBackups *bool `type:"boolean"`

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

	// Specifies the type of volume you are creating. Valid values are the following:
	//
	//    * RW specifies a read/write volume. RW is the default.
	//
	//    * DP specifies a data-protection volume. A DP volume is read-only and
	//    can be used as the destination of a NetApp SnapMirror relationship.
	//
	// For more information, see Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types)
	// in the Amazon FSx for NetApp ONTAP User Guide.
	OntapVolumeType *string `type:"string" enum:"InputOntapVolumeType"`

	// Specifies the security style for the volume. If a volume's security style
	// is not specified, it is automatically set to the root volume's security style.
	// The security style determines the type of permissions that FSx for ONTAP
	// uses to control data access. 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 This is an advanced setting. For more information, see the topic
	//    What the security styles and their effects are (https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html)
	//    in the NetApp Documentation Center.
	//
	// For more information, see Volume security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style)
	// in the FSx for ONTAP User Guide.
	SecurityStyle *string `type:"string" enum:"SecurityStyle"`

	// Specifies the configured size of the volume, in bytes.
	SizeInBytes *int64 `type:"long"`

	// Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB),
	// that you are creating.
	//
	// Deprecated: This property is deprecated, use SizeInBytes instead
	SizeInMegabytes *int64 `deprecated:"true" type:"integer"`

	// Specifies the SnapLock configuration for an FSx for ONTAP volume.
	SnaplockConfiguration *CreateSnaplockConfiguration `type:"structure"`

	// Specifies the snapshot policy for the volume. There are three built-in snapshot
	// policies:
	//
	//    * default: This is the default policy. A maximum of six hourly snapshots
	//    taken five minutes past the hour. A maximum of two daily snapshots taken
	//    Monday through Saturday at 10 minutes after midnight. A maximum of two
	//    weekly snapshots taken every Sunday at 15 minutes after midnight.
	//
	//    * default-1weekly: This policy is the same as the default policy except
	//    that it only retains one snapshot from the weekly schedule.
	//
	//    * none: This policy does not take any snapshots. This policy can be assigned
	//    to volumes to prevent automatic snapshots from being taken.
	//
	// You can also provide the name of a custom policy that you created with the
	// ONTAP CLI or REST API.
	//
	// For more information, see Snapshot policies (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies)
	// in the Amazon FSx for NetApp ONTAP User Guide.
	SnapshotPolicy *string `min:"1" type:"string"`

	// Set to true to enable deduplication, compression, and compaction storage
	// efficiency features on the volume, or set to false to disable them.
	//
	// StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType
	// set to RW).
	StorageEfficiencyEnabled *bool `type:"boolean"`

	// 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.
	//
	// Valid tiering policies are the following:
	//
	//    * SNAPSHOT_ONLY - (Default value) 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.
	TieringPolicy *TieringPolicy `type:"structure"`

	// Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles
	// of volumes that you can use for different purposes, FlexVol and FlexGroup
	// volumes. For more information, see Volume styles (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles)
	// in the Amazon FSx for NetApp ONTAP User Guide.
	VolumeStyle *string `type:"string" enum:"VolumeStyle"`
	// 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) SetAggregateConfiguration added in v1.48.4 

func (s *CreateOntapVolumeConfiguration) SetAggregateConfiguration(v *CreateAggregateConfiguration) *CreateOntapVolumeConfiguration

SetAggregateConfiguration sets the AggregateConfiguration field's value.

func (*CreateOntapVolumeConfiguration) SetCopyTagsToBackups added in v1.44.147 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*CreateOntapVolumeConfiguration) SetJunctionPath added in v1.40.36 

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

SetJunctionPath sets the JunctionPath field's value.

func (*CreateOntapVolumeConfiguration) SetOntapVolumeType added in v1.44.147 

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

SetOntapVolumeType sets the OntapVolumeType 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) SetSizeInBytes added in v1.48.4 

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

SetSizeInBytes sets the SizeInBytes 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) SetSnaplockConfiguration added in v1.44.300 

func (s *CreateOntapVolumeConfiguration) SetSnaplockConfiguration(v *CreateSnaplockConfiguration) *CreateOntapVolumeConfiguration

SetSnaplockConfiguration sets the SnaplockConfiguration field's value.

func (*CreateOntapVolumeConfiguration) SetSnapshotPolicy added in v1.44.147 

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

SetSnapshotPolicy sets the SnapshotPolicy 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) SetVolumeStyle added in v1.48.4 

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

SetVolumeStyle sets the VolumeStyle 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 CreateOpenZFSOriginSnapshotConfiguration added in v1.42.16 

type CreateOpenZFSOriginSnapshotConfiguration struct {

	// Specifies the strategy used when copying data from the snapshot to the new
	// volume.
	//
	//    * CLONE - The new volume references the data in the origin snapshot. Cloning
	//    a snapshot is faster than copying data from the snapshot to a new volume
	//    and doesn't consume disk throughput. However, the origin snapshot can't
	//    be deleted if there is a volume using its copied data.
	//
	//    * FULL_COPY - Copies all data from the snapshot to the new volume. Specify
	//    this option to create the volume from a snapshot on another FSx for OpenZFS
	//    file system.
	//
	// The INCREMENTAL_COPY option is only for updating an existing volume by using
	// a snapshot from another FSx for OpenZFS file system. For more information,
	// see CopySnapshotAndUpdateVolume (https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html).
	//
	// CopyStrategy is a required field
	CopyStrategy *string `type:"string" required:"true" enum:"OpenZFSCopyStrategy"`

	// 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.
	//
	// SnapshotARN is a required field
	SnapshotARN *string `min:"8" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The snapshot configuration to use when creating an Amazon FSx for OpenZFS volume from a snapshot.

func (CreateOpenZFSOriginSnapshotConfiguration) GoString added in v1.42.16 

func (s CreateOpenZFSOriginSnapshotConfiguration) 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 (*CreateOpenZFSOriginSnapshotConfiguration) SetCopyStrategy added in v1.42.16 

func (s *CreateOpenZFSOriginSnapshotConfiguration) SetCopyStrategy(v string) *CreateOpenZFSOriginSnapshotConfiguration

SetCopyStrategy sets the CopyStrategy field's value.

func (*CreateOpenZFSOriginSnapshotConfiguration) SetSnapshotARN added in v1.42.16 

func (s *CreateOpenZFSOriginSnapshotConfiguration) SetSnapshotARN(v string) *CreateOpenZFSOriginSnapshotConfiguration

SetSnapshotARN sets the SnapshotARN field's value.

func (CreateOpenZFSOriginSnapshotConfiguration) String added in v1.42.16 

func (s CreateOpenZFSOriginSnapshotConfiguration) 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 (*CreateOpenZFSOriginSnapshotConfiguration) Validate added in v1.42.16 

func (s *CreateOpenZFSOriginSnapshotConfiguration) Validate() error

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

type CreateOpenZFSVolumeConfiguration added in v1.42.16 

type CreateOpenZFSVolumeConfiguration struct {

	// A Boolean value indicating whether tags for the volume should be copied to
	// snapshots. This value defaults to false. If it's set to true, all tags for
	// the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating
	// the snapshot, no tags are copied from the volume, regardless of this value.
	CopyTagsToSnapshots *bool `type:"boolean"`

	// Specifies the method used to compress the data on the volume. The compression
	// type is NONE by default.
	//
	//    * NONE - Doesn't compress the data on the volume. NONE is the default.
	//
	//    * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD)
	//    compression algorithm. ZSTD compression provides a higher level of data
	//    compression and higher read throughput performance than LZ4 compression.
	//
	//    * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm.
	//    LZ4 compression provides a lower level of compression and higher write
	//    throughput performance than ZSTD compression.
	//
	// For more information about volume compression types and the performance of
	// your Amazon FSx for OpenZFS file system, see Tips for maximizing performance
	// (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs)
	// File system and volume settings in the Amazon FSx for OpenZFS User Guide.
	DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"`

	// The configuration object for mounting a Network File System (NFS) file system.
	NfsExports []*OpenZFSNfsExport `type:"list"`

	// The configuration object that specifies the snapshot to use as the origin
	// of the data for the volume.
	OriginSnapshot *CreateOpenZFSOriginSnapshotConfiguration `type:"structure"`

	// The ID of the volume to use as the parent volume of the volume that you are
	// creating.
	//
	// ParentVolumeId is a required field
	ParentVolumeId *string `min:"23" type:"string" required:"true"`

	// A Boolean value indicating whether the volume is read-only.
	ReadOnly *bool `type:"boolean"`

	// Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes
	// (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The
	// default is 128 KiB. We recommend using the default setting for the majority
	// of use cases. Generally, workloads that write in fixed small or large record
	// sizes may benefit from setting a custom record size, like database workloads
	// (small record size) or media streaming workloads (large record size). For
	// additional guidance on when to set a custom record size, see ZFS Record size
	// (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance)
	// in the Amazon FSx for OpenZFS User Guide.
	RecordSizeKiB *int64 `min:"4" type:"integer"`

	// Sets the maximum storage size in gibibytes (GiB) for the volume. You can
	// specify a quota that is larger than the storage on the parent volume. A volume
	// quota limits the amount of storage that the volume can consume to the configured
	// amount, but does not guarantee the space will be available on the parent
	// volume. To guarantee quota space, you must also set StorageCapacityReservationGiB.
	// To not specify a storage capacity quota, set this to -1.
	//
	// For more information, see Volume properties (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties)
	// in the Amazon FSx for OpenZFS User Guide.
	StorageCapacityQuotaGiB *int64 `type:"integer"`

	// Specifies the amount of storage in gibibytes (GiB) to reserve from the parent
	// volume. Setting StorageCapacityReservationGiB guarantees that the specified
	// amount of storage space on the parent volume will always be available for
	// the volume. You can't reserve more storage than the parent volume has. To
	// not specify a storage capacity reservation, set this to 0 or -1. For more
	// information, see Volume properties (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties)
	// in the Amazon FSx for OpenZFS User Guide.
	StorageCapacityReservationGiB *int64 `type:"integer"`

	// Configures how much storage users and groups can use on the volume.
	UserAndGroupQuotas []*OpenZFSUserOrGroupQuota `type:"list"`
	// contains filtered or unexported fields
}

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

func (CreateOpenZFSVolumeConfiguration) GoString added in v1.42.16 

func (s CreateOpenZFSVolumeConfiguration) 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 (*CreateOpenZFSVolumeConfiguration) SetCopyTagsToSnapshots added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetCopyTagsToSnapshots(v bool) *CreateOpenZFSVolumeConfiguration

SetCopyTagsToSnapshots sets the CopyTagsToSnapshots field's value.

func (*CreateOpenZFSVolumeConfiguration) SetDataCompressionType added in v1.42.16 

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

SetDataCompressionType sets the DataCompressionType field's value.

func (*CreateOpenZFSVolumeConfiguration) SetNfsExports added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetNfsExports(v []*OpenZFSNfsExport) *CreateOpenZFSVolumeConfiguration

SetNfsExports sets the NfsExports field's value.

func (*CreateOpenZFSVolumeConfiguration) SetOriginSnapshot added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetOriginSnapshot(v *CreateOpenZFSOriginSnapshotConfiguration) *CreateOpenZFSVolumeConfiguration

SetOriginSnapshot sets the OriginSnapshot field's value.

func (*CreateOpenZFSVolumeConfiguration) SetParentVolumeId added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetParentVolumeId(v string) *CreateOpenZFSVolumeConfiguration

SetParentVolumeId sets the ParentVolumeId field's value.

func (*CreateOpenZFSVolumeConfiguration) SetReadOnly added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetReadOnly(v bool) *CreateOpenZFSVolumeConfiguration

SetReadOnly sets the ReadOnly field's value.

func (*CreateOpenZFSVolumeConfiguration) SetRecordSizeKiB added in v1.43.8 

func (s *CreateOpenZFSVolumeConfiguration) SetRecordSizeKiB(v int64) *CreateOpenZFSVolumeConfiguration

SetRecordSizeKiB sets the RecordSizeKiB field's value.

func (*CreateOpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB(v int64) *CreateOpenZFSVolumeConfiguration

SetStorageCapacityQuotaGiB sets the StorageCapacityQuotaGiB field's value.

func (*CreateOpenZFSVolumeConfiguration) SetStorageCapacityReservationGiB added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetStorageCapacityReservationGiB(v int64) *CreateOpenZFSVolumeConfiguration

SetStorageCapacityReservationGiB sets the StorageCapacityReservationGiB field's value.

func (*CreateOpenZFSVolumeConfiguration) SetUserAndGroupQuotas added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) SetUserAndGroupQuotas(v []*OpenZFSUserOrGroupQuota) *CreateOpenZFSVolumeConfiguration

SetUserAndGroupQuotas sets the UserAndGroupQuotas field's value.

func (CreateOpenZFSVolumeConfiguration) String added in v1.42.16 

func (s CreateOpenZFSVolumeConfiguration) 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 (*CreateOpenZFSVolumeConfiguration) Validate added in v1.42.16 

func (s *CreateOpenZFSVolumeConfiguration) Validate() error

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

type CreateSnaplockConfiguration added in v1.44.300 

type CreateSnaplockConfiguration struct {

	// Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
	// The default value is false. If you set AuditLogVolume to true, the SnapLock
	// volume is created as an audit log volume. The minimum retention period for
	// an audit log volume is six months.
	//
	// For more information, see SnapLock audit log volumes (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume).
	AuditLogVolume *bool `type:"boolean"`

	// The configuration object for setting the autocommit period of files in an
	// FSx for ONTAP SnapLock volume.
	AutocommitPeriod *AutocommitPeriod `type:"structure"`

	// Enables, disables, or permanently disables privileged delete on an FSx for
	// ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock
	// administrators to delete WORM files even if they have active retention periods.
	// PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently
	// disabled on a SnapLock volume, you can't re-enable it. The default value
	// is DISABLED.
	//
	// For more information, see Privileged delete (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete).
	PrivilegedDelete *string `type:"string" enum:"PrivilegedDelete"`

	// Specifies the retention period of an FSx for ONTAP SnapLock volume.
	RetentionPeriod *SnaplockRetentionPeriod `type:"structure"`

	// Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it
	// is set, it can't be changed. You can choose one of the following retention
	// modes:
	//
	//    * COMPLIANCE: Files transitioned to write once, read many (WORM) on a
	//    Compliance volume can't be deleted until their retention periods expire.
	//    This retention mode is used to address government or industry-specific
	//    mandates or to protect against ransomware attacks. For more information,
	//    see SnapLock Compliance (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html).
	//
	//    * ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be
	//    deleted by authorized users before their retention periods expire using
	//    privileged delete. This retention mode is used to advance an organization's
	//    data integrity and internal compliance or to test retention settings before
	//    using SnapLock Compliance. For more information, see SnapLock Enterprise
	//    (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html).
	//
	// SnaplockType is a required field
	SnaplockType *string `type:"string" required:"true" enum:"SnaplockType"`

	// Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
	// Volume-append mode allows you to create WORM-appendable files and write data
	// to them incrementally. The default value is false.
	//
	// For more information, see Volume-append mode (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append).
	VolumeAppendModeEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.

func (CreateSnaplockConfiguration) GoString added in v1.44.300 

func (s CreateSnaplockConfiguration) 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 (*CreateSnaplockConfiguration) SetAuditLogVolume added in v1.44.300 

func (s *CreateSnaplockConfiguration) SetAuditLogVolume(v bool) *CreateSnaplockConfiguration

SetAuditLogVolume sets the AuditLogVolume field's value.

func (*CreateSnaplockConfiguration) SetAutocommitPeriod added in v1.44.300 

func (s *CreateSnaplockConfiguration) SetAutocommitPeriod(v *AutocommitPeriod) *CreateSnaplockConfiguration

SetAutocommitPeriod sets the AutocommitPeriod field's value.

func (*CreateSnaplockConfiguration) SetPrivilegedDelete added in v1.44.300 

func (s *CreateSnaplockConfiguration) SetPrivilegedDelete(v string) *CreateSnaplockConfiguration

SetPrivilegedDelete sets the PrivilegedDelete field's value.

func (*CreateSnaplockConfiguration) SetRetentionPeriod added in v1.44.300 

func (s *CreateSnaplockConfiguration) SetRetentionPeriod(v *SnaplockRetentionPeriod) *CreateSnaplockConfiguration

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*CreateSnaplockConfiguration) SetSnaplockType added in v1.44.300 

func (s *CreateSnaplockConfiguration) SetSnaplockType(v string) *CreateSnaplockConfiguration

SetSnaplockType sets the SnaplockType field's value.

func (*CreateSnaplockConfiguration) SetVolumeAppendModeEnabled added in v1.44.300 

func (s *CreateSnaplockConfiguration) SetVolumeAppendModeEnabled(v bool) *CreateSnaplockConfiguration

SetVolumeAppendModeEnabled sets the VolumeAppendModeEnabled field's value.

func (CreateSnaplockConfiguration) String added in v1.44.300 

func (s CreateSnaplockConfiguration) 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 (*CreateSnaplockConfiguration) Validate added in v1.44.300 

func (s *CreateSnaplockConfiguration) Validate() error

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

type CreateSnapshotInput added in v1.42.16 

type CreateSnapshotInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 snapshot.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

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

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

func (CreateSnapshotInput) GoString added in v1.42.16 

func (s CreateSnapshotInput) 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 (*CreateSnapshotInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateSnapshotInput) SetName added in v1.42.16 

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

SetName sets the Name field's value.

func (*CreateSnapshotInput) SetTags added in v1.42.16 

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

SetTags sets the Tags field's value.

func (*CreateSnapshotInput) SetVolumeId added in v1.42.16 

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

SetVolumeId sets the VolumeId field's value.

func (CreateSnapshotInput) String added in v1.42.16 

func (s CreateSnapshotInput) 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 (*CreateSnapshotInput) Validate added in v1.42.16 

func (s *CreateSnapshotInput) Validate() error

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

type CreateSnapshotOutput added in v1.42.16 

type CreateSnapshotOutput struct {

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

func (CreateSnapshotOutput) GoString added in v1.42.16 

func (s CreateSnapshotOutput) 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 (*CreateSnapshotOutput) SetSnapshot added in v1.42.16 

func (s *CreateSnapshotOutput) SetSnapshot(v *Snapshot) *CreateSnapshotOutput

SetSnapshot sets the Snapshot field's value.

func (CreateSnapshotOutput) String added in v1.42.16 

func (s CreateSnapshotOutput) 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 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 clients
	// accessing the file system.
	ActiveDirectoryConfiguration *CreateSvmActiveDirectoryConfiguration `type:"structure"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 Microsoft Windows administrator,
	//    the majority of users are SMB clients, and an application accessing the
	//    data uses a Microsoft Windows user as the service account.
	//
	//    * MIXED This is an advanced setting. For more information, see Volume
	//    security style (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-security-style.html)
	//    in the Amazon FSx for NetApp ONTAP User Guide.
	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 FSx for Windows File Server
	// file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed
	// (including on-premises) Microsoft Active Directory (AD) directory. For more
	// information, see Using Amazon FSx for Windows with your self-managed Microsoft
	// Active Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html)
	// or Managing FSx for ONTAP 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 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 that 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 63 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 63 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 that you're creating.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

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

	// Specifies the configuration to use when creating the OpenZFS volume.
	OpenZFSConfiguration *CreateOpenZFSVolumeConfiguration `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 and OPENZFS are the only valid
	// volume types.
	//
	// 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) SetOpenZFSConfiguration added in v1.42.16 

func (s *CreateVolumeInput) SetOpenZFSConfiguration(v *CreateOpenZFSVolumeConfiguration) *CreateVolumeInput

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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 DataRepositoryAssociation added in v1.42.16 

type DataRepositoryAssociation struct {

	// The system-generated, unique ID of the data repository association.
	AssociationId *string `min:"13" type:"string"`

	// A boolean flag indicating whether an import data repository task to import
	// metadata should run after the data repository association is created. The
	// task runs if this flag is set to true.
	//
	// BatchImportMetaDataOnCreate is not supported for data repositories linked
	// to an Amazon File Cache resource.
	BatchImportMetaDataOnCreate *bool `type:"boolean"`

	// 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 path to the data repository that will be linked to the cache or file
	// system.
	//
	//    * For Amazon File Cache, the path can be an NFS data repository that will
	//    be linked to the cache. The path can be in one of two formats: If you
	//    are not using the DataRepositorySubdirectories parameter, the path is
	//    to an NFS Export directory (or one of its subdirectories) in the format
	//    nsf://nfs-domain-name/exportpath. You can therefore link a single NFS
	//    Export to a single data repository association. If you are using the DataRepositorySubdirectories
	//    parameter, the path is the domain name of the NFS file system in the format
	//    nfs://filer-domain-name, which indicates the root of the subdirectories
	//    specified with the DataRepositorySubdirectories parameter.
	//
	//    * For Amazon File Cache, the path can be an S3 bucket or prefix in the
	//    format s3://myBucket/myPrefix/.
	//
	//    * For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in
	//    the format s3://myBucket/myPrefix/.
	DataRepositoryPath *string `min:"3" type:"string"`

	// For Amazon File Cache, a list of NFS Exports that will be linked with an
	// NFS data repository association. All the subdirectories must be on a single
	// NFS file system. The Export paths are in the format /exportpath1. To use
	// this parameter, you must configure DataRepositoryPath as the domain name
	// of the NFS file system. The NFS file system domain name in effect is the
	// root of the subdirectories. Note that DataRepositorySubdirectories is not
	// supported for S3 data repositories.
	DataRepositorySubdirectories []*string `type:"list"`

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

	// The globally unique ID of the Amazon File Cache resource.
	FileCacheId *string `min:"11" type:"string"`

	// A path on the Amazon File Cache that points to a high-level directory (such
	// as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1
	// with DataRepositoryPath. The leading forward slash in the path is required.
	// Two data repository associations cannot have overlapping cache paths. For
	// example, if a data repository is associated with cache path /ns1/, then you
	// cannot link another data repository with cache path /ns1/ns2.
	//
	// This path specifies the directory in your cache where files will be exported
	// from. This cache directory can be linked to only one data repository (S3
	// or NFS) and no other data repository can be linked to the directory.
	//
	// The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories
	// is specified. If you specify root (/) as the cache path, you can create only
	// one DRA on the cache.
	//
	// The cache path cannot be set to root (/) for an S3 DRA.
	FileCachePath *string `min:"1" type:"string"`

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

	// A path on the Amazon FSx for Lustre file system that points to a high-level
	// directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will
	// be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name
	// is required. Two data repository associations cannot have overlapping file
	// system paths. For example, if a data repository is associated with file system
	// path /ns1/, then you cannot link another data repository with file system
	// path /ns1/ns2.
	//
	// This path specifies where in your file system files will be exported from
	// or imported to. This file system directory can be linked to only one Amazon
	// S3 bucket, and no other S3 bucket can be linked to the directory.
	//
	// If you specify only a forward slash (/) as the file system path, you can
	// link only one data repository to the file system. You can only specify "/"
	// as the file system path for the first data repository associated with a file
	// system.
	FileSystemPath *string `min:"1" 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 or cache.
	//
	// 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 a data repository association. The lifecycle can have
	// the following values:
	//
	//    * CREATING - The data repository association between the file system or
	//    cache and the data repository is being created. The data repository is
	//    unavailable.
	//
	//    * AVAILABLE - The data repository association is available for use.
	//
	//    * MISCONFIGURED - The data repository association is misconfigured. Until
	//    the configuration is corrected, automatic import and automatic export
	//    will not work (only for Amazon FSx for Lustre).
	//
	//    * UPDATING - The data repository association is undergoing a customer
	//    initiated update that might affect its availability.
	//
	//    * DELETING - The data repository association is undergoing a customer
	//    initiated deletion.
	//
	//    * FAILED - The data repository association is in a terminal state that
	//    cannot be recovered.
	Lifecycle *string `type:"string" enum:"DataRepositoryLifecycle"`

	// The configuration for an NFS data repository linked to an Amazon File Cache
	// resource with a data repository association.
	NFS *NFSDataRepositoryConfiguration `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 configuration for an Amazon S3 data repository linked to an Amazon FSx
	// for Lustre file system with a data repository association.
	S3 *S3DataRepositoryConfiguration `type:"structure"`

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

The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system. The data repository association configuration object is returned in the response of the following operations:

  • CreateDataRepositoryAssociation

  • UpdateDataRepositoryAssociation

  • DescribeDataRepositoryAssociations

Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

func (DataRepositoryAssociation) GoString added in v1.42.16 

func (s DataRepositoryAssociation) 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 (*DataRepositoryAssociation) SetAssociationId added in v1.42.16 

func (s *DataRepositoryAssociation) SetAssociationId(v string) *DataRepositoryAssociation

SetAssociationId sets the AssociationId field's value.

func (*DataRepositoryAssociation) SetBatchImportMetaDataOnCreate added in v1.42.16 

func (s *DataRepositoryAssociation) SetBatchImportMetaDataOnCreate(v bool) *DataRepositoryAssociation

SetBatchImportMetaDataOnCreate sets the BatchImportMetaDataOnCreate field's value.

func (*DataRepositoryAssociation) SetCreationTime added in v1.42.16 

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

SetCreationTime sets the CreationTime field's value.

func (*DataRepositoryAssociation) SetDataRepositoryPath added in v1.42.16 

func (s *DataRepositoryAssociation) SetDataRepositoryPath(v string) *DataRepositoryAssociation

SetDataRepositoryPath sets the DataRepositoryPath field's value.

func (*DataRepositoryAssociation) SetDataRepositorySubdirectories added in v1.44.108 

func (s *DataRepositoryAssociation) SetDataRepositorySubdirectories(v []*string) *DataRepositoryAssociation

SetDataRepositorySubdirectories sets the DataRepositorySubdirectories field's value.

func (*DataRepositoryAssociation) SetFailureDetails added in v1.42.16 

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

SetFailureDetails sets the FailureDetails field's value.

func (*DataRepositoryAssociation) SetFileCacheId added in v1.44.108 

func (s *DataRepositoryAssociation) SetFileCacheId(v string) *DataRepositoryAssociation

SetFileCacheId sets the FileCacheId field's value.

func (*DataRepositoryAssociation) SetFileCachePath added in v1.44.108 

func (s *DataRepositoryAssociation) SetFileCachePath(v string) *DataRepositoryAssociation

SetFileCachePath sets the FileCachePath field's value.

func (*DataRepositoryAssociation) SetFileSystemId added in v1.42.16 

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

SetFileSystemId sets the FileSystemId field's value.

func (*DataRepositoryAssociation) SetFileSystemPath added in v1.42.16 

func (s *DataRepositoryAssociation) SetFileSystemPath(v string) *DataRepositoryAssociation

SetFileSystemPath sets the FileSystemPath field's value.

func (*DataRepositoryAssociation) SetImportedFileChunkSize added in v1.42.16 

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

SetImportedFileChunkSize sets the ImportedFileChunkSize field's value.

func (*DataRepositoryAssociation) SetLifecycle added in v1.42.16 

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

SetLifecycle sets the Lifecycle field's value.

func (*DataRepositoryAssociation) SetNFS added in v1.44.108 

func (s *DataRepositoryAssociation) SetNFS(v *NFSDataRepositoryConfiguration) *DataRepositoryAssociation

SetNFS sets the NFS field's value.

func (*DataRepositoryAssociation) SetResourceARN added in v1.42.16 

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

SetResourceARN sets the ResourceARN field's value.

func (*DataRepositoryAssociation) SetS3 added in v1.42.16 

func (s *DataRepositoryAssociation) SetS3(v *S3DataRepositoryConfiguration) *DataRepositoryAssociation

SetS3 sets the S3 field's value.

func (*DataRepositoryAssociation) SetTags added in v1.42.16 

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

SetTags sets the Tags field's value.

func (DataRepositoryAssociation) String added in v1.42.16 

func (s DataRepositoryAssociation) 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 DataRepositoryAssociationNotFound added in v1.42.16 

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

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

No data repository associations were found based upon the supplied parameters.

func (*DataRepositoryAssociationNotFound) Code added in v1.42.16 

func (s *DataRepositoryAssociationNotFound) Code() string

Code returns the exception type name.

func (*DataRepositoryAssociationNotFound) Error added in v1.42.16 

func (s *DataRepositoryAssociationNotFound) Error() string

func (DataRepositoryAssociationNotFound) GoString added in v1.42.16 

func (s DataRepositoryAssociationNotFound) 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 (*DataRepositoryAssociationNotFound) Message added in v1.42.16 

func (s *DataRepositoryAssociationNotFound) Message() string

Message returns the exception's message.

func (*DataRepositoryAssociationNotFound) OrigErr added in v1.42.16 

func (s *DataRepositoryAssociationNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DataRepositoryAssociationNotFound) RequestID added in v1.42.16 

func (s *DataRepositoryAssociationNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DataRepositoryAssociationNotFound) StatusCode added in v1.42.16 

func (s *DataRepositoryAssociationNotFound) StatusCode() int

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

func (DataRepositoryAssociationNotFound) String added in v1.42.16 

func (s DataRepositoryAssociationNotFound) 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.
	//
	//    * NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports
	//    file and directory listings of any new objects added to the S3 bucket,
	//    any existing objects that are changed in the S3 bucket, and any objects
	//    that were deleted in the S3 bucket.
	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 repository if its Lifecycle
	// is set to MISCONFIGURED or FAILED.
	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.
	//
	//    * FAILED - The data repository is in a terminal state that cannot be recovered.
	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.

This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

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 repository if its Lifecycle is set to MISCONFIGURED or FAILED.

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 {

	// Specifies the amount of data to release, in GiB, by an Amazon File Cache
	// AUTO_RELEASE_DATA task that automatically releases files from the cache.
	CapacityToRelease *int64 `min:"1" type:"long"`

	// 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 the system 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 system-generated, unique ID of the cache.
	FileCacheId *string `min:"11" type:"string"`

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

	// The lifecycle status of the data repository task, as follows:
	//
	//    * PENDING - The task has not started.
	//
	//    * EXECUTING - The task is in process.
	//
	//    * FAILED - The task was not able to be completed. For example, there may
	//    be files the task failed to process. The DataRepositoryTaskFailureDetails
	//    property provides more information about task failures.
	//
	//    * SUCCEEDED - The task has completed successfully.
	//
	//    * CANCELED - The task was canceled and it did not complete.
	//
	//    * CANCELING - The task is in process of being canceled.
	//
	// 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 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"`

	// The configuration that specifies the last accessed time criteria for files
	// that will be released from an Amazon FSx for Lustre file system.
	ReleaseConfiguration *ReleaseConfiguration `type:"structure"`

	// 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 the system 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 tasks export from your Amazon FSx for Lustre file
	//    system to a linked data repository.
	//
	//    * IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a
	//    linked S3 bucket to your Amazon FSx for Lustre file system.
	//
	//    * RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx
	//    for Lustre file system that have been exported to a linked S3 bucket and
	//    that meet your specified release criteria.
	//
	//    * AUTO_RELEASE_DATA tasks automatically release files from an Amazon File
	//    Cache resource.
	//
	// 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 import and export data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository.

  • You use release data repository tasks to release files that have been exported to a linked S3 bucket from your Amazon FSx for Lustre file system.

  • An Amazon File Cache resource uses a task to automatically release files from the cache.

To learn more about data repository tasks, see Data Repository Tasks (https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html).

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) SetCapacityToRelease added in v1.44.108 

func (s *DataRepositoryTask) SetCapacityToRelease(v int64) *DataRepositoryTask

SetCapacityToRelease sets the CapacityToRelease field's value.

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) SetFileCacheId added in v1.44.108 

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

SetFileCacheId sets the FileCacheId 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) SetReleaseConfiguration added in v1.44.320 

func (s *DataRepositoryTask) SetReleaseConfiguration(v *ReleaseConfiguration) *DataRepositoryTask

SetReleaseConfiguration sets the ReleaseConfiguration 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"`

	// The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA
	// task that automatically releases files from the cache.
	ReleasedCapacity *int64 `type:"long"`

	// 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) SetReleasedCapacity added in v1.44.108 

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

SetReleasedCapacity sets the ReleasedCapacity 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 that you want to delete.
	//
	// BackupId is a required field
	BackupId *string `min:"12" type:"string" required:"true"`

	// A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent
	// deletion. This parameter 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 the 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 that was deleted.
	BackupId *string `min:"12" type:"string"`

	// The lifecycle status of the backup. If the DeleteBackup operation is successful,
	// the status is DELETED.
	Lifecycle *string `type:"string" enum:"BackupLifecycle"`
	// contains filtered or unexported fields
}

The response object for the 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 DeleteDataRepositoryAssociationInput added in v1.42.16 

type DeleteDataRepositoryAssociationInput struct {

	// The ID of the data repository association that you want to delete.
	//
	// AssociationId is a required field
	AssociationId *string `min:"13" type:"string" required:"true"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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"`

	// Set to true to delete the data in the file system that corresponds to the
	// data repository association.
	DeleteDataInFileSystem *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteDataRepositoryAssociationInput) GoString added in v1.42.16 

func (s DeleteDataRepositoryAssociationInput) 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 (*DeleteDataRepositoryAssociationInput) SetAssociationId added in v1.42.16 

func (s *DeleteDataRepositoryAssociationInput) SetAssociationId(v string) *DeleteDataRepositoryAssociationInput

SetAssociationId sets the AssociationId field's value.

func (*DeleteDataRepositoryAssociationInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteDataRepositoryAssociationInput) SetDeleteDataInFileSystem added in v1.42.16 

func (s *DeleteDataRepositoryAssociationInput) SetDeleteDataInFileSystem(v bool) *DeleteDataRepositoryAssociationInput

SetDeleteDataInFileSystem sets the DeleteDataInFileSystem field's value.

func (DeleteDataRepositoryAssociationInput) String added in v1.42.16 

func (s DeleteDataRepositoryAssociationInput) 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 (*DeleteDataRepositoryAssociationInput) Validate added in v1.42.16 

func (s *DeleteDataRepositoryAssociationInput) Validate() error

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

type DeleteDataRepositoryAssociationOutput added in v1.42.16 

type DeleteDataRepositoryAssociationOutput struct {

	// The ID of the data repository association being deleted.
	AssociationId *string `min:"13" type:"string"`

	// Indicates whether data in the file system that corresponds to the data repository
	// association is being deleted. Default is false.
	DeleteDataInFileSystem *bool `type:"boolean"`

	// Describes the lifecycle state of the data repository association being deleted.
	Lifecycle *string `type:"string" enum:"DataRepositoryLifecycle"`
	// contains filtered or unexported fields
}

func (DeleteDataRepositoryAssociationOutput) GoString added in v1.42.16 

func (s DeleteDataRepositoryAssociationOutput) 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 (*DeleteDataRepositoryAssociationOutput) SetAssociationId added in v1.42.16 

func (s *DeleteDataRepositoryAssociationOutput) SetAssociationId(v string) *DeleteDataRepositoryAssociationOutput

SetAssociationId sets the AssociationId field's value.

func (*DeleteDataRepositoryAssociationOutput) SetDeleteDataInFileSystem added in v1.42.16 

func (s *DeleteDataRepositoryAssociationOutput) SetDeleteDataInFileSystem(v bool) *DeleteDataRepositoryAssociationOutput

SetDeleteDataInFileSystem sets the DeleteDataInFileSystem field's value.

func (*DeleteDataRepositoryAssociationOutput) SetLifecycle added in v1.42.16 

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

SetLifecycle sets the Lifecycle field's value.

func (DeleteDataRepositoryAssociationOutput) String added in v1.42.16 

func (s DeleteDataRepositoryAssociationOutput) 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 DeleteFileCacheInput added in v1.44.108 

type DeleteFileCacheInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 cache that's being deleted.
	//
	// FileCacheId is a required field
	FileCacheId *string `min:"11" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFileCacheInput) GoString added in v1.44.108 

func (s DeleteFileCacheInput) 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 (*DeleteFileCacheInput) SetClientRequestToken added in v1.44.108 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteFileCacheInput) SetFileCacheId added in v1.44.108 

func (s *DeleteFileCacheInput) SetFileCacheId(v string) *DeleteFileCacheInput

SetFileCacheId sets the FileCacheId field's value.

func (DeleteFileCacheInput) String added in v1.44.108 

func (s DeleteFileCacheInput) 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 (*DeleteFileCacheInput) Validate added in v1.44.108 

func (s *DeleteFileCacheInput) Validate() error

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

type DeleteFileCacheOutput added in v1.44.108 

type DeleteFileCacheOutput struct {

	// The ID of the cache that's being deleted.
	FileCacheId *string `min:"11" type:"string"`

	// The cache lifecycle for the deletion request. If the DeleteFileCache operation
	// is successful, this status is DELETING.
	Lifecycle *string `type:"string" enum:"FileCacheLifecycle"`
	// contains filtered or unexported fields
}

func (DeleteFileCacheOutput) GoString added in v1.44.108 

func (s DeleteFileCacheOutput) 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 (*DeleteFileCacheOutput) SetFileCacheId added in v1.44.108 

func (s *DeleteFileCacheOutput) SetFileCacheId(v string) *DeleteFileCacheOutput

SetFileCacheId sets the FileCacheId field's value.

func (*DeleteFileCacheOutput) SetLifecycle added in v1.44.108 

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

SetLifecycle sets the Lifecycle field's value.

func (DeleteFileCacheOutput) String added in v1.44.108 

func (s DeleteFileCacheOutput) 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 63 ASCII characters that Amazon FSx uses to ensure idempotent
	// deletion. This token 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 that 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 OpenZFS file system used in the DeleteFileSystem
	// operation.
	OpenZFSConfiguration *DeleteFileSystemOpenZFSConfiguration `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) SetOpenZFSConfiguration added in v1.42.16 

func (s *DeleteFileSystemInput) SetOpenZFSConfiguration(v *DeleteFileSystemOpenZFSConfiguration) *DeleteFileSystemInput

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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)
	//
	// The fsx:CreateBackup permission is required if you set SkipFinalBackup to
	// false in order to delete the file system and take a final backup.
	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 DeleteFileSystemOpenZFSConfiguration added in v1.42.16 

type DeleteFileSystemOpenZFSConfiguration struct {

	// A list of tags to apply to the file system's final backup.
	FinalBackupTags []*Tag `min:"1" type:"list"`

	// To delete a file system if there are child volumes present below the root
	// volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system
	// has child volumes and you don't use this option, the delete request will
	// fail.
	Options []*string `type:"list" enum:"DeleteFileSystemOpenZFSOption"`

	// By default, Amazon FSx for OpenZFS 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 taking a final backup, set this value to true.
	SkipFinalBackup *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The configuration object for the Amazon FSx for OpenZFS file system used in the DeleteFileSystem operation.

func (DeleteFileSystemOpenZFSConfiguration) GoString added in v1.42.16 

func (s DeleteFileSystemOpenZFSConfiguration) 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 (*DeleteFileSystemOpenZFSConfiguration) SetFinalBackupTags added in v1.42.16 

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

SetFinalBackupTags sets the FinalBackupTags field's value.

func (*DeleteFileSystemOpenZFSConfiguration) SetOptions added in v1.43.8 

func (s *DeleteFileSystemOpenZFSConfiguration) SetOptions(v []*string) *DeleteFileSystemOpenZFSConfiguration

SetOptions sets the Options field's value.

func (*DeleteFileSystemOpenZFSConfiguration) SetSkipFinalBackup added in v1.42.16 

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

SetSkipFinalBackup sets the SkipFinalBackup field's value.

func (DeleteFileSystemOpenZFSConfiguration) String added in v1.42.16 

func (s DeleteFileSystemOpenZFSConfiguration) 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 (*DeleteFileSystemOpenZFSConfiguration) Validate added in v1.42.16 

func (s *DeleteFileSystemOpenZFSConfiguration) Validate() error

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

type DeleteFileSystemOpenZFSResponse added in v1.42.16 

type DeleteFileSystemOpenZFSResponse struct {

	// The ID of the source backup. Specifies the backup that 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 OpenZFS file system that's being deleted in the DeleteFileSystem operation.

func (DeleteFileSystemOpenZFSResponse) GoString added in v1.42.16 

func (s DeleteFileSystemOpenZFSResponse) 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 (*DeleteFileSystemOpenZFSResponse) SetFinalBackupId added in v1.42.16 

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

SetFinalBackupId sets the FinalBackupId field's value.

func (*DeleteFileSystemOpenZFSResponse) SetFinalBackupTags added in v1.42.16 

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

SetFinalBackupTags sets the FinalBackupTags field's value.

func (DeleteFileSystemOpenZFSResponse) String added in v1.42.16 

func (s DeleteFileSystemOpenZFSResponse) 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 that's being deleted.
	FileSystemId *string `min:"11" type:"string"`

	// The file system lifecycle for the deletion request. If the DeleteFileSystem
	// operation is successful, this status is 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 OpenZFS file system that's being deleted in the
	// DeleteFileSystem operation.
	OpenZFSResponse *DeleteFileSystemOpenZFSResponse `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) SetOpenZFSResponse added in v1.42.16 

func (s *DeleteFileSystemOutput) SetOpenZFSResponse(v *DeleteFileSystemOpenZFSResponse) *DeleteFileSystemOutput

SetOpenZFSResponse sets the OpenZFSResponse 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 DeleteSnapshotInput added in v1.42.16 

type DeleteSnapshotInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 snapshot that you want to delete.
	//
	// SnapshotId is a required field
	SnapshotId *string `min:"11" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSnapshotInput) GoString added in v1.42.16 

func (s DeleteSnapshotInput) 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 (*DeleteSnapshotInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteSnapshotInput) SetSnapshotId added in v1.42.16 

func (s *DeleteSnapshotInput) SetSnapshotId(v string) *DeleteSnapshotInput

SetSnapshotId sets the SnapshotId field's value.

func (DeleteSnapshotInput) String added in v1.42.16 

func (s DeleteSnapshotInput) 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 (*DeleteSnapshotInput) Validate added in v1.42.16 

func (s *DeleteSnapshotInput) Validate() error

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

type DeleteSnapshotOutput added in v1.42.16 

type DeleteSnapshotOutput struct {

	// The lifecycle status of the snapshot. If the DeleteSnapshot operation is
	// successful, this status is DELETING.
	Lifecycle *string `type:"string" enum:"SnapshotLifecycle"`

	// The ID of the deleted snapshot.
	SnapshotId *string `min:"11" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSnapshotOutput) GoString added in v1.42.16 

func (s DeleteSnapshotOutput) 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 (*DeleteSnapshotOutput) SetLifecycle added in v1.42.16 

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

SetLifecycle sets the Lifecycle field's value.

func (*DeleteSnapshotOutput) SetSnapshotId added in v1.42.16 

func (s *DeleteSnapshotOutput) SetSnapshotId(v string) *DeleteSnapshotOutput

SetSnapshotId sets the SnapshotId field's value.

func (DeleteSnapshotOutput) String added in v1.42.16 

func (s DeleteSnapshotOutput) 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 63 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 63 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. To apply tags to the backup,
	// you must have the fsx:TagResource permission.
	OntapConfiguration *DeleteVolumeOntapConfiguration `type:"structure"`

	// For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes
	// and snapshots.
	OpenZFSConfiguration *DeleteVolumeOpenZFSConfiguration `type:"structure"`

	// The ID of the volume that 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) SetOpenZFSConfiguration added in v1.42.16 

func (s *DeleteVolumeInput) SetOpenZFSConfiguration(v *DeleteVolumeOpenZFSConfiguration) *DeleteVolumeInput

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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 {

	// Setting this to true allows a SnapLock administrator to delete an FSx for
	// ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM)
	// files. The IAM permission fsx:BypassSnaplockEnterpriseRetention is also required
	// to delete SnapLock Enterprise volumes with unexpired WORM files. The default
	// value is false.
	//
	// For more information, see Deleting a SnapLock volume (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-delete-volume.html).
	BypassSnaplockEnterpriseRetention *bool `type:"boolean"`

	// 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, adding tags to a final backup, or bypassing the retention period of an FSx for ONTAP SnapLock Enterprise volume when deleting an FSx for ONTAP volume.

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) SetBypassSnaplockEnterpriseRetention added in v1.44.300 

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

SetBypassSnaplockEnterpriseRetention sets the BypassSnaplockEnterpriseRetention field's value.

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 that 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 DeleteVolumeOpenZFSConfiguration added in v1.42.16 

type DeleteVolumeOpenZFSConfiguration struct {

	// To delete the volume's child volumes, snapshots, and clones, use the string
	// DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.
	Options []*string `type:"list" enum:"DeleteOpenZFSVolumeOption"`
	// contains filtered or unexported fields
}

A value that specifies whether to delete all child volumes and snapshots.

func (DeleteVolumeOpenZFSConfiguration) GoString added in v1.42.16 

func (s DeleteVolumeOpenZFSConfiguration) 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 (*DeleteVolumeOpenZFSConfiguration) SetOptions added in v1.42.16 

func (s *DeleteVolumeOpenZFSConfiguration) SetOptions(v []*string) *DeleteVolumeOpenZFSConfiguration

SetOptions sets the Options field's value.

func (DeleteVolumeOpenZFSConfiguration) String added in v1.42.16 

func (s DeleteVolumeOpenZFSConfiguration) 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 {

	// The lifecycle state of the volume being deleted. If the DeleteVolume operation
	// is successful, this value is DELETING.
	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 that's 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 {

	// The IDs of the backups that you want to retrieve. This parameter value overrides
	// any filters. If any IDs aren't found, a BackupNotFound error occurs.
	BackupIds []*string `type:"list"`

	// The filters structure. The 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. 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"`

	// An opaque pagination token returned from a previous DescribeBackups operation.
	// If a token is present, the operation 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 the 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"`

	// A NextToken value is present if there are more backups than returned in the
	// response. You can use the NextToken value in the subsequent request to fetch
	// the backups.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Response object for the 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 DescribeDataRepositoryAssociationsInput added in v1.42.16 

type DescribeDataRepositoryAssociationsInput struct {

	// IDs of the data repository associations whose descriptions you want to retrieve
	// (String).
	AssociationIds []*string `type:"list"`

	// A list of Filter elements.
	Filters []*Filter `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"`
	// contains filtered or unexported fields
}

func (DescribeDataRepositoryAssociationsInput) GoString added in v1.42.16 

func (s DescribeDataRepositoryAssociationsInput) 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 (*DescribeDataRepositoryAssociationsInput) SetAssociationIds added in v1.42.16 

func (s *DescribeDataRepositoryAssociationsInput) SetAssociationIds(v []*string) *DescribeDataRepositoryAssociationsInput

SetAssociationIds sets the AssociationIds field's value.

func (*DescribeDataRepositoryAssociationsInput) SetFilters added in v1.42.16 

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

SetFilters sets the Filters field's value.

func (*DescribeDataRepositoryAssociationsInput) SetMaxResults added in v1.42.16 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeDataRepositoryAssociationsInput) SetNextToken added in v1.42.16 

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

SetNextToken sets the NextToken field's value.

func (DescribeDataRepositoryAssociationsInput) String added in v1.42.16 

func (s DescribeDataRepositoryAssociationsInput) 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 (*DescribeDataRepositoryAssociationsInput) Validate added in v1.42.16 

func (s *DescribeDataRepositoryAssociationsInput) Validate() error

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

type DescribeDataRepositoryAssociationsOutput added in v1.42.16 

type DescribeDataRepositoryAssociationsOutput struct {

	// An array of one or more data repository association descriptions.
	Associations []*DataRepositoryAssociation `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 (DescribeDataRepositoryAssociationsOutput) GoString added in v1.42.16 

func (s DescribeDataRepositoryAssociationsOutput) 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 (*DescribeDataRepositoryAssociationsOutput) SetAssociations added in v1.42.16 

func (s *DescribeDataRepositoryAssociationsOutput) SetAssociations(v []*DataRepositoryAssociation) *DescribeDataRepositoryAssociationsOutput

SetAssociations sets the Associations field's value.

func (*DescribeDataRepositoryAssociationsOutput) SetNextToken added in v1.42.16 

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

SetNextToken sets the NextToken field's value.

func (DescribeDataRepositoryAssociationsOutput) String added in v1.42.16 

func (s DescribeDataRepositoryAssociationsOutput) 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 DescribeFileCachesInput added in v1.44.108 

type DescribeFileCachesInput struct {

	// IDs of the caches whose descriptions you want to retrieve (String).
	FileCacheIds []*string `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"`
	// contains filtered or unexported fields
}

func (DescribeFileCachesInput) GoString added in v1.44.108 

func (s DescribeFileCachesInput) 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 (*DescribeFileCachesInput) SetFileCacheIds added in v1.44.108 

func (s *DescribeFileCachesInput) SetFileCacheIds(v []*string) *DescribeFileCachesInput

SetFileCacheIds sets the FileCacheIds field's value.

func (*DescribeFileCachesInput) SetMaxResults added in v1.44.108 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeFileCachesInput) SetNextToken added in v1.44.108 

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

SetNextToken sets the NextToken field's value.

func (DescribeFileCachesInput) String added in v1.44.108 

func (s DescribeFileCachesInput) 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 (*DescribeFileCachesInput) Validate added in v1.44.108 

func (s *DescribeFileCachesInput) Validate() error

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

type DescribeFileCachesOutput added in v1.44.108 

type DescribeFileCachesOutput struct {

	// The response object for the DescribeFileCaches operation.
	FileCaches []*FileCache `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 (DescribeFileCachesOutput) GoString added in v1.44.108 

func (s DescribeFileCachesOutput) 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 (*DescribeFileCachesOutput) SetFileCaches added in v1.44.108 

func (s *DescribeFileCachesOutput) SetFileCaches(v []*FileCache) *DescribeFileCachesOutput

SetFileCaches sets the FileCaches field's value.

func (*DescribeFileCachesOutput) SetNextToken added in v1.44.108 

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

SetNextToken sets the NextToken field's value.

func (DescribeFileCachesOutput) String added in v1.44.108 

func (s DescribeFileCachesOutput) 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 63 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 operation 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 DescribeSharedVpcConfigurationInput added in v1.48.4 

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

func (DescribeSharedVpcConfigurationInput) GoString added in v1.48.4 

func (s DescribeSharedVpcConfigurationInput) 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 (DescribeSharedVpcConfigurationInput) String added in v1.48.4 

func (s DescribeSharedVpcConfigurationInput) 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 DescribeSharedVpcConfigurationOutput added in v1.48.4 

type DescribeSharedVpcConfigurationOutput struct {

	// Indicates whether participant accounts can create FSx for ONTAP Multi-AZ
	// file systems in shared subnets.
	EnableFsxRouteTableUpdatesFromParticipantAccounts *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeSharedVpcConfigurationOutput) GoString added in v1.48.4 

func (s DescribeSharedVpcConfigurationOutput) 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 (*DescribeSharedVpcConfigurationOutput) SetEnableFsxRouteTableUpdatesFromParticipantAccounts added in v1.48.4 

func (s *DescribeSharedVpcConfigurationOutput) SetEnableFsxRouteTableUpdatesFromParticipantAccounts(v string) *DescribeSharedVpcConfigurationOutput

SetEnableFsxRouteTableUpdatesFromParticipantAccounts sets the EnableFsxRouteTableUpdatesFromParticipantAccounts field's value.

func (DescribeSharedVpcConfigurationOutput) String added in v1.48.4 

func (s DescribeSharedVpcConfigurationOutput) 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 DescribeSnapshotsInput added in v1.42.16 

type DescribeSnapshotsInput struct {

	// The filters structure. The supported names are file-system-id or volume-id.
	Filters []*SnapshotFilter `type:"list"`

	// Set to false (default) if you want to only see the snapshots owned by your
	// Amazon Web Services account. Set to true if you want to see the snapshots
	// in your account and the ones shared with you from another account.
	IncludeShared *bool `type:"boolean"`

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

	// The IDs of the snapshots that you want to retrieve. This parameter value
	// overrides any filters. If any IDs aren't found, a SnapshotNotFound error
	// occurs.
	SnapshotIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSnapshotsInput) GoString added in v1.42.16 

func (s DescribeSnapshotsInput) 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 (*DescribeSnapshotsInput) SetFilters added in v1.42.16 

func (s *DescribeSnapshotsInput) SetFilters(v []*SnapshotFilter) *DescribeSnapshotsInput

SetFilters sets the Filters field's value.

func (*DescribeSnapshotsInput) SetIncludeShared added in v1.49.6 

func (s *DescribeSnapshotsInput) SetIncludeShared(v bool) *DescribeSnapshotsInput

SetIncludeShared sets the IncludeShared field's value.

func (*DescribeSnapshotsInput) SetMaxResults added in v1.42.16 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeSnapshotsInput) SetNextToken added in v1.42.16 

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

SetNextToken sets the NextToken field's value.

func (*DescribeSnapshotsInput) SetSnapshotIds added in v1.42.16 

func (s *DescribeSnapshotsInput) SetSnapshotIds(v []*string) *DescribeSnapshotsInput

SetSnapshotIds sets the SnapshotIds field's value.

func (DescribeSnapshotsInput) String added in v1.42.16 

func (s DescribeSnapshotsInput) 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 (*DescribeSnapshotsInput) Validate added in v1.42.16 

func (s *DescribeSnapshotsInput) Validate() error

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

type DescribeSnapshotsOutput added in v1.42.16 

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

	// An array of snapshots.
	Snapshots []*Snapshot `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeSnapshotsOutput) GoString added in v1.42.16 

func (s DescribeSnapshotsOutput) 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 (*DescribeSnapshotsOutput) SetNextToken added in v1.42.16 

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

SetNextToken sets the NextToken field's value.

func (*DescribeSnapshotsOutput) SetSnapshots added in v1.42.16 

func (s *DescribeSnapshotsOutput) SetSnapshots(v []*Snapshot) *DescribeSnapshotsOutput

SetSnapshots sets the Snapshots field's value.

func (DescribeSnapshotsOutput) String added in v1.42.16 

func (s DescribeSnapshotsOutput) 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 and Values 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"`

	// The 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 63 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.
	//
	// The minimum and maximum values for this property depend on the value of HAPairs
	// and StorageCapacity. The minimum value is calculated as StorageCapacity *
	// 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated
	// as 200,000 * HAPairs.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value
	// of Iops is outside of the minimum or maximum values.
	Iops *int64 `type:"long"`

	// Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS
	// of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.
	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, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

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

type DurationSinceLastAccess struct {

	// The unit of time used by the Value parameter to determine if a file can be
	// released, based on when it was last accessed. DAYS is the only supported
	// value. This is a required parameter.
	Unit *string `type:"string" enum:"Unit"`

	// An integer that represents the minimum amount of time (in days) since a file
	// was last accessed in the file system. Only exported files with a MAX(atime,
	// ctime, mtime) timestamp that is more than this amount of time in the past
	// (relative to the task create time) will be released. The default of Value
	// is 0. This is a required parameter.
	//
	// If an exported file meets the last accessed time criteria, its file or directory
	// path must also be specified in the Paths parameter of the operation in order
	// for the file to be released.
	Value *int64 `type:"long"`
	// contains filtered or unexported fields
}

Defines the minimum amount of time since last access for a file to be eligible for release. Only files that have been exported to S3 and that were last accessed or modified before this point-in-time are eligible to be released from the Amazon FSx for Lustre file system.

func (DurationSinceLastAccess) GoString added in v1.44.320 

func (s DurationSinceLastAccess) 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 (*DurationSinceLastAccess) SetUnit added in v1.44.320 

func (s *DurationSinceLastAccess) SetUnit(v string) *DurationSinceLastAccess

SetUnit sets the Unit field's value.

func (*DurationSinceLastAccess) SetValue added in v1.44.320 

func (s *DurationSinceLastAccess) SetValue(v int64) *DurationSinceLastAccess

SetValue sets the Value field's value.

func (DurationSinceLastAccess) String added in v1.44.320 

func (s DurationSinceLastAccess) 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 am export 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.

For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.

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

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

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

For more information about creating backup copies, see Copying backups (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html#copy-backups) in the Amazon FSx for Windows User Guide, Copying backups (https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html#copy-backups) in the Amazon FSx for Lustre User Guide, and Copying backups (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html#copy-backups) in the Amazon FSx for OpenZFS 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 not valid.

  • InvalidDestinationKmsKey The Key Management Service (KMS) key of the destination backup is not valid.

  • InvalidRegion The Region provided for SourceRegion is not valid or is in a different Amazon Web Services partition.

  • SourceBackupUnavailable The request was rejected because the lifecycle status of the source backup isn't 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) CopySnapshotAndUpdateVolume added in v1.48.4 

func (c *FSx) CopySnapshotAndUpdateVolume(input *CopySnapshotAndUpdateVolumeInput) (*CopySnapshotAndUpdateVolumeOutput, error)

CopySnapshotAndUpdateVolume API operation for Amazon FSx.

Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/on-demand-replication.html) in the Amazon FSx for OpenZFS 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 CopySnapshotAndUpdateVolume 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.

  • 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/CopySnapshotAndUpdateVolume

func (*FSx) CopySnapshotAndUpdateVolumeRequest added in v1.48.4 

func (c *FSx) CopySnapshotAndUpdateVolumeRequest(input *CopySnapshotAndUpdateVolumeInput) (req *request.Request, output *CopySnapshotAndUpdateVolumeOutput)

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

func (*FSx) CopySnapshotAndUpdateVolumeWithContext added in v1.48.4 

func (c *FSx) CopySnapshotAndUpdateVolumeWithContext(ctx aws.Context, input *CopySnapshotAndUpdateVolumeInput, opts ...request.Option) (*CopySnapshotAndUpdateVolumeOutput, error)

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

See CopySnapshotAndUpdateVolume 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 file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

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

  • A Persistent deployment type

  • Are not linked to a data repository

For more information about backups, see the following:

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

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

  • Returns the description of the backup.

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

The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html) 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 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) CreateDataRepositoryAssociation added in v1.42.16 

func (c *FSx) CreateDataRepositoryAssociation(input *CreateDataRepositoryAssociationInput) (*CreateDataRepositoryAssociationOutput, error)

CreateDataRepositoryAssociation API operation for Amazon FSx.

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

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket (https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html).

CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

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

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

func (*FSx) CreateDataRepositoryAssociationRequest added in v1.42.16 

func (c *FSx) CreateDataRepositoryAssociationRequest(input *CreateDataRepositoryAssociationInput) (req *request.Request, output *CreateDataRepositoryAssociationOutput)

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

func (*FSx) CreateDataRepositoryAssociationWithContext added in v1.42.16 

func (c *FSx) CreateDataRepositoryAssociationWithContext(ctx aws.Context, input *CreateDataRepositoryAssociationInput, opts ...request.Option) (*CreateDataRepositoryAssociationOutput, error)

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

See CreateDataRepositoryAssociation 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. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.

You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository.

You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre 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-dra-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) CreateFileCache added in v1.44.108 

func (c *FSx) CreateFileCache(input *CreateFileCacheInput) (*CreateFileCacheOutput, error)

CreateFileCache API operation for Amazon FSx.

Creates a new Amazon File Cache resource.

You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:

  • Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the cache in JSON format.

The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) operation, which returns the cache 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 CreateFileCache 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.

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

  • MissingFileCacheConfiguration A cache configuration is required for this operation.

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

func (*FSx) CreateFileCacheRequest added in v1.44.108 

func (c *FSx) CreateFileCacheRequest(input *CreateFileCacheInput) (req *request.Request, output *CreateFileCacheOutput)

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

func (*FSx) CreateFileCacheWithContext added in v1.44.108 

func (c *FSx) CreateFileCacheWithContext(ctx aws.Context, input *CreateFileCacheInput, opts ...request.Option) (*CreateFileCacheOutput, error)

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

See CreateFileCache 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. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

  • Amazon FSx for Lustre

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

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

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

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

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 (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) 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, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

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

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

  • Returns the description of the file system.

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

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) 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) CreateSnapshot added in v1.42.16 

func (c *FSx) CreateSnapshot(input *CreateSnapshotInput) (*CreateSnapshotOutput, error)

CreateSnapshot API operation for Amazon FSx.

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

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

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

  • Returns the description of the snapshot.

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

The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html) operation, which returns the snapshot 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 CreateSnapshot for usage and error information.

Returned Error Types:

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

  • VolumeNotFound No Amazon FSx volumes 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.

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

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

func (*FSx) CreateSnapshotRequest added in v1.42.16 

func (c *FSx) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Request, output *CreateSnapshotOutput)

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

func (*FSx) CreateSnapshotWithContext added in v1.42.16 

func (c *FSx) CreateSnapshotWithContext(ctx aws.Context, input *CreateSnapshotInput, opts ...request.Option) (*CreateSnapshotOutput, error)

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

See CreateSnapshot 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 FSx for ONTAP or Amazon FSx for OpenZFS 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 FSx for 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 FSx for 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. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup won't 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) DeleteDataRepositoryAssociation added in v1.42.16 

func (c *FSx) DeleteDataRepositoryAssociation(input *DeleteDataRepositoryAssociationInput) (*DeleteDataRepositoryAssociationOutput, error)

DeleteDataRepositoryAssociation API operation for Amazon FSx.

Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

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

  • DataRepositoryAssociationNotFound No data repository associations 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.

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

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

func (*FSx) DeleteDataRepositoryAssociationRequest added in v1.42.16 

func (c *FSx) DeleteDataRepositoryAssociationRequest(input *DeleteDataRepositoryAssociationInput) (req *request.Request, output *DeleteDataRepositoryAssociationOutput)

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

func (*FSx) DeleteDataRepositoryAssociationWithContext added in v1.42.16 

func (c *FSx) DeleteDataRepositoryAssociationWithContext(ctx aws.Context, input *DeleteDataRepositoryAssociationInput, opts ...request.Option) (*DeleteDataRepositoryAssociationOutput, error)

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

See DeleteDataRepositoryAssociation 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) DeleteFileCache added in v1.44.108 

func (c *FSx) DeleteFileCache(input *DeleteFileCacheInput) (*DeleteFileCacheOutput, error)

DeleteFileCache API operation for Amazon FSx.

Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.

The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html) operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error.

The data in a deleted cache 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 DeleteFileCache 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.

  • FileCacheNotFound No caches 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/DeleteFileCache

func (*FSx) DeleteFileCacheRequest added in v1.44.108 

func (c *FSx) DeleteFileCacheRequest(input *DeleteFileCacheInput) (req *request.Request, output *DeleteFileCacheOutput)

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

func (*FSx) DeleteFileCacheWithContext added in v1.44.108 

func (c *FSx) DeleteFileCacheWithContext(ctx aws.Context, input *DeleteFileCacheInput, opts ...request.Option) (*DeleteFileCacheOutput, error)

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

See DeleteFileCache 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. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId value to the DeleteFileSystem 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 isn't subject to the file system's retention policy, and must be manually deleted.

To delete an Amazon FSx for Lustre file system, first unmount (https://docs.aws.amazon.com/fsx/latest/LustreGuide/unmounting-fs.html) it from every connected Amazon EC2 instance, then provide a FileSystemId value to the DeleteFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage (https://docs.aws.amazon.com/fsx/latest/LustreGuide/monitoring-cloudwatch.html#auto-import-export-metrics) metric to be zero (if using automatic export) or you can run an export data repository task (https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repo-task-dra.html). If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.

The DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems (https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html) operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error.

If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).

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) DeleteSnapshot added in v1.42.16 

func (c *FSx) DeleteSnapshot(input *DeleteSnapshotInput) (*DeleteSnapshotOutput, error)

DeleteSnapshot API operation for Amazon FSx.

Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.

The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.

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

  • SnapshotNotFound No Amazon FSx snapshots were found based on the supplied parameters.

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

func (*FSx) DeleteSnapshotRequest added in v1.42.16 

func (c *FSx) DeleteSnapshotRequest(input *DeleteSnapshotInput) (req *request.Request, output *DeleteSnapshotOutput)

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

func (*FSx) DeleteSnapshotWithContext added in v1.42.16 

func (c *FSx) DeleteSnapshotWithContext(ctx aws.Context, input *DeleteSnapshotInput, opts ...request.Option) (*DeleteSnapshotOutput, error)

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

See DeleteSnapshot 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 FSx for 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 or Amazon FSx for OpenZFS 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 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 volumes 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.

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 a specific Amazon FSx backup, 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 the NextToken value from the last response.

This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

  • The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.

  • The order of the backups returned in the response of one DescribeBackups call and the order of the 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 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) DescribeDataRepositoryAssociations added in v1.42.16 

func (c *FSx) DescribeDataRepositoryAssociations(input *DescribeDataRepositoryAssociationsInput) (*DescribeDataRepositoryAssociationsOutput, error)

DescribeDataRepositoryAssociations API operation for Amazon FSx.

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type.

You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned 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 DescribeDataRepositoryAssociations 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.

  • DataRepositoryAssociationNotFound No data repository associations were found based upon the supplied parameters.

  • InvalidDataRepositoryType You have filtered the response to a data repository type that is not supported.

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

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

func (*FSx) DescribeDataRepositoryAssociationsPages added in v1.42.16 

func (c *FSx) DescribeDataRepositoryAssociationsPages(input *DescribeDataRepositoryAssociationsInput, fn func(*DescribeDataRepositoryAssociationsOutput, bool) bool) error

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

See DescribeDataRepositoryAssociations 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 DescribeDataRepositoryAssociations operation.
pageNum := 0
err := client.DescribeDataRepositoryAssociationsPages(params,
    func(page *fsx.DescribeDataRepositoryAssociationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeDataRepositoryAssociationsPagesWithContext added in v1.42.16 

func (c *FSx) DescribeDataRepositoryAssociationsPagesWithContext(ctx aws.Context, input *DescribeDataRepositoryAssociationsInput, fn func(*DescribeDataRepositoryAssociationsOutput, bool) bool, opts ...request.Option) error

DescribeDataRepositoryAssociationsPagesWithContext same as DescribeDataRepositoryAssociationsPages 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) DescribeDataRepositoryAssociationsRequest added in v1.42.16 

func (c *FSx) DescribeDataRepositoryAssociationsRequest(input *DescribeDataRepositoryAssociationsInput) (req *request.Request, output *DescribeDataRepositoryAssociationsOutput)

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

func (*FSx) DescribeDataRepositoryAssociationsWithContext added in v1.42.16 

func (c *FSx) DescribeDataRepositoryAssociationsWithContext(ctx aws.Context, input *DescribeDataRepositoryAssociationsInput, opts ...request.Option) (*DescribeDataRepositoryAssociationsOutput, error)

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

See DescribeDataRepositoryAssociations 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 or Amazon File Cache 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 caches, 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, a NextToken value is returned 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) DescribeFileCaches added in v1.44.108 

func (c *FSx) DescribeFileCaches(input *DescribeFileCachesInput) (*DescribeFileCachesOutput, error)

DescribeFileCaches API operation for Amazon FSx.

Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation 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 operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation 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 operation, keep the following in mind:

  • The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.

  • The order of caches returned in the response of one DescribeFileCaches call and the order of caches 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 DescribeFileCaches for usage and error information.

Returned Error Types:

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

  • FileCacheNotFound No caches 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/DescribeFileCaches

func (*FSx) DescribeFileCachesPages added in v1.44.108 

func (c *FSx) DescribeFileCachesPages(input *DescribeFileCachesInput, fn func(*DescribeFileCachesOutput, bool) bool) error

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

See DescribeFileCaches 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 DescribeFileCaches operation.
pageNum := 0
err := client.DescribeFileCachesPages(params,
    func(page *fsx.DescribeFileCachesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeFileCachesPagesWithContext added in v1.44.108 

func (c *FSx) DescribeFileCachesPagesWithContext(ctx aws.Context, input *DescribeFileCachesInput, fn func(*DescribeFileCachesOutput, bool) bool, opts ...request.Option) error

DescribeFileCachesPagesWithContext same as DescribeFileCachesPages 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) DescribeFileCachesRequest added in v1.44.108 

func (c *FSx) DescribeFileCachesRequest(input *DescribeFileCachesInput) (req *request.Request, output *DescribeFileCachesOutput)

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

func (*FSx) DescribeFileCachesWithContext added in v1.44.108 

func (c *FSx) DescribeFileCachesWithContext(ctx aws.Context, input *DescribeFileCachesInput, opts ...request.Option) (*DescribeFileCachesOutput, error)

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

See DescribeFileCaches 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 operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation 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 operation, 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) DescribeSharedVpcConfiguration added in v1.48.4 

func (c *FSx) DescribeSharedVpcConfiguration(input *DescribeSharedVpcConfigurationInput) (*DescribeSharedVpcConfigurationOutput, error)

DescribeSharedVpcConfiguration API operation for Amazon FSx.

Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/creating-file-systems.html#fsxn-vpc-shared-subnets).

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

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

func (*FSx) DescribeSharedVpcConfigurationRequest added in v1.48.4 

func (c *FSx) DescribeSharedVpcConfigurationRequest(input *DescribeSharedVpcConfigurationInput) (req *request.Request, output *DescribeSharedVpcConfigurationOutput)

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

func (*FSx) DescribeSharedVpcConfigurationWithContext added in v1.48.4 

func (c *FSx) DescribeSharedVpcConfigurationWithContext(ctx aws.Context, input *DescribeSharedVpcConfigurationInput, opts ...request.Option) (*DescribeSharedVpcConfigurationOutput, error)

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

See DescribeSharedVpcConfiguration 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) DescribeSnapshots added in v1.42.16 

func (c *FSx) DescribeSnapshots(input *DescribeSnapshotsInput) (*DescribeSnapshotsOutput, error)

DescribeSnapshots API operation for Amazon FSx.

Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots 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.

Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

  • The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.

  • The order of snapshots returned in the response of one DescribeSnapshots 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 DescribeSnapshots 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.

  • SnapshotNotFound No Amazon FSx snapshots were found based on the supplied parameters.

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

func (*FSx) DescribeSnapshotsPages added in v1.42.16 

func (c *FSx) DescribeSnapshotsPages(input *DescribeSnapshotsInput, fn func(*DescribeSnapshotsOutput, bool) bool) error

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

See DescribeSnapshots 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 DescribeSnapshots operation.
pageNum := 0
err := client.DescribeSnapshotsPages(params,
    func(page *fsx.DescribeSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*FSx) DescribeSnapshotsPagesWithContext added in v1.42.16 

func (c *FSx) DescribeSnapshotsPagesWithContext(ctx aws.Context, input *DescribeSnapshotsInput, fn func(*DescribeSnapshotsOutput, bool) bool, opts ...request.Option) error

DescribeSnapshotsPagesWithContext same as DescribeSnapshotsPages 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) DescribeSnapshotsRequest added in v1.42.16 

func (c *FSx) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) (req *request.Request, output *DescribeSnapshotsOutput)

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

func (*FSx) DescribeSnapshotsWithContext added in v1.42.16 

func (c *FSx) DescribeSnapshotsWithContext(ctx aws.Context, input *DescribeSnapshotsInput, opts ...request.Option) (*DescribeSnapshotsOutput, error)

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

See DescribeSnapshots 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 FSx for 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 or Amazon FSx for OpenZFS 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 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 an HTTP status code 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 Amazon FSx resources.

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) ReleaseFileSystemNfsV3Locks added in v1.42.16 

func (c *FSx) ReleaseFileSystemNfsV3Locks(input *ReleaseFileSystemNfsV3LocksInput) (*ReleaseFileSystemNfsV3LocksOutput, error)

ReleaseFileSystemNfsV3Locks API operation for Amazon FSx.

Releases the file system lock from an Amazon FSx for OpenZFS 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 ReleaseFileSystemNfsV3Locks 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/ReleaseFileSystemNfsV3Locks

func (*FSx) ReleaseFileSystemNfsV3LocksRequest added in v1.42.16 

func (c *FSx) ReleaseFileSystemNfsV3LocksRequest(input *ReleaseFileSystemNfsV3LocksInput) (req *request.Request, output *ReleaseFileSystemNfsV3LocksOutput)

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

func (*FSx) ReleaseFileSystemNfsV3LocksWithContext added in v1.42.16 

func (c *FSx) ReleaseFileSystemNfsV3LocksWithContext(ctx aws.Context, input *ReleaseFileSystemNfsV3LocksInput, opts ...request.Option) (*ReleaseFileSystemNfsV3LocksOutput, error)

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

See ReleaseFileSystemNfsV3Locks 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) RestoreVolumeFromSnapshot added in v1.42.16 

func (c *FSx) RestoreVolumeFromSnapshot(input *RestoreVolumeFromSnapshotInput) (*RestoreVolumeFromSnapshotOutput, error)

RestoreVolumeFromSnapshot API operation for Amazon FSx.

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

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 RestoreVolumeFromSnapshot 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 volumes were found based upon the supplied parameters.

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

func (*FSx) RestoreVolumeFromSnapshotRequest added in v1.42.16 

func (c *FSx) RestoreVolumeFromSnapshotRequest(input *RestoreVolumeFromSnapshotInput) (req *request.Request, output *RestoreVolumeFromSnapshotOutput)

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

func (*FSx) RestoreVolumeFromSnapshotWithContext added in v1.42.16 

func (c *FSx) RestoreVolumeFromSnapshotWithContext(ctx aws.Context, input *RestoreVolumeFromSnapshotInput, opts ...request.Option) (*RestoreVolumeFromSnapshotOutput, error)

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

See RestoreVolumeFromSnapshot 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) StartMisconfiguredStateRecovery added in v1.45.24 

func (c *FSx) StartMisconfiguredStateRecovery(input *StartMisconfiguredStateRecoveryInput) (*StartMisconfiguredStateRecoveryOutput, error)

StartMisconfiguredStateRecovery API operation for Amazon FSx.

After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to 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 StartMisconfiguredStateRecovery 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/StartMisconfiguredStateRecovery

func (*FSx) StartMisconfiguredStateRecoveryRequest added in v1.45.24 

func (c *FSx) StartMisconfiguredStateRecoveryRequest(input *StartMisconfiguredStateRecoveryInput) (req *request.Request, output *StartMisconfiguredStateRecoveryOutput)

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

func (*FSx) StartMisconfiguredStateRecoveryWithContext added in v1.45.24 

func (c *FSx) StartMisconfiguredStateRecoveryWithContext(ctx aws.Context, input *StartMisconfiguredStateRecoveryInput, opts ...request.Option) (*StartMisconfiguredStateRecoveryOutput, error)

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

See StartMisconfiguredStateRecovery 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) UpdateDataRepositoryAssociation added in v1.42.16 

func (c *FSx) UpdateDataRepositoryAssociation(input *UpdateDataRepositoryAssociationInput) (*UpdateDataRepositoryAssociationOutput, error)

UpdateDataRepositoryAssociation API operation for Amazon FSx.

Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

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

  • DataRepositoryAssociationNotFound No data repository associations 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.

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

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

func (*FSx) UpdateDataRepositoryAssociationRequest added in v1.42.16 

func (c *FSx) UpdateDataRepositoryAssociationRequest(input *UpdateDataRepositoryAssociationInput) (req *request.Request, output *UpdateDataRepositoryAssociationOutput)

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

func (*FSx) UpdateDataRepositoryAssociationWithContext added in v1.42.16 

func (c *FSx) UpdateDataRepositoryAssociationWithContext(ctx aws.Context, input *UpdateDataRepositoryAssociationInput, opts ...request.Option) (*UpdateDataRepositoryAssociationOutput, error)

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

See UpdateDataRepositoryAssociation 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) UpdateFileCache added in v1.44.108 

func (c *FSx) UpdateFileCache(input *UpdateFileCacheInput) (*UpdateFileCacheOutput, error)

UpdateFileCache API operation for Amazon FSx.

Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.

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

  • FileCacheNotFound No caches were found based upon supplied parameters.

  • MissingFileCacheConfiguration A cache 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/UpdateFileCache

func (*FSx) UpdateFileCacheRequest added in v1.44.108 

func (c *FSx) UpdateFileCacheRequest(input *UpdateFileCacheInput) (req *request.Request, output *UpdateFileCacheOutput)

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

func (*FSx) UpdateFileCacheWithContext added in v1.44.108 

func (c *FSx) UpdateFileCacheWithContext(ctx aws.Context, input *UpdateFileCacheInput, opts ...request.Option) (*UpdateFileCacheOutput, error)

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

See UpdateFileCache 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 FSx for Windows File Server file systems, you can update the following properties:

  • AuditLogConfiguration

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • SelfManagedActiveDirectoryConfiguration

  • StorageCapacity

  • StorageType

  • ThroughputCapacity

  • DiskIopsConfiguration

  • WeeklyMaintenanceStartTime

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

  • AutoImportPolicy

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DataCompressionType

  • LogConfiguration

  • LustreRootSquashConfiguration

  • MetadataConfiguration

  • PerUnitStorageThroughput

  • StorageCapacity

  • WeeklyMaintenanceStartTime

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

  • AddRouteTableIds

  • AutomaticBackupRetentionDays

  • DailyAutomaticBackupStartTime

  • DiskIopsConfiguration

  • FsxAdminPassword

  • HAPairs

  • RemoveRouteTableIds

  • StorageCapacity

  • ThroughputCapacity

  • ThroughputCapacityPerHAPair

  • WeeklyMaintenanceStartTime

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

  • AddRouteTableIds

  • AutomaticBackupRetentionDays

  • CopyTagsToBackups

  • CopyTagsToVolumes

  • DailyAutomaticBackupStartTime

  • DiskIopsConfiguration

  • RemoveRouteTableIds

  • StorageCapacity

  • ThroughputCapacity

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

  • InvalidNetworkSettings One or more network settings specified in the request are invalid.

  • 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.ErrCodeInvalidNetworkSettings:
				fmt.Println(fsx.ErrCodeInvalidNetworkSettings, 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) UpdateSharedVpcConfiguration added in v1.48.4 

func (c *FSx) UpdateSharedVpcConfiguration(input *UpdateSharedVpcConfigurationInput) (*UpdateSharedVpcConfigurationOutput, error)

UpdateSharedVpcConfiguration API operation for Amazon FSx.

Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html).

We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more information, see Important considerations before disabling shared VPC support for Multi-AZ file systems (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/maz-shared-vpc.html#disabling-maz-vpc-sharing).

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

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

func (*FSx) UpdateSharedVpcConfigurationRequest added in v1.48.4 

func (c *FSx) UpdateSharedVpcConfigurationRequest(input *UpdateSharedVpcConfigurationInput) (req *request.Request, output *UpdateSharedVpcConfigurationOutput)

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

func (*FSx) UpdateSharedVpcConfigurationWithContext added in v1.48.4 

func (c *FSx) UpdateSharedVpcConfigurationWithContext(ctx aws.Context, input *UpdateSharedVpcConfigurationInput, opts ...request.Option) (*UpdateSharedVpcConfigurationOutput, error)

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

See UpdateSharedVpcConfiguration 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) UpdateSnapshot added in v1.42.16 

func (c *FSx) UpdateSnapshot(input *UpdateSnapshotInput) (*UpdateSnapshotOutput, error)

UpdateSnapshot API operation for Amazon FSx.

Updates the name of an Amazon FSx for OpenZFS snapshot.

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

Returned Error Types:

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

  • SnapshotNotFound No Amazon FSx snapshots were found based on 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/UpdateSnapshot

func (*FSx) UpdateSnapshotRequest added in v1.42.16 

func (c *FSx) UpdateSnapshotRequest(input *UpdateSnapshotInput) (req *request.Request, output *UpdateSnapshotOutput)

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

func (*FSx) UpdateSnapshotWithContext added in v1.42.16 

func (c *FSx) UpdateSnapshotWithContext(ctx aws.Context, input *UpdateSnapshotInput, opts ...request.Option) (*UpdateSnapshotOutput, error)

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

See UpdateSnapshot 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 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 FSx for 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 the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS 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 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 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 FileCache added in v1.44.108 

type FileCache 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 Domain Name System (DNS) name for the cache.
	DNSName *string `min:"16" type:"string"`

	// A list of IDs of data repository associations that are associated with this
	// cache.
	DataRepositoryAssociationIds []*string `type:"list"`

	// A structure providing details of any failures that occurred.
	FailureDetails *FileCacheFailureDetails `type:"structure"`

	// The system-generated, unique ID of the cache.
	FileCacheId *string `min:"11" type:"string"`

	// The type of cache, which must be LUSTRE.
	FileCacheType *string `type:"string" enum:"FileCacheType"`

	// The Lustre version of the cache, which must be 2.12.
	FileCacheTypeVersion *string `min:"1" type:"string"`

	// Specifies the ID of the Key Management Service (KMS) key to use for encrypting
	// data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed
	// KMS key for your account is used. 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 cache. The following are the possible values
	// and what they mean:
	//
	//    * AVAILABLE - The cache is in a healthy state, and is reachable and available
	//    for use.
	//
	//    * CREATING - The new cache is being created.
	//
	//    * DELETING - An existing cache is being deleted.
	//
	//    * UPDATING - The cache is undergoing a customer-initiated update.
	//
	//    * FAILED - An existing cache has experienced an unrecoverable failure.
	//    When creating a new cache, the cache was unable to be created.
	Lifecycle *string `type:"string" enum:"FileCacheLifecycle"`

	// The configuration for the Amazon File Cache resource.
	LustreConfiguration *FileCacheLustreConfiguration `type:"structure"`

	// A list of network interface IDs.
	NetworkInterfaceIds []*string `type:"list"`

	// 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 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 storage capacity of the cache in gibibytes (GiB).
	StorageCapacity *int64 `type:"integer"`

	// A list of subnet IDs that the cache will be accessible from. You can specify
	// only one subnet ID in a call to the CreateFileCache operation.
	SubnetIds []*string `type:"list"`

	// The ID of 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.
	VpcId *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

A description of a specific Amazon File Cache resource, which is a response object from the DescribeFileCaches operation.

func (FileCache) GoString added in v1.44.108 

func (s FileCache) 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 (*FileCache) SetCreationTime added in v1.44.108 

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

SetCreationTime sets the CreationTime field's value.

func (*FileCache) SetDNSName added in v1.44.108 

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

SetDNSName sets the DNSName field's value.

func (*FileCache) SetDataRepositoryAssociationIds added in v1.44.108 

func (s *FileCache) SetDataRepositoryAssociationIds(v []*string) *FileCache

SetDataRepositoryAssociationIds sets the DataRepositoryAssociationIds field's value.

func (*FileCache) SetFailureDetails added in v1.44.108 

func (s *FileCache) SetFailureDetails(v *FileCacheFailureDetails) *FileCache

SetFailureDetails sets the FailureDetails field's value.

func (*FileCache) SetFileCacheId added in v1.44.108 

func (s *FileCache) SetFileCacheId(v string) *FileCache

SetFileCacheId sets the FileCacheId field's value.

func (*FileCache) SetFileCacheType added in v1.44.108 

func (s *FileCache) SetFileCacheType(v string) *FileCache

SetFileCacheType sets the FileCacheType field's value.

func (*FileCache) SetFileCacheTypeVersion added in v1.44.108 

func (s *FileCache) SetFileCacheTypeVersion(v string) *FileCache

SetFileCacheTypeVersion sets the FileCacheTypeVersion field's value.

func (*FileCache) SetKmsKeyId added in v1.44.108 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*FileCache) SetLifecycle added in v1.44.108 

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

SetLifecycle sets the Lifecycle field's value.

func (*FileCache) SetLustreConfiguration added in v1.44.108 

func (s *FileCache) SetLustreConfiguration(v *FileCacheLustreConfiguration) *FileCache

SetLustreConfiguration sets the LustreConfiguration field's value.

func (*FileCache) SetNetworkInterfaceIds added in v1.44.108 

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

SetNetworkInterfaceIds sets the NetworkInterfaceIds field's value.

func (*FileCache) SetOwnerId added in v1.44.108 

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

SetOwnerId sets the OwnerId field's value.

func (*FileCache) SetResourceARN added in v1.44.108 

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

SetResourceARN sets the ResourceARN field's value.

func (*FileCache) SetStorageCapacity added in v1.44.108 

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

SetStorageCapacity sets the StorageCapacity field's value.

func (*FileCache) SetSubnetIds added in v1.44.108 

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

SetSubnetIds sets the SubnetIds field's value.

func (*FileCache) SetVpcId added in v1.44.108 

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

SetVpcId sets the VpcId field's value.

func (FileCache) String added in v1.44.108 

func (s FileCache) 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 FileCacheCreating added in v1.44.108 

type FileCacheCreating struct {

	// A boolean flag indicating whether tags for the cache should be copied to
	// data repository associations.
	CopyTagsToDataRepositoryAssociations *bool `type:"boolean"`

	// 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 Domain Name System (DNS) name for the cache.
	DNSName *string `min:"16" type:"string"`

	// A list of IDs of data repository associations that are associated with this
	// cache.
	DataRepositoryAssociationIds []*string `type:"list"`

	// A structure providing details of any failures that occurred in creating a
	// cache.
	FailureDetails *FileCacheFailureDetails `type:"structure"`

	// The system-generated, unique ID of the cache.
	FileCacheId *string `min:"11" type:"string"`

	// The type of cache, which must be LUSTRE.
	FileCacheType *string `type:"string" enum:"FileCacheType"`

	// The Lustre version of the cache, which must be 2.12.
	FileCacheTypeVersion *string `min:"1" type:"string"`

	// Specifies the ID of the Key Management Service (KMS) key to use for encrypting
	// data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed
	// KMS key for your account is used. 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 cache. The following are the possible values
	// and what they mean:
	//
	//    * AVAILABLE - The cache is in a healthy state, and is reachable and available
	//    for use.
	//
	//    * CREATING - The new cache is being created.
	//
	//    * DELETING - An existing cache is being deleted.
	//
	//    * UPDATING - The cache is undergoing a customer-initiated update.
	//
	//    * FAILED - An existing cache has experienced an unrecoverable failure.
	//    When creating a new cache, the cache was unable to be created.
	Lifecycle *string `type:"string" enum:"FileCacheLifecycle"`

	// The configuration for the Amazon File Cache resource.
	LustreConfiguration *FileCacheLustreConfiguration `type:"structure"`

	// A list of network interface IDs.
	NetworkInterfaceIds []*string `type:"list"`

	// 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 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 storage capacity of the cache in gibibytes (GiB).
	StorageCapacity *int64 `type:"integer"`

	// A list of subnet IDs that the cache will be accessible from. You can specify
	// only one subnet ID in a call to the CreateFileCache operation.
	SubnetIds []*string `type:"list"`

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

	// The ID of 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.
	VpcId *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

The response object for the Amazon File Cache resource being created in the CreateFileCache operation.

func (FileCacheCreating) GoString added in v1.44.108 

func (s FileCacheCreating) 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 (*FileCacheCreating) SetCopyTagsToDataRepositoryAssociations added in v1.44.108 

func (s *FileCacheCreating) SetCopyTagsToDataRepositoryAssociations(v bool) *FileCacheCreating

SetCopyTagsToDataRepositoryAssociations sets the CopyTagsToDataRepositoryAssociations field's value.

func (*FileCacheCreating) SetCreationTime added in v1.44.108 

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

SetCreationTime sets the CreationTime field's value.

func (*FileCacheCreating) SetDNSName added in v1.44.108 

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

SetDNSName sets the DNSName field's value.

func (*FileCacheCreating) SetDataRepositoryAssociationIds added in v1.44.108 

func (s *FileCacheCreating) SetDataRepositoryAssociationIds(v []*string) *FileCacheCreating

SetDataRepositoryAssociationIds sets the DataRepositoryAssociationIds field's value.

func (*FileCacheCreating) SetFailureDetails added in v1.44.108 

func (s *FileCacheCreating) SetFailureDetails(v *FileCacheFailureDetails) *FileCacheCreating

SetFailureDetails sets the FailureDetails field's value.

func (*FileCacheCreating) SetFileCacheId added in v1.44.108 

func (s *FileCacheCreating) SetFileCacheId(v string) *FileCacheCreating

SetFileCacheId sets the FileCacheId field's value.

func (*FileCacheCreating) SetFileCacheType added in v1.44.108 

func (s *FileCacheCreating) SetFileCacheType(v string) *FileCacheCreating

SetFileCacheType sets the FileCacheType field's value.

func (*FileCacheCreating) SetFileCacheTypeVersion added in v1.44.108 

func (s *FileCacheCreating) SetFileCacheTypeVersion(v string) *FileCacheCreating

SetFileCacheTypeVersion sets the FileCacheTypeVersion field's value.

func (*FileCacheCreating) SetKmsKeyId added in v1.44.108 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*FileCacheCreating) SetLifecycle added in v1.44.108 

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

SetLifecycle sets the Lifecycle field's value.

func (*FileCacheCreating) SetLustreConfiguration added in v1.44.108 

func (s *FileCacheCreating) SetLustreConfiguration(v *FileCacheLustreConfiguration) *FileCacheCreating

SetLustreConfiguration sets the LustreConfiguration field's value.

func (*FileCacheCreating) SetNetworkInterfaceIds added in v1.44.108 

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

SetNetworkInterfaceIds sets the NetworkInterfaceIds field's value.

func (*FileCacheCreating) SetOwnerId added in v1.44.108 

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

SetOwnerId sets the OwnerId field's value.

func (*FileCacheCreating) SetResourceARN added in v1.44.108 

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

SetResourceARN sets the ResourceARN field's value.

func (*FileCacheCreating) SetStorageCapacity added in v1.44.108 

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

SetStorageCapacity sets the StorageCapacity field's value.

func (*FileCacheCreating) SetSubnetIds added in v1.44.108 

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

SetSubnetIds sets the SubnetIds field's value.

func (*FileCacheCreating) SetTags added in v1.44.108 

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

SetTags sets the Tags field's value.

func (*FileCacheCreating) SetVpcId added in v1.44.108 

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

SetVpcId sets the VpcId field's value.

func (FileCacheCreating) String added in v1.44.108 

func (s FileCacheCreating) 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 FileCacheDataRepositoryAssociation added in v1.44.108 

type FileCacheDataRepositoryAssociation struct {

	// The path to the S3 or NFS data repository that links to the cache. You must
	// provide one of the following paths:
	//
	//    * The path can be an NFS data repository that links to the cache. The
	//    path can be in one of two formats: If you are not using the DataRepositorySubdirectories
	//    parameter, the path is to an NFS Export directory (or one of its subdirectories)
	//    in the format nfs://nfs-domain-name/exportpath. You can therefore link
	//    a single NFS Export to a single data repository association. If you are
	//    using the DataRepositorySubdirectories parameter, the path is the domain
	//    name of the NFS file system in the format nfs://filer-domain-name, which
	//    indicates the root of the subdirectories specified with the DataRepositorySubdirectories
	//    parameter.
	//
	//    * The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
	//
	// DataRepositoryPath is a required field
	DataRepositoryPath *string `min:"3" type:"string" required:"true"`

	// A list of NFS Exports that will be linked with this data repository association.
	// The Export paths are in the format /exportpath1. To use this parameter, you
	// must configure DataRepositoryPath as the domain name of the NFS file system.
	// The NFS file system domain name in effect is the root of the subdirectories.
	// Note that DataRepositorySubdirectories is not supported for S3 data repositories.
	DataRepositorySubdirectories []*string `type:"list"`

	// A path on the cache that points to a high-level directory (such as /ns1/)
	// or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath.
	// The leading forward slash in the name is required. Two data repository associations
	// cannot have overlapping cache paths. For example, if a data repository is
	// associated with cache path /ns1/, then you cannot link another data repository
	// with cache path /ns1/ns2.
	//
	// This path specifies where in your cache files will be exported from. This
	// cache directory can be linked to only one data repository, and no data repository
	// other can be linked to the directory.
	//
	// The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories
	// is specified. If you specify root (/) as the cache path, you can create only
	// one DRA on the cache.
	//
	// The cache path cannot be set to root (/) for an S3 DRA.
	//
	// FileCachePath is a required field
	FileCachePath *string `min:"1" type:"string" required:"true"`

	// The configuration for a data repository association that links an Amazon
	// File Cache resource to an NFS data repository.
	NFS *FileCacheNFSConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource creation. The DRA links the cache to either an Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA does not support automatic import or automatic export.

func (FileCacheDataRepositoryAssociation) GoString added in v1.44.108 

func (s FileCacheDataRepositoryAssociation) 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 (*FileCacheDataRepositoryAssociation) SetDataRepositoryPath added in v1.44.108 

func (s *FileCacheDataRepositoryAssociation) SetDataRepositoryPath(v string) *FileCacheDataRepositoryAssociation

SetDataRepositoryPath sets the DataRepositoryPath field's value.

func (*FileCacheDataRepositoryAssociation) SetDataRepositorySubdirectories added in v1.44.108 

func (s *FileCacheDataRepositoryAssociation) SetDataRepositorySubdirectories(v []*string) *FileCacheDataRepositoryAssociation

SetDataRepositorySubdirectories sets the DataRepositorySubdirectories field's value.

func (*FileCacheDataRepositoryAssociation) SetFileCachePath added in v1.44.108 

func (s *FileCacheDataRepositoryAssociation) SetFileCachePath(v string) *FileCacheDataRepositoryAssociation

SetFileCachePath sets the FileCachePath field's value.

func (*FileCacheDataRepositoryAssociation) SetNFS added in v1.44.108 

func (s *FileCacheDataRepositoryAssociation) SetNFS(v *FileCacheNFSConfiguration) *FileCacheDataRepositoryAssociation

SetNFS sets the NFS field's value.

func (FileCacheDataRepositoryAssociation) String added in v1.44.108 

func (s FileCacheDataRepositoryAssociation) 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 (*FileCacheDataRepositoryAssociation) Validate added in v1.44.108 

func (s *FileCacheDataRepositoryAssociation) Validate() error

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

type FileCacheFailureDetails added in v1.44.108 

type FileCacheFailureDetails struct {

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

A structure providing details of any failures that occurred.

func (FileCacheFailureDetails) GoString added in v1.44.108 

func (s FileCacheFailureDetails) 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 (*FileCacheFailureDetails) SetMessage added in v1.44.108 

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

SetMessage sets the Message field's value.

func (FileCacheFailureDetails) String added in v1.44.108 

func (s FileCacheFailureDetails) 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 FileCacheLustreConfiguration added in v1.44.108 

type FileCacheLustreConfiguration struct {

	// The deployment type of the Amazon File Cache resource, which must be CACHE_1.
	DeploymentType *string `type:"string" enum:"FileCacheLustreDeploymentType"`

	// The configuration for Lustre logging used to write the enabled logging events
	// for your Amazon File Cache resource to Amazon CloudWatch Logs.
	LogConfiguration *LustreLogConfiguration `type:"structure"`

	// The configuration for a Lustre MDT (Metadata Target) storage volume.
	MetadataConfiguration *FileCacheLustreMetadataConfiguration `type:"structure"`

	// You use the MountName value when mounting the cache. If you pass a cache
	// ID to the DescribeFileCaches operation, it returns the the MountName value
	// as part of the cache's description.
	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. Cache throughput
	// capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB).
	// The only supported value is 1000.
	PerUnitStorageThroughput *int64 `min:"12" 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
}

The configuration for the Amazon File Cache resource.

func (FileCacheLustreConfiguration) GoString added in v1.44.108 

func (s FileCacheLustreConfiguration) 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 (*FileCacheLustreConfiguration) SetDeploymentType added in v1.44.108 

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

SetDeploymentType sets the DeploymentType field's value.

func (*FileCacheLustreConfiguration) SetLogConfiguration added in v1.44.108 

func (s *FileCacheLustreConfiguration) SetLogConfiguration(v *LustreLogConfiguration) *FileCacheLustreConfiguration

SetLogConfiguration sets the LogConfiguration field's value.

func (*FileCacheLustreConfiguration) SetMetadataConfiguration added in v1.44.108 

func (s *FileCacheLustreConfiguration) SetMetadataConfiguration(v *FileCacheLustreMetadataConfiguration) *FileCacheLustreConfiguration

SetMetadataConfiguration sets the MetadataConfiguration field's value.

func (*FileCacheLustreConfiguration) SetMountName added in v1.44.108 

func (s *FileCacheLustreConfiguration) SetMountName(v string) *FileCacheLustreConfiguration

SetMountName sets the MountName field's value.

func (*FileCacheLustreConfiguration) SetPerUnitStorageThroughput added in v1.44.108 

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

SetPerUnitStorageThroughput sets the PerUnitStorageThroughput field's value.

func (*FileCacheLustreConfiguration) SetWeeklyMaintenanceStartTime added in v1.44.108 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (FileCacheLustreConfiguration) String added in v1.44.108 

func (s FileCacheLustreConfiguration) 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 FileCacheLustreMetadataConfiguration added in v1.44.108 

type FileCacheLustreMetadataConfiguration struct {

	// The storage capacity of the Lustre MDT (Metadata Target) storage volume in
	// gibibytes (GiB). The only supported value is 2400 GiB.
	//
	// StorageCapacity is a required field
	StorageCapacity *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The configuration for a Lustre MDT (Metadata Target) storage volume. The metadata on Amazon File Cache is managed by a Lustre Metadata Server (MDS) while the actual metadata is persisted on an MDT.

func (FileCacheLustreMetadataConfiguration) GoString added in v1.44.108 

func (s FileCacheLustreMetadataConfiguration) 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 (*FileCacheLustreMetadataConfiguration) SetStorageCapacity added in v1.44.108 

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

SetStorageCapacity sets the StorageCapacity field's value.

func (FileCacheLustreMetadataConfiguration) String added in v1.44.108 

func (s FileCacheLustreMetadataConfiguration) 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 (*FileCacheLustreMetadataConfiguration) Validate added in v1.44.108 

func (s *FileCacheLustreMetadataConfiguration) Validate() error

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

type FileCacheNFSConfiguration added in v1.44.108 

type FileCacheNFSConfiguration struct {

	// A list of up to 2 IP addresses of DNS servers used to resolve the NFS file
	// system domain name. The provided IP addresses can either be the IP addresses
	// of a DNS forwarder or resolver that the customer manages and runs inside
	// the customer VPC, or the IP addresses of the on-premises DNS servers.
	DnsIps []*string `type:"list"`

	// The version of the NFS (Network File System) protocol of the NFS data repository.
	// The only supported value is NFS3, which indicates that the data repository
	// must support the NFSv3 protocol.
	//
	// Version is a required field
	Version *string `type:"string" required:"true" enum:"NfsVersion"`
	// contains filtered or unexported fields
}

The configuration for an NFS data repository association (DRA) created during the creation of the Amazon File Cache resource.

func (FileCacheNFSConfiguration) GoString added in v1.44.108 

func (s FileCacheNFSConfiguration) 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 (*FileCacheNFSConfiguration) SetDnsIps added in v1.44.108 

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

SetDnsIps sets the DnsIps field's value.

func (*FileCacheNFSConfiguration) SetVersion added in v1.44.108 

func (s *FileCacheNFSConfiguration) SetVersion(v string) *FileCacheNFSConfiguration

SetVersion sets the Version field's value.

func (FileCacheNFSConfiguration) String added in v1.44.108 

func (s FileCacheNFSConfiguration) 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 (*FileCacheNFSConfiguration) Validate added in v1.44.108 

func (s *FileCacheNFSConfiguration) Validate() error

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

type FileCacheNotFound added in v1.44.108 

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

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

No caches were found based upon supplied parameters.

func (*FileCacheNotFound) Code added in v1.44.108 

func (s *FileCacheNotFound) Code() string

Code returns the exception type name.

func (*FileCacheNotFound) Error added in v1.44.108 

func (s *FileCacheNotFound) Error() string

func (FileCacheNotFound) GoString added in v1.44.108 

func (s FileCacheNotFound) 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 (*FileCacheNotFound) Message added in v1.44.108 

func (s *FileCacheNotFound) Message() string

Message returns the exception's message.

func (*FileCacheNotFound) OrigErr added in v1.44.108 

func (s *FileCacheNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FileCacheNotFound) RequestID added in v1.44.108 

func (s *FileCacheNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FileCacheNotFound) StatusCode added in v1.44.108 

func (s *FileCacheNotFound) StatusCode() int

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

func (FileCacheNotFound) String added in v1.44.108 

func (s FileCacheNotFound) 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 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 system that you have initiated using the UpdateFileSystem operation.
	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 Domain Name System (DNS) name for the file system.
	DNSName *string `min:"16" type:"string"`

	// A structure providing details of any failures that occurred.
	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, ONTAP,
	// or OPENZFS.
	FileSystemType *string `type:"string" enum:"FileSystemType"`

	// The Lustre version of the Amazon FSx for Lustre file system, which can be
	// 2.10, 2.12, or 2.15.
	FileSystemTypeVersion *string `min:"1" type:"string"`

	// The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx
	// file system data. Used as follows with Amazon FSx file system types:
	//
	//    * Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types
	//    only. SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx
	//    service KMS key for your account.
	//
	//    * Amazon FSx for NetApp ONTAP
	//
	//    * Amazon FSx for OpenZFS
	//
	//    * Amazon FSx for Windows File Server
	KmsKeyId *string `min:"1" type:"string"`

	// The lifecycle status of the file system. The 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 - The file system is in a failed but recoverable state.
	//
	//    * MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only)
	//    The file system is currently unavailable due to a change in your Active
	//    Directory configuration.
	//
	//    * UPDATING - 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 interfaces from which a specific file system
	// is accessible. The elastic network interface is automatically created in
	// the same virtual private cloud (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 Amazon FSx for NetApp ONTAP file system.
	OntapConfiguration *OntapFileSystemConfiguration `type:"structure"`

	// The configuration for this Amazon FSx for OpenZFS file system.
	OpenZFSConfiguration *OpenZFSFileSystemConfiguration `type:"structure"`

	// The Amazon Web Services account that created the file system. If the file
	// system was created by a user in IAM Identity Center, 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) of the file system resource.
	ResourceARN *string `min:"8" type:"string"`

	// The storage capacity of the file system in gibibytes (GiB).
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value
	// of StorageCapacity is outside of the minimum or maximum values.
	StorageCapacity *int64 `type:"integer"`

	// The type of storage the file system is using. 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 the Amazon FSx 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 FSx for Lustre file systems, and Single-AZ Windows file systems, this
	// is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1
	// Windows and ONTAP file systems, the file system endpoint is available in
	// the PreferredSubnetID.
	SubnetIds []*string `type:"list"`

	// The tags to associate with the file system. For more information, see Tagging
	// your Amazon FSx resources (https://docs.aws.amazon.com/fsx/latest/LustreGuide/tag-resources.html)
	// in the Amazon FSx for Lustre User Guide.
	Tags []*Tag `min:"1" type:"list"`

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

	// The configuration for this Amazon FSx for Windows File Server 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) SetFileSystemTypeVersion added in v1.40.57 

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

SetFileSystemTypeVersion sets the FileSystemTypeVersion 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) SetOpenZFSConfiguration added in v1.42.16 

func (s *FileSystem) SetOpenZFSConfiguration(v *OpenZFSFileSystemConfiguration) *FileSystem

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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 file system's DNS name. 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.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A structure providing details of any failures that occurred.

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

type FileSystemLustreMetadataConfiguration struct {

	// The number of Metadata IOPS provisioned for the file system. Valid values
	// are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.
	Iops *int64 `min:"1500" type:"integer"`

	// The metadata configuration mode for provisioning Metadata IOPS for the file
	// system.
	//
	//    * In AUTOMATIC mode, FSx for Lustre automatically provisions and scales
	//    the number of Metadata IOPS on your file system based on your file system
	//    storage capacity.
	//
	//    * In USER_PROVISIONED mode, you can choose to specify the number of Metadata
	//    IOPS to provision for your file system.
	//
	// Mode is a required field
	Mode *string `type:"string" required:"true" enum:"MetadataConfigurationMode"`
	// contains filtered or unexported fields
}

The Lustre metadata performance configuration of an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. The configuration enables the file system to support increasing metadata performance.

func (FileSystemLustreMetadataConfiguration) GoString added in v1.53.18 

func (s FileSystemLustreMetadataConfiguration) 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 (*FileSystemLustreMetadataConfiguration) SetIops added in v1.53.18 

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

SetIops sets the Iops field's value.

func (*FileSystemLustreMetadataConfiguration) SetMode added in v1.53.18 

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

SetMode sets the Mode field's value.

func (FileSystemLustreMetadataConfiguration) String added in v1.53.18 

func (s FileSystemLustreMetadataConfiguration) 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 InvalidDataRepositoryType added in v1.42.16 

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

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

You have filtered the response to a data repository type that is not supported.

func (*InvalidDataRepositoryType) Code added in v1.42.16 

func (s *InvalidDataRepositoryType) Code() string

Code returns the exception type name.

func (*InvalidDataRepositoryType) Error added in v1.42.16 

func (s *InvalidDataRepositoryType) Error() string

func (InvalidDataRepositoryType) GoString added in v1.42.16 

func (s InvalidDataRepositoryType) 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 (*InvalidDataRepositoryType) Message added in v1.42.16 

func (s *InvalidDataRepositoryType) Message() string

Message returns the exception's message.

func (*InvalidDataRepositoryType) OrigErr added in v1.42.16 

func (s *InvalidDataRepositoryType) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidDataRepositoryType) RequestID added in v1.42.16 

func (s *InvalidDataRepositoryType) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidDataRepositoryType) StatusCode added in v1.42.16 

func (s *InvalidDataRepositoryType) StatusCode() int

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

func (InvalidDataRepositoryType) String added in v1.42.16 

func (s InvalidDataRepositoryType) 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 not valid.

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 SourceRegion is not valid 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 not valid.

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 property to
	// 0 disables automatic backups. You can retain automatic backups for a maximum
	// of 90 days. The default is 30.
	AutomaticBackupRetentionDays *int64 `type:"integer"`

	// A boolean flag indicating whether tags on the file system are 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.
	//
	// This data type is not supported on file systems with a data repository association.
	// For file systems with a data repository association, see .
	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 and PERSISTENT_2 deployment type is used for longer-term
	// storage and workloads and encryption of data in transit. PERSISTENT_2 offers
	// higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower
	// minimum storage capacity requirement (600 GiB). To learn more about FSx for
	// Lustre deployment types, see FSx for Lustre deployment options (https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html).
	//
	// The default is 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 StorageType is
	// HDD. When set to READ the file system has an SSD storage cache that is sized
	// to 20% of the file system's storage capacity. This improves the performance
	// for frequently accessed files by caching up to 20% of the total storage capacity.
	//
	// This parameter is required when StorageType is set to HDD.
	DriveCacheType *string `type:"string" enum:"DriveCacheType"`

	// The Lustre logging configuration. Lustre logging writes the enabled log events
	// for your file system to Amazon CloudWatch Logs.
	LogConfiguration *LustreLogConfiguration `type:"structure"`

	// The Lustre metadata performance configuration for an Amazon FSx for Lustre
	// file system using a PERSISTENT_2 deployment type.
	MetadataConfiguration *FileSystemLustreMetadataConfiguration `type:"structure"`

	// You use the MountName value when mounting the file system.
	//
	// For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2,
	// PERSISTENT_1, and PERSISTENT_2 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 and PERSISTENT_2 deployment types.
	//
	// Valid values:
	//
	//    * For PERSISTENT_1 SSD storage: 50, 100, 200.
	//
	//    * For PERSISTENT_1 HDD storage: 12, 40.
	//
	//    * For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.
	PerUnitStorageThroughput *int64 `min:"12" type:"integer"`

	// The Lustre root squash configuration for an Amazon FSx for Lustre file system.
	// When enabled, root squash restricts root-level access from clients that try
	// to access your file system as a root user.
	RootSquashConfiguration *LustreRootSquashConfiguration `type:"structure"`

	// The preferred start time to perform weekly maintenance, formatted d:HH:MM
	// in the UTC time zone. Here, 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) SetLogConfiguration added in v1.42.16 

func (s *LustreFileSystemConfiguration) SetLogConfiguration(v *LustreLogConfiguration) *LustreFileSystemConfiguration

SetLogConfiguration sets the LogConfiguration field's value.

func (*LustreFileSystemConfiguration) SetMetadataConfiguration added in v1.53.18 

func (s *LustreFileSystemConfiguration) SetMetadataConfiguration(v *FileSystemLustreMetadataConfiguration) *LustreFileSystemConfiguration

SetMetadataConfiguration sets the MetadataConfiguration 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) SetRootSquashConfiguration added in v1.44.22 

func (s *LustreFileSystemConfiguration) SetRootSquashConfiguration(v *LustreRootSquashConfiguration) *LustreFileSystemConfiguration

SetRootSquashConfiguration sets the RootSquashConfiguration 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 LustreLogConfiguration added in v1.42.16 

type LustreLogConfiguration struct {

	// The Amazon Resource Name (ARN) that specifies the destination of the logs.
	// The destination can be any Amazon CloudWatch Logs log group ARN. The destination
	// ARN must be in the same Amazon Web Services partition, Amazon Web Services
	// Region, and Amazon Web Services account as your Amazon FSx file system.
	Destination *string `min:"8" type:"string"`

	// The data repository events that are logged by Amazon FSx.
	//
	//    * WARN_ONLY - only warning events are logged.
	//
	//    * ERROR_ONLY - only error events are logged.
	//
	//    * WARN_ERROR - both warning events and error events are logged.
	//
	//    * DISABLED - logging of data repository events is turned off.
	//
	// Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't
	// be changed.
	//
	// Level is a required field
	Level *string `type:"string" required:"true" enum:"LustreAccessAuditLogLevel"`
	// contains filtered or unexported fields
}

The configuration for Lustre logging used to write the enabled logging events for your Amazon FSx for Lustre file system or Amazon File Cache resource to Amazon CloudWatch Logs.

func (LustreLogConfiguration) GoString added in v1.42.16 

func (s LustreLogConfiguration) 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 (*LustreLogConfiguration) SetDestination added in v1.42.16 

func (s *LustreLogConfiguration) SetDestination(v string) *LustreLogConfiguration

SetDestination sets the Destination field's value.

func (*LustreLogConfiguration) SetLevel added in v1.42.16 

func (s *LustreLogConfiguration) SetLevel(v string) *LustreLogConfiguration

SetLevel sets the Level field's value.

func (LustreLogConfiguration) String added in v1.42.16 

func (s LustreLogConfiguration) 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 LustreLogCreateConfiguration added in v1.42.16 

type LustreLogCreateConfiguration struct {

	// The Amazon Resource Name (ARN) that specifies the destination of the logs.
	//
	// The destination can be any Amazon CloudWatch Logs log group ARN, with the
	// following requirements:
	//
	//    * The destination ARN that you provide 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.
	//
	//    * If you do not provide a destination, Amazon FSx will create and use
	//    a log stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon
	//    FSx for Lustre) or /aws/fsx/filecache (for Amazon File Cache).
	//
	//    * If Destination is provided and the resource does not exist, the request
	//    will fail with a BadRequest error.
	//
	//    * If Level is set to DISABLED, you cannot specify a destination in Destination.
	Destination *string `min:"8" type:"string"`

	// Sets which data repository events are logged by Amazon FSx.
	//
	//    * WARN_ONLY - only warning events are logged.
	//
	//    * ERROR_ONLY - only error events are logged.
	//
	//    * WARN_ERROR - both warning events and error events are logged.
	//
	//    * DISABLED - logging of data repository events is turned off.
	//
	// Level is a required field
	Level *string `type:"string" required:"true" enum:"LustreAccessAuditLogLevel"`
	// contains filtered or unexported fields
}

The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system. An Amazon File Cache is created with Lustre logging enabled by default, with a setting of WARN_ERROR for the logging events. which can't be changed.

Lustre logging writes the enabled logging events for your file system or cache to Amazon CloudWatch Logs.

func (LustreLogCreateConfiguration) GoString added in v1.42.16 

func (s LustreLogCreateConfiguration) 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 (*LustreLogCreateConfiguration) SetDestination added in v1.42.16 

func (s *LustreLogCreateConfiguration) SetDestination(v string) *LustreLogCreateConfiguration

SetDestination sets the Destination field's value.

func (*LustreLogCreateConfiguration) SetLevel added in v1.42.16 

func (s *LustreLogCreateConfiguration) SetLevel(v string) *LustreLogCreateConfiguration

SetLevel sets the Level field's value.

func (LustreLogCreateConfiguration) String added in v1.42.16 

func (s LustreLogCreateConfiguration) 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 (*LustreLogCreateConfiguration) Validate added in v1.42.16 

func (s *LustreLogCreateConfiguration) Validate() error

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

type LustreRootSquashConfiguration added in v1.44.22 

type LustreRootSquashConfiguration struct {

	// When root squash is enabled, you can optionally specify an array of NIDs
	// of clients for which root squash does not apply. A client NID is a Lustre
	// Network Identifier used to uniquely identify a client. You can specify the
	// NID as either a single address or a range of addresses:
	//
	//    * A single address is described in standard Lustre NID format by specifying
	//    the client’s IP address followed by the Lustre network ID (for example,
	//    10.0.1.6@tcp).
	//
	//    * An address range is described using a dash to separate the range (for
	//    example, 10.0.[2-10].[1-255]@tcp).
	NoSquashNids []*string `type:"list"`

	// You enable root squash by setting a user ID (UID) and group ID (GID) for
	// the file system in the format UID:GID (for example, 365534:65534). The UID
	// and GID values can range from 0 to 4294967294:
	//
	//    * A non-zero value for UID and GID enables root squash. The UID and GID
	//    values can be different, but each must be a non-zero value.
	//
	//    * A value of 0 (zero) for UID and GID indicates root, and therefore disables
	//    root squash.
	//
	// When root squash is enabled, the user ID and group ID of a root user accessing
	// the file system are re-mapped to the UID and GID you provide.
	RootSquash *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

The configuration for Lustre root squash used to restrict root-level access from clients that try to access your FSx for Lustre file system as root. Use the RootSquash parameter to enable root squash. To learn more about Lustre root squash, see Lustre root squash (https://docs.aws.amazon.com/fsx/latest/LustreGuide/root-squash.html).

You can also use the NoSquashNids parameter to provide an array of clients who are not affected by the root squash setting. These clients will access the file system as root, with unrestricted privileges.

func (LustreRootSquashConfiguration) GoString added in v1.44.22 

func (s LustreRootSquashConfiguration) 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 (*LustreRootSquashConfiguration) SetNoSquashNids added in v1.44.22 

func (s *LustreRootSquashConfiguration) SetNoSquashNids(v []*string) *LustreRootSquashConfiguration

SetNoSquashNids sets the NoSquashNids field's value.

func (*LustreRootSquashConfiguration) SetRootSquash added in v1.44.22 

func (s *LustreRootSquashConfiguration) SetRootSquash(v string) *LustreRootSquashConfiguration

SetRootSquash sets the RootSquash field's value.

func (LustreRootSquashConfiguration) String added in v1.44.22 

func (s LustreRootSquashConfiguration) 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 (*LustreRootSquashConfiguration) Validate added in v1.44.22 

func (s *LustreRootSquashConfiguration) Validate() error

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

type MissingFileCacheConfiguration added in v1.44.108 

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

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

A cache configuration is required for this operation.

func (*MissingFileCacheConfiguration) Code added in v1.44.108 

func (s *MissingFileCacheConfiguration) Code() string

Code returns the exception type name.

func (*MissingFileCacheConfiguration) Error added in v1.44.108 

func (s *MissingFileCacheConfiguration) Error() string

func (MissingFileCacheConfiguration) GoString added in v1.44.108 

func (s MissingFileCacheConfiguration) 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 (*MissingFileCacheConfiguration) Message added in v1.44.108 

func (s *MissingFileCacheConfiguration) Message() string

Message returns the exception's message.

func (*MissingFileCacheConfiguration) OrigErr added in v1.44.108 

func (s *MissingFileCacheConfiguration) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingFileCacheConfiguration) RequestID added in v1.44.108 

func (s *MissingFileCacheConfiguration) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingFileCacheConfiguration) StatusCode added in v1.44.108 

func (s *MissingFileCacheConfiguration) StatusCode() int

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

func (MissingFileCacheConfiguration) String added in v1.44.108 

func (s MissingFileCacheConfiguration) 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 NFSDataRepositoryConfiguration added in v1.44.108 

type NFSDataRepositoryConfiguration struct {

	// This parameter is not supported for Amazon File Cache.
	AutoExportPolicy *AutoExportPolicy `type:"structure"`

	// A list of up to 2 IP addresses of DNS servers used to resolve the NFS file
	// system domain name. The provided IP addresses can either be the IP addresses
	// of a DNS forwarder or resolver that the customer manages and runs inside
	// the customer VPC, or the IP addresses of the on-premises DNS servers.
	DnsIps []*string `type:"list"`

	// The version of the NFS (Network File System) protocol of the NFS data repository.
	// Currently, the only supported value is NFS3, which indicates that the data
	// repository must support the NFSv3 protocol.
	//
	// Version is a required field
	Version *string `type:"string" required:"true" enum:"NfsVersion"`
	// contains filtered or unexported fields
}

The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

func (NFSDataRepositoryConfiguration) GoString added in v1.44.108 

func (s NFSDataRepositoryConfiguration) 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 (*NFSDataRepositoryConfiguration) SetAutoExportPolicy added in v1.44.108 

func (s *NFSDataRepositoryConfiguration) SetAutoExportPolicy(v *AutoExportPolicy) *NFSDataRepositoryConfiguration

SetAutoExportPolicy sets the AutoExportPolicy field's value.

func (*NFSDataRepositoryConfiguration) SetDnsIps added in v1.44.108 

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

SetDnsIps sets the DnsIps field's value.

func (*NFSDataRepositoryConfiguration) SetVersion added in v1.44.108 

func (s *NFSDataRepositoryConfiguration) SetVersion(v string) *NFSDataRepositoryConfiguration

SetVersion sets the Version field's value.

func (NFSDataRepositoryConfiguration) String added in v1.44.108 

func (s NFSDataRepositoryConfiguration) 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 property to
	// 0 disables automatic backups. You can retain automatic backups for a maximum
	// of 90 days. The default is 30.
	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 FSx for ONTAP file system deployment type in use in the file
	// system.
	//
	//    * MULTI_AZ_1 - A high availability file system configured for Multi-AZ
	//    redundancy to tolerate temporary Availability Zone (AZ) unavailability.
	//    This is a first-generation FSx for ONTAP file system.
	//
	//    * MULTI_AZ_2 - A high availability file system configured for Multi-AZ
	//    redundancy to tolerate temporary AZ unavailability. This is a second-generation
	//    FSx for ONTAP file system.
	//
	//    * SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This
	//    is a first-generation FSx for ONTAP file system.
	//
	//    * SINGLE_AZ_2 - A file system configured with multiple high-availability
	//    (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for
	//    ONTAP file system.
	//
	// For information about the use cases for Multi-AZ and Single-AZ deployments,
	// refer to Choosing Multi-AZ or Single-AZ file system deployment (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html).
	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"`

	// (Multi-AZ only) Specifies the IP address range in which the endpoints to
	// access your file system will be created. By default in the Amazon FSx API,
	// Amazon FSx selects an unused IP address range for you from the 198.19.* range.
	// By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses
	// from the VPC’s primary CIDR range to use as the endpoint IP address range
	// for the file system. You can have overlapping endpoint IP addresses for file
	// systems deployed in the same VPC/route tables.
	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"`

	// You can use the fsxadmin user account to access the NetApp ONTAP CLI and
	// REST API. The password value is always redacted in the response.
	//
	// FsxAdminPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by OntapFileSystemConfiguration's
	// String and GoString methods.
	FsxAdminPassword *string `min:"8" type:"string" sensitive:"true"`

	// Specifies how many high-availability (HA) file server pairs the file system
	// will have. The default value is 1. The value of this property affects the
	// values of StorageCapacity, Iops, and ThroughputCapacity. For more information,
	// see High-availability (HA) pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html)
	// in the FSx for ONTAP user guide.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The value of HAPairs is less than 1 or greater than 12.
	//
	//    * The value of HAPairs is greater than 1 and the value of DeploymentType
	//    is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.
	HAPairs *int64 `min:"1" type:"integer"`

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

	// (Multi-AZ only) The VPC route tables in which your file system's endpoints
	// are created.
	RouteTableIds []*string `type:"list"`

	// The sustained throughput of an Amazon FSx file system in Megabytes per second
	// (MBps).
	ThroughputCapacity *int64 `min:"8" type:"integer"`

	// Use to choose the throughput capacity per HA pair. When the value of HAPairs
	// is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput
	// for the file system.
	//
	// This field and ThroughputCapacity cannot be defined in the same API call,
	// but one is required.
	//
	// This field and ThroughputCapacity are the same for file systems with one
	// HA pair.
	//
	//    * For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256,
	//    512, 1024, 2048, or 4096 MBps.
	//
	//    * For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.
	//
	//    * For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The value of ThroughputCapacity and ThroughputCapacityPerHAPair are
	//    not the same value.
	//
	//    * The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity /
	//    ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1
	//    and 12).
	//
	//    * The value of ThroughputCapacityPerHAPair is not a valid value.
	ThroughputCapacityPerHAPair *int64 `min:"128" 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) SetFsxAdminPassword added in v1.44.281 

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

SetFsxAdminPassword sets the FsxAdminPassword field's value.

func (*OntapFileSystemConfiguration) SetHAPairs added in v1.48.4 

func (s *OntapFileSystemConfiguration) SetHAPairs(v int64) *OntapFileSystemConfiguration

SetHAPairs sets the HAPairs 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) SetThroughputCapacityPerHAPair added in v1.48.4 

func (s *OntapFileSystemConfiguration) SetThroughputCapacityPerHAPair(v int64) *OntapFileSystemConfiguration

SetThroughputCapacityPerHAPair sets the ThroughputCapacityPerHAPair 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 {

	// This structure specifies configuration options for a volume’s storage aggregate
	// or aggregates.
	AggregateConfiguration *AggregateConfiguration `type:"structure"`

	// A boolean flag indicating whether tags for the volume should be copied to
	// backups. This value defaults to false. If it's set to true, all tags for
	// the volume 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 volume, regardless of this value.
	CopyTagsToBackups *bool `type:"boolean"`

	// 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 network-attached storage (NAS) clients use to
	// mount the volume, along with the storage virtual machine (SVM) Domain Name
	// System (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. If a disaster occurs, you can use
	//    these data-protection mirror copies to recover data.
	//
	//    * 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 bytes.
	SizeInBytes *int64 `type:"long"`

	// The configured size of the volume, in megabytes (MBs).
	SizeInMegabytes *int64 `type:"integer"`

	// The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
	SnaplockConfiguration *SnaplockConfiguration `type:"structure"`

	// Specifies the snapshot policy for the volume. There are three built-in snapshot
	// policies:
	//
	//    * default: This is the default policy. A maximum of six hourly snapshots
	//    taken five minutes past the hour. A maximum of two daily snapshots taken
	//    Monday through Saturday at 10 minutes after midnight. A maximum of two
	//    weekly snapshots taken every Sunday at 15 minutes after midnight.
	//
	//    * default-1weekly: This policy is the same as the default policy except
	//    that it only retains one snapshot from the weekly schedule.
	//
	//    * none: This policy does not take any snapshots. This policy can be assigned
	//    to volumes to prevent automatic snapshots from being taken.
	//
	// You can also provide the name of a custom policy that you created with the
	// ONTAP CLI or REST API.
	//
	// For more information, see Snapshot policies (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies)
	// in the Amazon FSx for NetApp ONTAP User Guide.
	SnapshotPolicy *string `min:"1" type:"string"`

	// 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 universally unique identifier (UUID).
	UUID *string `type:"string"`

	// Use to specify the style of an ONTAP volume. For more information about FlexVols
	// and FlexGroups, see Volume types (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types.html)
	// in Amazon FSx for NetApp ONTAP User Guide.
	VolumeStyle *string `type:"string" enum:"VolumeStyle"`
	// 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) SetAggregateConfiguration added in v1.48.4 

func (s *OntapVolumeConfiguration) SetAggregateConfiguration(v *AggregateConfiguration) *OntapVolumeConfiguration

SetAggregateConfiguration sets the AggregateConfiguration field's value.

func (*OntapVolumeConfiguration) SetCopyTagsToBackups added in v1.44.147 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

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) SetSizeInBytes added in v1.48.4 

func (s *OntapVolumeConfiguration) SetSizeInBytes(v int64) *OntapVolumeConfiguration

SetSizeInBytes sets the SizeInBytes 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) SetSnaplockConfiguration added in v1.44.300 

func (s *OntapVolumeConfiguration) SetSnaplockConfiguration(v *SnaplockConfiguration) *OntapVolumeConfiguration

SetSnaplockConfiguration sets the SnaplockConfiguration field's value.

func (*OntapVolumeConfiguration) SetSnapshotPolicy added in v1.44.147 

func (s *OntapVolumeConfiguration) SetSnapshotPolicy(v string) *OntapVolumeConfiguration

SetSnapshotPolicy sets the SnapshotPolicy 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) SetVolumeStyle added in v1.48.4 

func (s *OntapVolumeConfiguration) SetVolumeStyle(v string) *OntapVolumeConfiguration

SetVolumeStyle sets the VolumeStyle 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 OpenZFSClientConfiguration added in v1.42.16 

type OpenZFSClientConfiguration struct {

	// A value that specifies who can mount the file system. You can provide a wildcard
	// character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24).
	// By default, Amazon FSx uses the wildcard character when specifying the client.
	//
	// Clients is a required field
	Clients *string `min:"1" type:"string" required:"true"`

	// The options to use when mounting the file system. For a list of options that
	// you can use with Network File System (NFS), see the exports(5) - Linux man
	// page (https://linux.die.net/man/5/exports). When choosing your options, consider
	// the following:
	//
	//    * crossmnt is used by default. If you don't specify crossmnt when changing
	//    the client configuration, you won't be able to see or access snapshots
	//    in your file system's snapshot directory.
	//
	//    * sync is used by default. If you instead specify async, the system acknowledges
	//    writes before writing to disk. If the system crashes before the writes
	//    are finished, you lose the unwritten data.
	//
	// Options is a required field
	Options []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies who can mount an OpenZFS file system and the options available while mounting the file system.

func (OpenZFSClientConfiguration) GoString added in v1.42.16 

func (s OpenZFSClientConfiguration) 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 (*OpenZFSClientConfiguration) SetClients added in v1.42.16 

func (s *OpenZFSClientConfiguration) SetClients(v string) *OpenZFSClientConfiguration

SetClients sets the Clients field's value.

func (*OpenZFSClientConfiguration) SetOptions added in v1.42.16 

func (s *OpenZFSClientConfiguration) SetOptions(v []*string) *OpenZFSClientConfiguration

SetOptions sets the Options field's value.

func (OpenZFSClientConfiguration) String added in v1.42.16 

func (s OpenZFSClientConfiguration) 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 (*OpenZFSClientConfiguration) Validate added in v1.42.16 

func (s *OpenZFSClientConfiguration) Validate() error

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

type OpenZFSCreateRootVolumeConfiguration added in v1.42.16 

type OpenZFSCreateRootVolumeConfiguration struct {

	// A Boolean value indicating whether tags for the volume should be copied to
	// snapshots of the volume. This value defaults to false. If it's set to true,
	// all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating
	// the snapshot, no tags are copied from the volume, regardless of this value.
	CopyTagsToSnapshots *bool `type:"boolean"`

	// Specifies the method used to compress the data on the volume. The compression
	// type is NONE by default.
	//
	//    * NONE - Doesn't compress the data on the volume. NONE is the default.
	//
	//    * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD)
	//    compression algorithm. Compared to LZ4, Z-Standard provides a better compression
	//    ratio to minimize on-disk storage utilization.
	//
	//    * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm.
	//    Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher
	//    write throughput speeds.
	DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"`

	// The configuration object for mounting a file system.
	NfsExports []*OpenZFSNfsExport `type:"list"`

	// A Boolean value indicating whether the volume is read-only. Setting this
	// value to true can be useful after you have completed changes to a volume
	// and no longer want changes to occur.
	ReadOnly *bool `type:"boolean"`

	// Specifies the record size of an OpenZFS root volume, in kibibytes (KiB).
	// Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default
	// is 128 KiB. Most workloads should use the default record size. Database workflows
	// can benefit from a smaller record size, while streaming workflows can benefit
	// from a larger record size. For additional guidance on setting a custom record
	// size, see Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs)
	// in the Amazon FSx for OpenZFS User Guide.
	RecordSizeKiB *int64 `min:"4" type:"integer"`

	// An object specifying how much storage users or groups can use on the volume.
	UserAndGroupQuotas []*OpenZFSUserOrGroupQuota `type:"list"`
	// contains filtered or unexported fields
}

The configuration of an Amazon FSx for OpenZFS root volume.

func (OpenZFSCreateRootVolumeConfiguration) GoString added in v1.42.16 

func (s OpenZFSCreateRootVolumeConfiguration) 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 (*OpenZFSCreateRootVolumeConfiguration) SetCopyTagsToSnapshots added in v1.42.16 

func (s *OpenZFSCreateRootVolumeConfiguration) SetCopyTagsToSnapshots(v bool) *OpenZFSCreateRootVolumeConfiguration

SetCopyTagsToSnapshots sets the CopyTagsToSnapshots field's value.

func (*OpenZFSCreateRootVolumeConfiguration) SetDataCompressionType added in v1.42.16 

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

SetDataCompressionType sets the DataCompressionType field's value.

func (*OpenZFSCreateRootVolumeConfiguration) SetNfsExports added in v1.42.16 

func (s *OpenZFSCreateRootVolumeConfiguration) SetNfsExports(v []*OpenZFSNfsExport) *OpenZFSCreateRootVolumeConfiguration

SetNfsExports sets the NfsExports field's value.

func (*OpenZFSCreateRootVolumeConfiguration) SetReadOnly added in v1.42.16 

func (s *OpenZFSCreateRootVolumeConfiguration) SetReadOnly(v bool) *OpenZFSCreateRootVolumeConfiguration

SetReadOnly sets the ReadOnly field's value.

func (*OpenZFSCreateRootVolumeConfiguration) SetRecordSizeKiB added in v1.43.8 

func (s *OpenZFSCreateRootVolumeConfiguration) SetRecordSizeKiB(v int64) *OpenZFSCreateRootVolumeConfiguration

SetRecordSizeKiB sets the RecordSizeKiB field's value.

func (*OpenZFSCreateRootVolumeConfiguration) SetUserAndGroupQuotas added in v1.42.16 

func (s *OpenZFSCreateRootVolumeConfiguration) SetUserAndGroupQuotas(v []*OpenZFSUserOrGroupQuota) *OpenZFSCreateRootVolumeConfiguration

SetUserAndGroupQuotas sets the UserAndGroupQuotas field's value.

func (OpenZFSCreateRootVolumeConfiguration) String added in v1.42.16 

func (s OpenZFSCreateRootVolumeConfiguration) 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 (*OpenZFSCreateRootVolumeConfiguration) Validate added in v1.42.16 

func (s *OpenZFSCreateRootVolumeConfiguration) Validate() error

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

type OpenZFSFileSystemConfiguration added in v1.42.16 

type OpenZFSFileSystemConfiguration struct {

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

	// A Boolean value 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.
	CopyTagsToBackups *bool `type:"boolean"`

	// A Boolean value indicating whether tags for the volume should be copied to
	// snapshots. This value defaults to false. If it's set to true, all tags for
	// the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the
	// snapshot, no tags are copied from the volume, regardless of this value.
	CopyTagsToVolumes *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"`

	// Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
	// MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.
	DeploymentType *string `type:"string" enum:"OpenZFSDeploymentType"`

	// The SSD IOPS (input/output operations per second) configuration for an Amazon
	// FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS
	// file system. By default, Amazon FSx automatically provisions 3 IOPS per GB
	// of storage capacity. You can provision additional IOPS per GB of storage.
	// The configuration consists of the total number of provisioned SSD IOPS and
	// how it is was provisioned, or the mode (by the customer or by Amazon FSx).
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

	// The IP address of the endpoint that is used to access data or to manage the
	// file system.
	EndpointIpAddress *string `min:"7" type:"string"`

	// (Multi-AZ only) Specifies the IP address range in which the endpoints to
	// access your file system will be created. By default in the Amazon FSx API
	// and Amazon FSx console, Amazon FSx selects an available /28 IP address range
	// for you from one of the VPC's CIDR ranges. You can have overlapping endpoint
	// IP addresses for file systems deployed in the same VPC/route tables.
	EndpointIpAddressRange *string `min:"9" type:"string"`

	// Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet
	// in which you want the preferred file server to be located.
	PreferredSubnetId *string `min:"15" type:"string"`

	// The ID of the root volume of the OpenZFS file system.
	RootVolumeId *string `min:"23" type:"string"`

	// (Multi-AZ only) The VPC route tables in which your file system's endpoints
	// are created.
	RouteTableIds []*string `type:"list"`

	// The throughput of an Amazon FSx file system, measured in megabytes per second
	// (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
}

The configuration for the Amazon FSx for OpenZFS file system.

func (OpenZFSFileSystemConfiguration) GoString added in v1.42.16 

func (s OpenZFSFileSystemConfiguration) 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 (*OpenZFSFileSystemConfiguration) SetAutomaticBackupRetentionDays added in v1.42.16 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*OpenZFSFileSystemConfiguration) SetCopyTagsToBackups added in v1.42.16 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*OpenZFSFileSystemConfiguration) SetCopyTagsToVolumes added in v1.42.16 

func (s *OpenZFSFileSystemConfiguration) SetCopyTagsToVolumes(v bool) *OpenZFSFileSystemConfiguration

SetCopyTagsToVolumes sets the CopyTagsToVolumes field's value.

func (*OpenZFSFileSystemConfiguration) SetDailyAutomaticBackupStartTime added in v1.42.16 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*OpenZFSFileSystemConfiguration) SetDeploymentType added in v1.42.16 

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

SetDeploymentType sets the DeploymentType field's value.

func (*OpenZFSFileSystemConfiguration) SetDiskIopsConfiguration added in v1.42.16 

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

SetDiskIopsConfiguration sets the DiskIopsConfiguration field's value.

func (*OpenZFSFileSystemConfiguration) SetEndpointIpAddress added in v1.44.320 

func (s *OpenZFSFileSystemConfiguration) SetEndpointIpAddress(v string) *OpenZFSFileSystemConfiguration

SetEndpointIpAddress sets the EndpointIpAddress field's value.

func (*OpenZFSFileSystemConfiguration) SetEndpointIpAddressRange added in v1.44.320 

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

SetEndpointIpAddressRange sets the EndpointIpAddressRange field's value.

func (*OpenZFSFileSystemConfiguration) SetPreferredSubnetId added in v1.44.320 

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

SetPreferredSubnetId sets the PreferredSubnetId field's value.

func (*OpenZFSFileSystemConfiguration) SetRootVolumeId added in v1.42.16 

func (s *OpenZFSFileSystemConfiguration) SetRootVolumeId(v string) *OpenZFSFileSystemConfiguration

SetRootVolumeId sets the RootVolumeId field's value.

func (*OpenZFSFileSystemConfiguration) SetRouteTableIds added in v1.44.320 

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

SetRouteTableIds sets the RouteTableIds field's value.

func (*OpenZFSFileSystemConfiguration) SetThroughputCapacity added in v1.42.16 

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

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*OpenZFSFileSystemConfiguration) SetWeeklyMaintenanceStartTime added in v1.42.16 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (OpenZFSFileSystemConfiguration) String added in v1.42.16 

func (s OpenZFSFileSystemConfiguration) 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 OpenZFSNfsExport added in v1.42.16 

type OpenZFSNfsExport struct {

	// A list of configuration objects that contain the client and options for mounting
	// the OpenZFS file system.
	//
	// ClientConfigurations is a required field
	ClientConfigurations []*OpenZFSClientConfiguration `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.

func (OpenZFSNfsExport) GoString added in v1.42.16 

func (s OpenZFSNfsExport) 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 (*OpenZFSNfsExport) SetClientConfigurations added in v1.42.16 

func (s *OpenZFSNfsExport) SetClientConfigurations(v []*OpenZFSClientConfiguration) *OpenZFSNfsExport

SetClientConfigurations sets the ClientConfigurations field's value.

func (OpenZFSNfsExport) String added in v1.42.16 

func (s OpenZFSNfsExport) 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 (*OpenZFSNfsExport) Validate added in v1.42.16 

func (s *OpenZFSNfsExport) Validate() error

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

type OpenZFSOriginSnapshotConfiguration added in v1.42.16 

type OpenZFSOriginSnapshotConfiguration struct {

	// The strategy used when copying data from the snapshot to the new volume.
	//
	//    * CLONE - The new volume references the data in the origin snapshot. Cloning
	//    a snapshot is faster than copying the data from a snapshot to a new volume
	//    and doesn't consume disk throughput. However, the origin snapshot can't
	//    be deleted if there is a volume using its copied data.
	//
	//    * FULL_COPY - Copies all data from the snapshot to the new volume.
	//
	// The INCREMENTAL_COPY option is only for updating an existing volume by using
	// a snapshot from another FSx for OpenZFS file system. For more information,
	// see CopySnapshotAndUpdateVolume (https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html).
	CopyStrategy *string `type:"string" enum:"OpenZFSCopyStrategy"`

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

The snapshot configuration used when creating an Amazon FSx for OpenZFS volume from a snapshot.

func (OpenZFSOriginSnapshotConfiguration) GoString added in v1.42.16 

func (s OpenZFSOriginSnapshotConfiguration) 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 (*OpenZFSOriginSnapshotConfiguration) SetCopyStrategy added in v1.42.16 

func (s *OpenZFSOriginSnapshotConfiguration) SetCopyStrategy(v string) *OpenZFSOriginSnapshotConfiguration

SetCopyStrategy sets the CopyStrategy field's value.

func (*OpenZFSOriginSnapshotConfiguration) SetSnapshotARN added in v1.42.16 

func (s *OpenZFSOriginSnapshotConfiguration) SetSnapshotARN(v string) *OpenZFSOriginSnapshotConfiguration

SetSnapshotARN sets the SnapshotARN field's value.

func (OpenZFSOriginSnapshotConfiguration) String added in v1.42.16 

func (s OpenZFSOriginSnapshotConfiguration) 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 OpenZFSUserOrGroupQuota added in v1.42.16 

type OpenZFSUserOrGroupQuota struct {

	// The ID of the user or group that the quota applies to.
	//
	// Id is a required field
	Id *int64 `type:"integer" required:"true"`

	// The user or group's storage quota, in gibibytes (GiB).
	//
	// StorageCapacityQuotaGiB is a required field
	StorageCapacityQuotaGiB *int64 `type:"integer" required:"true"`

	// Specifies whether the quota applies to a user or group.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"OpenZFSQuotaType"`
	// contains filtered or unexported fields
}

Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) in the FSx for OpenZFS User Guide.

func (OpenZFSUserOrGroupQuota) GoString added in v1.42.16 

func (s OpenZFSUserOrGroupQuota) 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 (*OpenZFSUserOrGroupQuota) SetId added in v1.42.16 

func (s *OpenZFSUserOrGroupQuota) SetId(v int64) *OpenZFSUserOrGroupQuota

SetId sets the Id field's value.

func (*OpenZFSUserOrGroupQuota) SetStorageCapacityQuotaGiB added in v1.42.16 

func (s *OpenZFSUserOrGroupQuota) SetStorageCapacityQuotaGiB(v int64) *OpenZFSUserOrGroupQuota

SetStorageCapacityQuotaGiB sets the StorageCapacityQuotaGiB field's value.

func (*OpenZFSUserOrGroupQuota) SetType added in v1.42.16 

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

SetType sets the Type field's value.

func (OpenZFSUserOrGroupQuota) String added in v1.42.16 

func (s OpenZFSUserOrGroupQuota) 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 (*OpenZFSUserOrGroupQuota) Validate added in v1.42.16 

func (s *OpenZFSUserOrGroupQuota) Validate() error

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

type OpenZFSVolumeConfiguration added in v1.42.16 

type OpenZFSVolumeConfiguration struct {

	// Specifies the strategy used when copying data from the snapshot to the new
	// volume.
	//
	//    * CLONE - The new volume references the data in the origin snapshot. Cloning
	//    a snapshot is faster than copying data from the snapshot to a new volume
	//    and doesn't consume disk throughput. However, the origin snapshot can't
	//    be deleted if there is a volume using its copied data.
	//
	//    * FULL_COPY - Copies all data from the snapshot to the new volume. Specify
	//    this option to create the volume from a snapshot on another FSx for OpenZFS
	//    file system.
	//
	// The INCREMENTAL_COPY option is only for updating an existing volume by using
	// a snapshot from another FSx for OpenZFS file system. For more information,
	// see CopySnapshotAndUpdateVolume (https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html).
	CopyStrategy *string `type:"string" enum:"OpenZFSCopyStrategy"`

	// A Boolean value indicating whether tags for the volume should be copied to
	// snapshots. This value defaults to false. If it's set to true, all tags for
	// the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the
	// snapshot, no tags are copied from the volume, regardless of this value.
	CopyTagsToSnapshots *bool `type:"boolean"`

	// Specifies the method used to compress the data on the volume. The compression
	// type is NONE by default.
	//
	//    * NONE - Doesn't compress the data on the volume. NONE is the default.
	//
	//    * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD)
	//    compression algorithm. Compared to LZ4, Z-Standard provides a better compression
	//    ratio to minimize on-disk storage utilization.
	//
	//    * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm.
	//    Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher
	//    write throughput speeds.
	DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"`

	// A Boolean value indicating whether dependent clone volumes created from intermediate
	// snapshots should be deleted when a volume is restored from snapshot.
	DeleteClonedVolumes *bool `type:"boolean"`

	// A Boolean value indicating whether snapshot data that differs between the
	// current state and the specified snapshot should be overwritten when a volume
	// is restored from a snapshot.
	DeleteIntermediateData *bool `type:"boolean"`

	// A Boolean value indicating whether snapshots between the current state and
	// the specified snapshot should be deleted when a volume is restored from snapshot.
	DeleteIntermediateSnaphots *bool `type:"boolean"`

	// The ID of the snapshot that's being copied or was most recently copied to
	// the destination volume.
	DestinationSnapshot *string `min:"11" type:"string"`

	// The configuration object for mounting a Network File System (NFS) file system.
	NfsExports []*OpenZFSNfsExport `type:"list"`

	// The configuration object that specifies the snapshot to use as the origin
	// of the data for the volume.
	OriginSnapshot *OpenZFSOriginSnapshotConfiguration `type:"structure"`

	// The ID of the parent volume.
	ParentVolumeId *string `min:"23" type:"string"`

	// A Boolean value indicating whether the volume is read-only.
	ReadOnly *bool `type:"boolean"`

	// The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are
	// 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most
	// workloads should use the default record size. For guidance on when to set
	// a custom record size, see the Amazon FSx for OpenZFS User Guide.
	RecordSizeKiB *int64 `min:"4" type:"integer"`

	// Specifies the ID of the snapshot to which the volume was restored.
	RestoreToSnapshot *string `min:"11" 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.
	SourceSnapshotARN *string `min:"8" type:"string"`

	// The maximum amount of storage in gibibtyes (GiB) that the volume can use
	// from its parent. You can specify a quota larger than the storage on the parent
	// volume.
	StorageCapacityQuotaGiB *int64 `type:"integer"`

	// The amount of storage in gibibytes (GiB) to reserve from the parent volume.
	// You can't reserve more storage than the parent volume has reserved.
	StorageCapacityReservationGiB *int64 `type:"integer"`

	// An object specifying how much storage users or groups can use on the volume.
	UserAndGroupQuotas []*OpenZFSUserOrGroupQuota `type:"list"`

	// The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
	VolumePath *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The configuration of an Amazon FSx for OpenZFS volume.

func (OpenZFSVolumeConfiguration) GoString added in v1.42.16 

func (s OpenZFSVolumeConfiguration) 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 (*OpenZFSVolumeConfiguration) SetCopyStrategy added in v1.49.6 

func (s *OpenZFSVolumeConfiguration) SetCopyStrategy(v string) *OpenZFSVolumeConfiguration

SetCopyStrategy sets the CopyStrategy field's value.

func (*OpenZFSVolumeConfiguration) SetCopyTagsToSnapshots added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetCopyTagsToSnapshots(v bool) *OpenZFSVolumeConfiguration

SetCopyTagsToSnapshots sets the CopyTagsToSnapshots field's value.

func (*OpenZFSVolumeConfiguration) SetDataCompressionType added in v1.42.16 

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

SetDataCompressionType sets the DataCompressionType field's value.

func (*OpenZFSVolumeConfiguration) SetDeleteClonedVolumes added in v1.44.147 

func (s *OpenZFSVolumeConfiguration) SetDeleteClonedVolumes(v bool) *OpenZFSVolumeConfiguration

SetDeleteClonedVolumes sets the DeleteClonedVolumes field's value.

func (*OpenZFSVolumeConfiguration) SetDeleteIntermediateData added in v1.48.4 

func (s *OpenZFSVolumeConfiguration) SetDeleteIntermediateData(v bool) *OpenZFSVolumeConfiguration

SetDeleteIntermediateData sets the DeleteIntermediateData field's value.

func (*OpenZFSVolumeConfiguration) SetDeleteIntermediateSnaphots added in v1.44.147 

func (s *OpenZFSVolumeConfiguration) SetDeleteIntermediateSnaphots(v bool) *OpenZFSVolumeConfiguration

SetDeleteIntermediateSnaphots sets the DeleteIntermediateSnaphots field's value.

func (*OpenZFSVolumeConfiguration) SetDestinationSnapshot added in v1.48.4 

func (s *OpenZFSVolumeConfiguration) SetDestinationSnapshot(v string) *OpenZFSVolumeConfiguration

SetDestinationSnapshot sets the DestinationSnapshot field's value.

func (*OpenZFSVolumeConfiguration) SetNfsExports added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetNfsExports(v []*OpenZFSNfsExport) *OpenZFSVolumeConfiguration

SetNfsExports sets the NfsExports field's value.

func (*OpenZFSVolumeConfiguration) SetOriginSnapshot added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetOriginSnapshot(v *OpenZFSOriginSnapshotConfiguration) *OpenZFSVolumeConfiguration

SetOriginSnapshot sets the OriginSnapshot field's value.

func (*OpenZFSVolumeConfiguration) SetParentVolumeId added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetParentVolumeId(v string) *OpenZFSVolumeConfiguration

SetParentVolumeId sets the ParentVolumeId field's value.

func (*OpenZFSVolumeConfiguration) SetReadOnly added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetReadOnly(v bool) *OpenZFSVolumeConfiguration

SetReadOnly sets the ReadOnly field's value.

func (*OpenZFSVolumeConfiguration) SetRecordSizeKiB added in v1.43.8 

func (s *OpenZFSVolumeConfiguration) SetRecordSizeKiB(v int64) *OpenZFSVolumeConfiguration

SetRecordSizeKiB sets the RecordSizeKiB field's value.

func (*OpenZFSVolumeConfiguration) SetRestoreToSnapshot added in v1.44.147 

func (s *OpenZFSVolumeConfiguration) SetRestoreToSnapshot(v string) *OpenZFSVolumeConfiguration

SetRestoreToSnapshot sets the RestoreToSnapshot field's value.

func (*OpenZFSVolumeConfiguration) SetSourceSnapshotARN added in v1.48.4 

func (s *OpenZFSVolumeConfiguration) SetSourceSnapshotARN(v string) *OpenZFSVolumeConfiguration

SetSourceSnapshotARN sets the SourceSnapshotARN field's value.

func (*OpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB(v int64) *OpenZFSVolumeConfiguration

SetStorageCapacityQuotaGiB sets the StorageCapacityQuotaGiB field's value.

func (*OpenZFSVolumeConfiguration) SetStorageCapacityReservationGiB added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetStorageCapacityReservationGiB(v int64) *OpenZFSVolumeConfiguration

SetStorageCapacityReservationGiB sets the StorageCapacityReservationGiB field's value.

func (*OpenZFSVolumeConfiguration) SetUserAndGroupQuotas added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetUserAndGroupQuotas(v []*OpenZFSUserOrGroupQuota) *OpenZFSVolumeConfiguration

SetUserAndGroupQuotas sets the UserAndGroupQuotas field's value.

func (*OpenZFSVolumeConfiguration) SetVolumePath added in v1.42.16 

func (s *OpenZFSVolumeConfiguration) SetVolumePath(v string) *OpenZFSVolumeConfiguration

SetVolumePath sets the VolumePath field's value.

func (OpenZFSVolumeConfiguration) String added in v1.42.16 

func (s OpenZFSVolumeConfiguration) 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 ReleaseConfiguration added in v1.44.320 

type ReleaseConfiguration struct {

	// Defines the point-in-time since an exported file was last accessed, in order
	// for that file to be eligible for release. Only files that were last accessed
	// before this point-in-time are eligible to be released from the file system.
	DurationSinceLastAccess *DurationSinceLastAccess `type:"structure"`
	// contains filtered or unexported fields
}

The configuration that specifies a minimum amount of time since last access for an exported file to be eligible for release from an Amazon FSx for Lustre file system. Only files that were last accessed before this point-in-time can be released. For example, if you specify a last accessed time criteria of 9 days, only files that were last accessed 9.00001 or more days ago can be released.

Only file data that has been exported to S3 can be released. Files that have not yet been exported to S3, such as new or changed files that have not been exported, are not eligible for release. When files are released, their metadata stays on the file system, so they can still be accessed later. Users and applications can access a released file by reading the file again, which restores data from Amazon S3 to the FSx for Lustre file system.

If a file meets the last accessed time criteria, its file or directory path must also be specified with the Paths parameter of the operation in order for the file to be released.

func (ReleaseConfiguration) GoString added in v1.44.320 

func (s ReleaseConfiguration) 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 (*ReleaseConfiguration) SetDurationSinceLastAccess added in v1.44.320 

func (s *ReleaseConfiguration) SetDurationSinceLastAccess(v *DurationSinceLastAccess) *ReleaseConfiguration

SetDurationSinceLastAccess sets the DurationSinceLastAccess field's value.

func (ReleaseConfiguration) String added in v1.44.320 

func (s ReleaseConfiguration) 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 ReleaseFileSystemNfsV3LocksInput added in v1.42.16 

type ReleaseFileSystemNfsV3LocksInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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"`
	// contains filtered or unexported fields
}

func (ReleaseFileSystemNfsV3LocksInput) GoString added in v1.42.16 

func (s ReleaseFileSystemNfsV3LocksInput) 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 (*ReleaseFileSystemNfsV3LocksInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*ReleaseFileSystemNfsV3LocksInput) SetFileSystemId added in v1.42.16 

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

SetFileSystemId sets the FileSystemId field's value.

func (ReleaseFileSystemNfsV3LocksInput) String added in v1.42.16 

func (s ReleaseFileSystemNfsV3LocksInput) 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 (*ReleaseFileSystemNfsV3LocksInput) Validate added in v1.42.16 

func (s *ReleaseFileSystemNfsV3LocksInput) Validate() error

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

type ReleaseFileSystemNfsV3LocksOutput added in v1.42.16 

type ReleaseFileSystemNfsV3LocksOutput struct {

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

func (ReleaseFileSystemNfsV3LocksOutput) GoString added in v1.42.16 

func (s ReleaseFileSystemNfsV3LocksOutput) 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 (*ReleaseFileSystemNfsV3LocksOutput) SetFileSystem added in v1.42.16 

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

SetFileSystem sets the FileSystem field's value.

func (ReleaseFileSystemNfsV3LocksOutput) String added in v1.42.16 

func (s ReleaseFileSystemNfsV3LocksOutput) 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 RestoreVolumeFromSnapshotInput added in v1.42.16 

type RestoreVolumeFromSnapshotInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 settings used when restoring the specified volume from snapshot.
	//
	//    * DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current
	//    state and the specified snapshot. If there are intermediate snapshots
	//    and this option isn't used, RestoreVolumeFromSnapshot fails.
	//
	//    * DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created
	//    from intermediate snapshots. If there are any dependent clone volumes
	//    and this option isn't used, RestoreVolumeFromSnapshot fails.
	Options []*string `type:"list" enum:"RestoreOpenZFSVolumeOption"`

	// The ID of the source snapshot. Specifies the snapshot that you are restoring
	// from.
	//
	// SnapshotId is a required field
	SnapshotId *string `min:"11" type:"string" required:"true"`

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

func (RestoreVolumeFromSnapshotInput) GoString added in v1.42.16 

func (s RestoreVolumeFromSnapshotInput) 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 (*RestoreVolumeFromSnapshotInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*RestoreVolumeFromSnapshotInput) SetOptions added in v1.42.16 

func (s *RestoreVolumeFromSnapshotInput) SetOptions(v []*string) *RestoreVolumeFromSnapshotInput

SetOptions sets the Options field's value.

func (*RestoreVolumeFromSnapshotInput) SetSnapshotId added in v1.42.16 

func (s *RestoreVolumeFromSnapshotInput) SetSnapshotId(v string) *RestoreVolumeFromSnapshotInput

SetSnapshotId sets the SnapshotId field's value.

func (*RestoreVolumeFromSnapshotInput) SetVolumeId added in v1.42.16 

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

SetVolumeId sets the VolumeId field's value.

func (RestoreVolumeFromSnapshotInput) String added in v1.42.16 

func (s RestoreVolumeFromSnapshotInput) 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 (*RestoreVolumeFromSnapshotInput) Validate added in v1.42.16 

func (s *RestoreVolumeFromSnapshotInput) Validate() error

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

type RestoreVolumeFromSnapshotOutput added in v1.42.16 

type RestoreVolumeFromSnapshotOutput 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 system.
	AdministrativeActions []*AdministrativeAction `type:"list"`

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

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

func (RestoreVolumeFromSnapshotOutput) GoString added in v1.42.16 

func (s RestoreVolumeFromSnapshotOutput) 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 (*RestoreVolumeFromSnapshotOutput) SetAdministrativeActions added in v1.44.147 

func (s *RestoreVolumeFromSnapshotOutput) SetAdministrativeActions(v []*AdministrativeAction) *RestoreVolumeFromSnapshotOutput

SetAdministrativeActions sets the AdministrativeActions field's value.

func (*RestoreVolumeFromSnapshotOutput) SetLifecycle added in v1.42.16 

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

SetLifecycle sets the Lifecycle field's value.

func (*RestoreVolumeFromSnapshotOutput) SetVolumeId added in v1.42.16 

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

SetVolumeId sets the VolumeId field's value.

func (RestoreVolumeFromSnapshotOutput) String added in v1.42.16 

func (s RestoreVolumeFromSnapshotOutput) 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 RetentionPeriod added in v1.44.300 

type RetentionPeriod struct {

	// Defines the type of time for the retention period of an FSx for ONTAP SnapLock
	// volume. Set it to one of the valid types. If you set it to INFINITE, the
	// files are retained forever. If you set it to UNSPECIFIED, the files are retained
	// until you set an explicit retention period.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"RetentionPeriodType"`

	// Defines the amount of time for the retention period of an FSx for ONTAP SnapLock
	// volume. You can't set a value for INFINITE or UNSPECIFIED. For all other
	// options, the following ranges are valid:
	//
	//    * Seconds: 0 - 65,535
	//
	//    * Minutes: 0 - 65,535
	//
	//    * Hours: 0 - 24
	//
	//    * Days: 0 - 365
	//
	//    * Months: 0 - 12
	//
	//    * Years: 0 - 100
	Value *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html).

func (RetentionPeriod) GoString added in v1.44.300 

func (s RetentionPeriod) 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 (*RetentionPeriod) SetType added in v1.44.300 

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

SetType sets the Type field's value.

func (*RetentionPeriod) SetValue added in v1.44.300 

func (s *RetentionPeriod) SetValue(v int64) *RetentionPeriod

SetValue sets the Value field's value.

func (RetentionPeriod) String added in v1.44.300 

func (s RetentionPeriod) 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 (*RetentionPeriod) Validate added in v1.44.300 

func (s *RetentionPeriod) Validate() error

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

type S3DataRepositoryConfiguration added in v1.42.16 

type S3DataRepositoryConfiguration struct {

	// Specifies the type of updated objects (new, changed, deleted) that will be
	// automatically exported from your file system to the linked S3 bucket.
	AutoExportPolicy *AutoExportPolicy `type:"structure"`

	// Specifies the type of updated objects (new, changed, deleted) that will be
	// automatically imported from the linked S3 bucket to your file system.
	AutoImportPolicy *AutoImportPolicy `type:"structure"`
	// contains filtered or unexported fields
}

The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association. The configuration consists of an AutoImportPolicy that defines which file events on the data repository are automatically imported to the file system and an AutoExportPolicy that defines which file events on the file system are automatically exported to the data repository. File events are when files or directories are added, changed, or deleted on the file system or the data repository.

Data repository associations on Amazon File Cache don't use S3DataRepositoryConfiguration because they don't support automatic import or automatic export.

func (S3DataRepositoryConfiguration) GoString added in v1.42.16 

func (s S3DataRepositoryConfiguration) 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 (*S3DataRepositoryConfiguration) SetAutoExportPolicy added in v1.42.16 

func (s *S3DataRepositoryConfiguration) SetAutoExportPolicy(v *AutoExportPolicy) *S3DataRepositoryConfiguration

SetAutoExportPolicy sets the AutoExportPolicy field's value.

func (*S3DataRepositoryConfiguration) SetAutoImportPolicy added in v1.42.16 

func (s *S3DataRepositoryConfiguration) SetAutoImportPolicy(v *AutoImportPolicy) *S3DataRepositoryConfiguration

SetAutoImportPolicy sets the AutoImportPolicy field's value.

func (S3DataRepositoryConfiguration) String added in v1.42.16 

func (s S3DataRepositoryConfiguration) 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 three 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 three 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 FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) or Managing FSx for ONTAP 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 three DNS server or domain controller IP addresses in your
	// self-managed Active Directory domain.
	DnsIps []*string `min:"1" type:"list"`

	// Specifies an updated fully qualified domain name of your self-managed Active
	// Directory configuration.
	DomainName *string `min:"1" type:"string"`

	// For FSx for ONTAP file systems only - Specifies the updated name of the self-managed
	// Active Directory domain group whose members are granted administrative privileges
	// for the Amazon FSx resource.
	FileSystemAdministratorsGroup *string `min:"1" type:"string"`

	// Specifies an updated fully qualified distinguished name of the organization
	// unit within your self-managed Active Directory.
	OrganizationalUnitDistinguishedName *string `min:"1" type:"string"`

	// Specifies the updated password for the service account on your self-managed
	// Active Directory domain. Amazon FSx uses this account to join to your self-managed
	// Active Directory 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"`

	// Specifies the updated user name for the service account on your self-managed
	// Active Directory domain. Amazon FSx uses this account to join to your self-managed
	// Active Directory domain.
	//
	// This account must have the permissions required to join computers to the
	// domain in the organizational unit provided in OrganizationalUnitDistinguishedName.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Specifies changes you are making to the self-managed Microsoft Active Directory configuration to which an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.

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) SetDomainName added in v1.44.281 

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

SetDomainName sets the DomainName field's value.

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetFileSystemAdministratorsGroup added in v1.44.281 

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

SetFileSystemAdministratorsGroup sets the FileSystemAdministratorsGroup field's value.

func (*SelfManagedActiveDirectoryConfigurationUpdates) SetOrganizationalUnitDistinguishedName added in v1.44.281 

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

SetOrganizationalUnitDistinguishedName sets the OrganizationalUnitDistinguishedName 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 SnaplockConfiguration added in v1.44.300 

type SnaplockConfiguration struct {

	// Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
	// The default value is false. If you set AuditLogVolume to true, the SnapLock
	// volume is created as an audit log volume. The minimum retention period for
	// an audit log volume is six months.
	//
	// For more information, see SnapLock audit log volumes (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume).
	AuditLogVolume *bool `type:"boolean"`

	// The configuration object for setting the autocommit period of files in an
	// FSx for ONTAP SnapLock volume.
	AutocommitPeriod *AutocommitPeriod `type:"structure"`

	// Enables, disables, or permanently disables privileged delete on an FSx for
	// ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock
	// administrators to delete write once, read many (WORM) files even if they
	// have active retention periods. PERMANENTLY_DISABLED is a terminal state.
	// If privileged delete is permanently disabled on a SnapLock volume, you can't
	// re-enable it. The default value is DISABLED.
	//
	// For more information, see Privileged delete (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete).
	PrivilegedDelete *string `type:"string" enum:"PrivilegedDelete"`

	// Specifies the retention period of an FSx for ONTAP SnapLock volume.
	RetentionPeriod *SnaplockRetentionPeriod `type:"structure"`

	// Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it
	// is set, it can't be changed. You can choose one of the following retention
	// modes:
	//
	//    * COMPLIANCE: Files transitioned to write once, read many (WORM) on a
	//    Compliance volume can't be deleted until their retention periods expire.
	//    This retention mode is used to address government or industry-specific
	//    mandates or to protect against ransomware attacks. For more information,
	//    see SnapLock Compliance (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html).
	//
	//    * ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be
	//    deleted by authorized users before their retention periods expire using
	//    privileged delete. This retention mode is used to advance an organization's
	//    data integrity and internal compliance or to test retention settings before
	//    using SnapLock Compliance. For more information, see SnapLock Enterprise
	//    (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html).
	SnaplockType *string `type:"string" enum:"SnaplockType"`

	// Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
	// Volume-append mode allows you to create WORM-appendable files and write data
	// to them incrementally. The default value is false.
	//
	// For more information, see Volume-append mode (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append).
	VolumeAppendModeEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.

func (SnaplockConfiguration) GoString added in v1.44.300 

func (s SnaplockConfiguration) 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 (*SnaplockConfiguration) SetAuditLogVolume added in v1.44.300 

func (s *SnaplockConfiguration) SetAuditLogVolume(v bool) *SnaplockConfiguration

SetAuditLogVolume sets the AuditLogVolume field's value.

func (*SnaplockConfiguration) SetAutocommitPeriod added in v1.44.300 

func (s *SnaplockConfiguration) SetAutocommitPeriod(v *AutocommitPeriod) *SnaplockConfiguration

SetAutocommitPeriod sets the AutocommitPeriod field's value.

func (*SnaplockConfiguration) SetPrivilegedDelete added in v1.44.300 

func (s *SnaplockConfiguration) SetPrivilegedDelete(v string) *SnaplockConfiguration

SetPrivilegedDelete sets the PrivilegedDelete field's value.

func (*SnaplockConfiguration) SetRetentionPeriod added in v1.44.300 

func (s *SnaplockConfiguration) SetRetentionPeriod(v *SnaplockRetentionPeriod) *SnaplockConfiguration

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*SnaplockConfiguration) SetSnaplockType added in v1.44.300 

func (s *SnaplockConfiguration) SetSnaplockType(v string) *SnaplockConfiguration

SetSnaplockType sets the SnaplockType field's value.

func (*SnaplockConfiguration) SetVolumeAppendModeEnabled added in v1.44.300 

func (s *SnaplockConfiguration) SetVolumeAppendModeEnabled(v bool) *SnaplockConfiguration

SetVolumeAppendModeEnabled sets the VolumeAppendModeEnabled field's value.

func (SnaplockConfiguration) String added in v1.44.300 

func (s SnaplockConfiguration) 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 SnaplockRetentionPeriod added in v1.44.300 

type SnaplockRetentionPeriod struct {

	// The retention period assigned to a write once, read many (WORM) file by default
	// if an explicit retention period is not set for an FSx for ONTAP SnapLock
	// volume. The default retention period must be greater than or equal to the
	// minimum retention period and less than or equal to the maximum retention
	// period.
	//
	// DefaultRetention is a required field
	DefaultRetention *RetentionPeriod `type:"structure" required:"true"`

	// The longest retention period that can be assigned to a WORM file on an FSx
	// for ONTAP SnapLock volume.
	//
	// MaximumRetention is a required field
	MaximumRetention *RetentionPeriod `type:"structure" required:"true"`

	// The shortest retention period that can be assigned to a WORM file on an FSx
	// for ONTAP SnapLock volume.
	//
	// MinimumRetention is a required field
	MinimumRetention *RetentionPeriod `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration to set the retention period of an FSx for ONTAP SnapLock volume. The retention period includes default, maximum, and minimum settings. For more information, see Working with the retention period in SnapLock (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html).

func (SnaplockRetentionPeriod) GoString added in v1.44.300 

func (s SnaplockRetentionPeriod) 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 (*SnaplockRetentionPeriod) SetDefaultRetention added in v1.44.300 

func (s *SnaplockRetentionPeriod) SetDefaultRetention(v *RetentionPeriod) *SnaplockRetentionPeriod

SetDefaultRetention sets the DefaultRetention field's value.

func (*SnaplockRetentionPeriod) SetMaximumRetention added in v1.44.300 

func (s *SnaplockRetentionPeriod) SetMaximumRetention(v *RetentionPeriod) *SnaplockRetentionPeriod

SetMaximumRetention sets the MaximumRetention field's value.

func (*SnaplockRetentionPeriod) SetMinimumRetention added in v1.44.300 

func (s *SnaplockRetentionPeriod) SetMinimumRetention(v *RetentionPeriod) *SnaplockRetentionPeriod

SetMinimumRetention sets the MinimumRetention field's value.

func (SnaplockRetentionPeriod) String added in v1.44.300 

func (s SnaplockRetentionPeriod) 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 (*SnaplockRetentionPeriod) Validate added in v1.44.300 

func (s *SnaplockRetentionPeriod) Validate() error

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

type Snapshot added in v1.42.16 

type Snapshot 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 system.
	AdministrativeActions []*AdministrativeAction `type:"list"`

	// 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 lifecycle status of the snapshot.
	//
	//    * PENDING - Amazon FSx hasn't started creating the snapshot.
	//
	//    * CREATING - Amazon FSx is creating the snapshot.
	//
	//    * DELETING - Amazon FSx is deleting the snapshot.
	//
	//    * AVAILABLE - The snapshot is fully available.
	Lifecycle *string `type:"string" enum:"SnapshotLifecycle"`

	// Describes why a resource lifecycle state changed.
	LifecycleTransitionReason *LifecycleTransitionReason `type:"structure"`

	// The name of the snapshot.
	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 ID of the snapshot.
	SnapshotId *string `min:"11" type:"string"`

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

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

A snapshot of an Amazon FSx for OpenZFS volume.

func (Snapshot) GoString added in v1.42.16 

func (s Snapshot) 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 (*Snapshot) SetAdministrativeActions added in v1.42.16 

func (s *Snapshot) SetAdministrativeActions(v []*AdministrativeAction) *Snapshot

SetAdministrativeActions sets the AdministrativeActions field's value.

func (*Snapshot) SetCreationTime added in v1.42.16 

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

SetCreationTime sets the CreationTime field's value.

func (*Snapshot) SetLifecycle added in v1.42.16 

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

SetLifecycle sets the Lifecycle field's value.

func (*Snapshot) SetLifecycleTransitionReason added in v1.43.8 

func (s *Snapshot) SetLifecycleTransitionReason(v *LifecycleTransitionReason) *Snapshot

SetLifecycleTransitionReason sets the LifecycleTransitionReason field's value.

func (*Snapshot) SetName added in v1.42.16 

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

SetName sets the Name field's value.

func (*Snapshot) SetResourceARN added in v1.42.16 

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

SetResourceARN sets the ResourceARN field's value.

func (*Snapshot) SetSnapshotId added in v1.42.16 

func (s *Snapshot) SetSnapshotId(v string) *Snapshot

SetSnapshotId sets the SnapshotId field's value.

func (*Snapshot) SetTags added in v1.42.16 

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

SetTags sets the Tags field's value.

func (*Snapshot) SetVolumeId added in v1.42.16 

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

SetVolumeId sets the VolumeId field's value.

func (Snapshot) String added in v1.42.16 

func (s Snapshot) 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 SnapshotFilter added in v1.42.16 

type SnapshotFilter struct {

	// The name of the filter to use. You can filter by the file-system-id or by
	// volume-id.
	Name *string `type:"string" enum:"SnapshotFilterName"`

	// The file-system-id or volume-id that you are filtering for.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

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

func (SnapshotFilter) GoString added in v1.42.16 

func (s SnapshotFilter) 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 (*SnapshotFilter) SetName added in v1.42.16 

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

SetName sets the Name field's value.

func (*SnapshotFilter) SetValues added in v1.42.16 

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

SetValues sets the Values field's value.

func (SnapshotFilter) String added in v1.42.16 

func (s SnapshotFilter) 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 SnapshotNotFound added in v1.42.16 

type SnapshotNotFound 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 snapshots were found based on the supplied parameters.

func (*SnapshotNotFound) Code added in v1.42.16 

func (s *SnapshotNotFound) Code() string

Code returns the exception type name.

func (*SnapshotNotFound) Error added in v1.42.16 

func (s *SnapshotNotFound) Error() string

func (SnapshotNotFound) GoString added in v1.42.16 

func (s SnapshotNotFound) 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 (*SnapshotNotFound) Message added in v1.42.16 

func (s *SnapshotNotFound) Message() string

Message returns the exception's message.

func (*SnapshotNotFound) OrigErr added in v1.42.16 

func (s *SnapshotNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*SnapshotNotFound) RequestID added in v1.42.16 

func (s *SnapshotNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*SnapshotNotFound) StatusCode added in v1.42.16 

func (s *SnapshotNotFound) StatusCode() int

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

func (SnapshotNotFound) String added in v1.42.16 

func (s SnapshotNotFound) 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 that 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 isn't 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 StartMisconfiguredStateRecoveryInput added in v1.45.24 

type StartMisconfiguredStateRecoveryInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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"`
	// contains filtered or unexported fields
}

func (StartMisconfiguredStateRecoveryInput) GoString added in v1.45.24 

func (s StartMisconfiguredStateRecoveryInput) 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 (*StartMisconfiguredStateRecoveryInput) SetClientRequestToken added in v1.45.24 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartMisconfiguredStateRecoveryInput) SetFileSystemId added in v1.45.24 

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

SetFileSystemId sets the FileSystemId field's value.

func (StartMisconfiguredStateRecoveryInput) String added in v1.45.24 

func (s StartMisconfiguredStateRecoveryInput) 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 (*StartMisconfiguredStateRecoveryInput) Validate added in v1.45.24 

func (s *StartMisconfiguredStateRecoveryInput) Validate() error

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

type StartMisconfiguredStateRecoveryOutput added in v1.45.24 

type StartMisconfiguredStateRecoveryOutput struct {

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

func (StartMisconfiguredStateRecoveryOutput) GoString added in v1.45.24 

func (s StartMisconfiguredStateRecoveryOutput) 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 (*StartMisconfiguredStateRecoveryOutput) SetFileSystem added in v1.45.24 

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

SetFileSystem sets the FileSystem field's value.

func (StartMisconfiguredStateRecoveryOutput) String added in v1.45.24 

func (s StartMisconfiguredStateRecoveryOutput) 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) configuration.

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 FSx for 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 AD computer object to which the SVM is joined.
	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 Microsoft Active Directory (AD) directory configuration to which the FSx for ONTAP storage virtual machine (SVM) is joined. Note that 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 file system's DNS name. 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.

Valid tiering policies are the following:

  • SNAPSHOT_ONLY - (Default value) 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.

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

type UpdateDataRepositoryAssociationInput struct {

	// The ID of the data repository association that you are updating.
	//
	// AssociationId is a required field
	AssociationId *string `min:"13" type:"string" required:"true"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 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"`

	// The configuration for an Amazon S3 data repository linked to an Amazon FSx
	// Lustre file system with a data repository association. The configuration
	// defines which file events (new, changed, or deleted files or directories)
	// are automatically imported from the linked data repository to the file system
	// or automatically exported from the file system to the data repository.
	S3 *S3DataRepositoryConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDataRepositoryAssociationInput) GoString added in v1.42.16 

func (s UpdateDataRepositoryAssociationInput) 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 (*UpdateDataRepositoryAssociationInput) SetAssociationId added in v1.42.16 

func (s *UpdateDataRepositoryAssociationInput) SetAssociationId(v string) *UpdateDataRepositoryAssociationInput

SetAssociationId sets the AssociationId field's value.

func (*UpdateDataRepositoryAssociationInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateDataRepositoryAssociationInput) SetImportedFileChunkSize added in v1.42.16 

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

SetImportedFileChunkSize sets the ImportedFileChunkSize field's value.

func (*UpdateDataRepositoryAssociationInput) SetS3 added in v1.42.16 

func (s *UpdateDataRepositoryAssociationInput) SetS3(v *S3DataRepositoryConfiguration) *UpdateDataRepositoryAssociationInput

SetS3 sets the S3 field's value.

func (UpdateDataRepositoryAssociationInput) String added in v1.42.16 

func (s UpdateDataRepositoryAssociationInput) 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 (*UpdateDataRepositoryAssociationInput) Validate added in v1.42.16 

func (s *UpdateDataRepositoryAssociationInput) Validate() error

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

type UpdateDataRepositoryAssociationOutput added in v1.42.16 

type UpdateDataRepositoryAssociationOutput struct {

	// The response object returned after the data repository association is updated.
	Association *DataRepositoryAssociation `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDataRepositoryAssociationOutput) GoString added in v1.42.16 

func (s UpdateDataRepositoryAssociationOutput) 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 (*UpdateDataRepositoryAssociationOutput) SetAssociation added in v1.42.16 

func (s *UpdateDataRepositoryAssociationOutput) SetAssociation(v *DataRepositoryAssociation) *UpdateDataRepositoryAssociationOutput

SetAssociation sets the Association field's value.

func (UpdateDataRepositoryAssociationOutput) String added in v1.42.16 

func (s UpdateDataRepositoryAssociationOutput) 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 UpdateFileCacheInput added in v1.44.108 

type UpdateFileCacheInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 cache that you are updating.
	//
	// FileCacheId is a required field
	FileCacheId *string `min:"11" type:"string" required:"true"`

	// The configuration updates for an Amazon File Cache resource.
	LustreConfiguration *UpdateFileCacheLustreConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateFileCacheInput) GoString added in v1.44.108 

func (s UpdateFileCacheInput) 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 (*UpdateFileCacheInput) SetClientRequestToken added in v1.44.108 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateFileCacheInput) SetFileCacheId added in v1.44.108 

func (s *UpdateFileCacheInput) SetFileCacheId(v string) *UpdateFileCacheInput

SetFileCacheId sets the FileCacheId field's value.

func (*UpdateFileCacheInput) SetLustreConfiguration added in v1.44.108 

func (s *UpdateFileCacheInput) SetLustreConfiguration(v *UpdateFileCacheLustreConfiguration) *UpdateFileCacheInput

SetLustreConfiguration sets the LustreConfiguration field's value.

func (UpdateFileCacheInput) String added in v1.44.108 

func (s UpdateFileCacheInput) 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 (*UpdateFileCacheInput) Validate added in v1.44.108 

func (s *UpdateFileCacheInput) Validate() error

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

type UpdateFileCacheLustreConfiguration added in v1.44.108 

type UpdateFileCacheLustreConfiguration struct {

	// 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 update for an Amazon File Cache resource.

func (UpdateFileCacheLustreConfiguration) GoString added in v1.44.108 

func (s UpdateFileCacheLustreConfiguration) 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 (*UpdateFileCacheLustreConfiguration) SetWeeklyMaintenanceStartTime added in v1.44.108 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (UpdateFileCacheLustreConfiguration) String added in v1.44.108 

func (s UpdateFileCacheLustreConfiguration) 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 (*UpdateFileCacheLustreConfiguration) Validate added in v1.44.108 

func (s *UpdateFileCacheLustreConfiguration) Validate() error

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

type UpdateFileCacheOutput added in v1.44.108 

type UpdateFileCacheOutput struct {

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

func (UpdateFileCacheOutput) GoString added in v1.44.108 

func (s UpdateFileCacheOutput) 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 (*UpdateFileCacheOutput) SetFileCache added in v1.44.108 

func (s *UpdateFileCacheOutput) SetFileCache(v *FileCache) *UpdateFileCacheOutput

SetFileCache sets the FileCache field's value.

func (UpdateFileCacheOutput) String added in v1.44.108 

func (s UpdateFileCacheOutput) 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 63 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"`

	// The ID of 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"`

	// The configuration updates for an FSx for OpenZFS file system.
	OpenZFSConfiguration *UpdateFileSystemOpenZFSConfiguration `type:"structure"`

	// Use this parameter to increase the storage capacity of an FSx for Windows
	// File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.
	// Specifies the storage capacity target value, in GiB, to increase the storage
	// capacity for the file system that you're updating.
	//
	// You can't make a storage capacity increase request if there is an existing
	// storage capacity increase request in progress.
	//
	// For Lustre file systems, the storage capacity target value can be the following:
	//
	//    * For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 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-MBps throughput per TiB file systems and multiples of 1800
	//    GiB for 40-MBps throughput per TiB file systems. The values must be greater
	//    than the current storage capacity.
	//
	//    * For SCRATCH_1 file systems, you can't increase the storage capacity.
	//
	// For more information, see Managing storage and throughput capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html)
	// in the FSx for Lustre User Guide.
	//
	// For FSx for OpenZFS file systems, the storage capacity target value must
	// be at least 10 percent greater than the current storage capacity value. For
	// more information, see Managing storage capacity (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html)
	// in the FSx for OpenZFS User Guide.
	//
	// For Windows file systems, the storage capacity target value must be at least
	// 10 percent greater than the current storage capacity value. To increase storage
	// capacity, the file system must have at least 16 MBps of throughput capacity.
	// For more information, see Managing storage capacity (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html)
	// in the Amazon FSxfor Windows File Server User Guide.
	//
	// For ONTAP file systems, the storage capacity target value must be at least
	// 10 percent greater than the current storage capacity value. For more information,
	// see Managing storage capacity and provisioned IOPS (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html)
	// in the Amazon FSx for NetApp ONTAP User Guide.
	StorageCapacity *int64 `type:"integer"`

	// Specifies the file system's storage type.
	StorageType *string `type:"string" enum:"StorageType"`

	// 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) SetOpenZFSConfiguration added in v1.42.16 

func (s *UpdateFileSystemInput) SetOpenZFSConfiguration(v *UpdateFileSystemOpenZFSConfiguration) *UpdateFileSystemInput

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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) SetStorageType added in v1.44.320 

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

SetStorageType sets the StorageType 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.
	//
	//    * NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports
	//    file and directory listings of any new objects added to the S3 bucket,
	//    any existing objects that are changed in the S3 bucket, and any objects
	//    that were deleted in the S3 bucket.
	//
	// This parameter is not supported for file systems with a data repository association.
	AutoImportPolicy *string `type:"string" enum:"AutoImportPolicyType"`

	// The number of days to retain automatic backups. Setting this property 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"`

	// The Lustre logging configuration used when updating an Amazon FSx for Lustre
	// file system. When logging is enabled, Lustre logs error and warning events
	// for data repositories associated with your file system to Amazon CloudWatch
	// Logs.
	LogConfiguration *LustreLogCreateConfiguration `type:"structure"`

	// The Lustre metadata performance configuration for an Amazon FSx for Lustre
	// file system using a PERSISTENT_2 deployment type. When this configuration
	// is enabled, the file system supports increasing metadata performance.
	MetadataConfiguration *UpdateFileSystemLustreMetadataConfiguration `type:"structure"`

	// The throughput of an Amazon FSx for Lustre Persistent SSD-based file system,
	// measured in megabytes per second per tebibyte (MB/s/TiB). You can increase
	// or decrease your file system's throughput. Valid values depend on the deployment
	// type of the file system, as follows:
	//
	//    * For PERSISTENT_1 SSD-based deployment types, valid values are 50, 100,
	//    and 200 MB/s/TiB.
	//
	//    * For PERSISTENT_2 SSD-based deployment types, valid values are 125, 250,
	//    500, and 1000 MB/s/TiB.
	//
	// For more information, see Managing throughput capacity (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-throughput-capacity.html).
	PerUnitStorageThroughput *int64 `min:"12" type:"integer"`

	// The Lustre root squash configuration used when updating an Amazon FSx for
	// Lustre file system. When enabled, root squash restricts root-level access
	// from clients that try to access your file system as a root user.
	RootSquashConfiguration *LustreRootSquashConfiguration `type:"structure"`

	// (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) SetLogConfiguration added in v1.42.16 

func (s *UpdateFileSystemLustreConfiguration) SetLogConfiguration(v *LustreLogCreateConfiguration) *UpdateFileSystemLustreConfiguration

SetLogConfiguration sets the LogConfiguration field's value.

func (*UpdateFileSystemLustreConfiguration) SetMetadataConfiguration added in v1.53.18 

func (s *UpdateFileSystemLustreConfiguration) SetMetadataConfiguration(v *UpdateFileSystemLustreMetadataConfiguration) *UpdateFileSystemLustreConfiguration

SetMetadataConfiguration sets the MetadataConfiguration field's value.

func (*UpdateFileSystemLustreConfiguration) SetPerUnitStorageThroughput added in v1.47.13 

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

SetPerUnitStorageThroughput sets the PerUnitStorageThroughput field's value.

func (*UpdateFileSystemLustreConfiguration) SetRootSquashConfiguration added in v1.44.22 

func (s *UpdateFileSystemLustreConfiguration) SetRootSquashConfiguration(v *LustreRootSquashConfiguration) *UpdateFileSystemLustreConfiguration

SetRootSquashConfiguration sets the RootSquashConfiguration 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 UpdateFileSystemLustreMetadataConfiguration added in v1.53.18 

type UpdateFileSystemLustreMetadataConfiguration struct {

	// (USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision
	// for your file system. Valid values are 1500, 3000, 6000, 12000, and multiples
	// of 12000 up to a maximum of 192000.
	//
	// The value you provide must be greater than or equal to the current number
	// of Metadata IOPS provisioned for the file system.
	Iops *int64 `min:"1500" type:"integer"`

	// The metadata configuration mode for provisioning Metadata IOPS for an FSx
	// for Lustre file system using a PERSISTENT_2 deployment type.
	//
	//    * To increase the Metadata IOPS or to switch from AUTOMATIC mode, specify
	//    USER_PROVISIONED as the value for this parameter. Then use the Iops parameter
	//    to provide a Metadata IOPS value that is greater than or equal to the
	//    current number of Metadata IOPS provisioned for the file system.
	//
	//    * To switch from USER_PROVISIONED mode, specify AUTOMATIC as the value
	//    for this parameter, but do not input a value for Iops. If you request
	//    to switch from USER_PROVISIONED to AUTOMATIC mode and the current Metadata
	//    IOPS value is greater than the automated default, FSx for Lustre rejects
	//    the request because downscaling Metadata IOPS is not supported.
	Mode *string `type:"string" enum:"MetadataConfigurationMode"`
	// contains filtered or unexported fields
}

The Lustre metadata performance configuration update for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type. You can request an increase in your file system's Metadata IOPS and/or switch your file system's metadata configuration mode. For more information, see Managing metadata performance (https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-metadata-performance.html) in the Amazon FSx for Lustre User Guide.

func (UpdateFileSystemLustreMetadataConfiguration) GoString added in v1.53.18 

func (s UpdateFileSystemLustreMetadataConfiguration) 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 (*UpdateFileSystemLustreMetadataConfiguration) SetIops added in v1.53.18 

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

SetIops sets the Iops field's value.

func (*UpdateFileSystemLustreMetadataConfiguration) SetMode added in v1.53.18 

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

SetMode sets the Mode field's value.

func (UpdateFileSystemLustreMetadataConfiguration) String added in v1.53.18 

func (s UpdateFileSystemLustreMetadataConfiguration) 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 (*UpdateFileSystemLustreMetadataConfiguration) Validate added in v1.53.18 

func (s *UpdateFileSystemLustreMetadataConfiguration) 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 {

	// (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables
	// to associate (add) with your Amazon FSx for NetApp ONTAP file system.
	AddRouteTableIds []*string `type:"list"`

	// The number of days to retain automatic backups. Setting this property to
	// 0 disables automatic backups. You can retain automatic backups for a maximum
	// of 90 days. The default is 30.
	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 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 an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case
	// of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more
	// information, see Updating SSD storage capacity and IOPS (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/increase-primary-storage.html).
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

	// Update the password for the fsxadmin user by entering a new password. You
	// use the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage
	// your file system resources. For more information, see Managing resources
	// using NetApp Applicaton (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html).
	//
	// 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"`

	// Use to update the number of high-availability (HA) pairs for a second-generation
	// single-AZ file system. If you increase the number of HA pairs for your file
	// system, you must specify proportional increases for StorageCapacity, Iops,
	// and ThroughputCapacity. For more information, see High-availability (HA)
	// pairs (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs)
	// in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and
	// NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For
	// more information, see Using block storage protocols (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage).
	HAPairs *int64 `min:"1" type:"integer"`

	// (Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route
	// tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file
	// system. You can use the API operation to retrieve the list of VPC route table
	// IDs for a file system.
	RemoveRouteTableIds []*string `type:"list"`

	// Enter a new value to change the amount of throughput capacity for the file
	// system in megabytes per second (MBps). For more information, see Managing
	// throughput capacity (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html)
	// in the FSx for ONTAP User Guide.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The value of ThroughputCapacity and ThroughputCapacityPerHAPair are
	//    not the same value.
	//
	//    * The value of ThroughputCapacity when divided by the value of HAPairs
	//    is outside of the valid range for ThroughputCapacity.
	ThroughputCapacity *int64 `min:"8" type:"integer"`

	// Use to choose the throughput capacity per HA pair, rather than the total
	// throughput for the file system.
	//
	// This field and ThroughputCapacity cannot be defined in the same API call,
	// but one is required.
	//
	// This field and ThroughputCapacity are the same for file systems with one
	// HA pair.
	//
	//    * For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256,
	//    512, 1024, 2048, or 4096 MBps.
	//
	//    * For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.
	//
	//    * For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
	//
	// Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following
	// conditions:
	//
	//    * The value of ThroughputCapacity and ThroughputCapacityPerHAPair are
	//    not the same value for file systems with one HA pair.
	//
	//    * The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity /
	//    ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1
	//    and 12).
	//
	//    * The value of ThroughputCapacityPerHAPair is not a valid value.
	ThroughputCapacityPerHAPair *int64 `min:"128" 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
}

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) SetAddRouteTableIds added in v1.44.147 

func (s *UpdateFileSystemOntapConfiguration) SetAddRouteTableIds(v []*string) *UpdateFileSystemOntapConfiguration

SetAddRouteTableIds sets the AddRouteTableIds field's value.

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) SetDiskIopsConfiguration added in v1.42.41 

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

SetDiskIopsConfiguration sets the DiskIopsConfiguration 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) SetHAPairs added in v1.54.17 

func (s *UpdateFileSystemOntapConfiguration) SetHAPairs(v int64) *UpdateFileSystemOntapConfiguration

SetHAPairs sets the HAPairs field's value.

func (*UpdateFileSystemOntapConfiguration) SetRemoveRouteTableIds added in v1.44.147 

func (s *UpdateFileSystemOntapConfiguration) SetRemoveRouteTableIds(v []*string) *UpdateFileSystemOntapConfiguration

SetRemoveRouteTableIds sets the RemoveRouteTableIds field's value.

func (*UpdateFileSystemOntapConfiguration) SetThroughputCapacity added in v1.43.29 

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

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*UpdateFileSystemOntapConfiguration) SetThroughputCapacityPerHAPair added in v1.48.4 

func (s *UpdateFileSystemOntapConfiguration) SetThroughputCapacityPerHAPair(v int64) *UpdateFileSystemOntapConfiguration

SetThroughputCapacityPerHAPair sets the ThroughputCapacityPerHAPair 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 UpdateFileSystemOpenZFSConfiguration added in v1.42.16 

type UpdateFileSystemOpenZFSConfiguration struct {

	// (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables
	// to associate (add) with your Amazon FSx for OpenZFS file system.
	AddRouteTableIds []*string `type:"list"`

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

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

	// A Boolean value indicating whether tags for the volume should be copied to
	// snapshots. This value defaults to false. If it's set to true, all tags for
	// the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the
	// snapshot, no tags are copied from the volume, regardless of this value.
	CopyTagsToVolumes *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 SSD IOPS (input/output operations per second) configuration for an Amazon
	// FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS
	// file system. By default, Amazon FSx automatically provisions 3 IOPS per GB
	// of storage capacity. You can provision additional IOPS per GB of storage.
	// The configuration consists of the total number of provisioned SSD IOPS and
	// how it is was provisioned, or the mode (by the customer or by Amazon FSx).
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

	// (Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route
	// tables to disassociate (remove) from your Amazon FSx for OpenZFS file system.
	// You can use the API operation to retrieve the list of VPC route table IDs
	// for a file system.
	RemoveRouteTableIds []*string `type:"list"`

	// The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes
	// per second (MB/s). Valid values depend on the DeploymentType you choose,
	// as follows:
	//
	//    * For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280,
	//    2560, 3840, 5120, 7680, or 10240 MB/s.
	//
	//    * For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072,
	//    or 4096 MB/s.
	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
}

The configuration updates for an Amazon FSx for OpenZFS file system.

func (UpdateFileSystemOpenZFSConfiguration) GoString added in v1.42.16 

func (s UpdateFileSystemOpenZFSConfiguration) 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 (*UpdateFileSystemOpenZFSConfiguration) SetAddRouteTableIds added in v1.44.320 

func (s *UpdateFileSystemOpenZFSConfiguration) SetAddRouteTableIds(v []*string) *UpdateFileSystemOpenZFSConfiguration

SetAddRouteTableIds sets the AddRouteTableIds field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetAutomaticBackupRetentionDays added in v1.42.16 

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

SetAutomaticBackupRetentionDays sets the AutomaticBackupRetentionDays field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetCopyTagsToBackups added in v1.42.16 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetCopyTagsToVolumes added in v1.42.16 

func (s *UpdateFileSystemOpenZFSConfiguration) SetCopyTagsToVolumes(v bool) *UpdateFileSystemOpenZFSConfiguration

SetCopyTagsToVolumes sets the CopyTagsToVolumes field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetDailyAutomaticBackupStartTime added in v1.42.16 

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

SetDailyAutomaticBackupStartTime sets the DailyAutomaticBackupStartTime field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetDiskIopsConfiguration added in v1.42.16 

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

SetDiskIopsConfiguration sets the DiskIopsConfiguration field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetRemoveRouteTableIds added in v1.44.320 

func (s *UpdateFileSystemOpenZFSConfiguration) SetRemoveRouteTableIds(v []*string) *UpdateFileSystemOpenZFSConfiguration

SetRemoveRouteTableIds sets the RemoveRouteTableIds field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetThroughputCapacity added in v1.42.16 

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

SetThroughputCapacity sets the ThroughputCapacity field's value.

func (*UpdateFileSystemOpenZFSConfiguration) SetWeeklyMaintenanceStartTime added in v1.42.16 

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

SetWeeklyMaintenanceStartTime sets the WeeklyMaintenanceStartTime field's value.

func (UpdateFileSystemOpenZFSConfiguration) String added in v1.42.16 

func (s UpdateFileSystemOpenZFSConfiguration) 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 (*UpdateFileSystemOpenZFSConfiguration) Validate added in v1.42.16 

func (s *UpdateFileSystemOpenZFSConfiguration) 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 backups. Setting this property to
	// 0 disables automatic backups. You can retain automatic backups for a maximum
	// of 90 days. The default is 30. 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 SSD IOPS (input/output operations per second) configuration for an Amazon
	// FSx for Windows file system. By default, Amazon FSx automatically provisions
	// 3 IOPS per GiB of storage capacity. You can provision additional IOPS per
	// GiB of storage, up to the maximum limit associated with your chosen throughput
	// capacity.
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

	// 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) SetDiskIopsConfiguration added in v1.44.320 

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

SetDiskIopsConfiguration sets the DiskIopsConfiguration 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 {

	// A boolean flag indicating whether tags for the volume should be copied to
	// backups. This value defaults to false. If it's set to true, all tags for
	// the volume 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 volume, regardless of this value.
	CopyTagsToBackups *bool `type:"boolean"`

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

	// The configured size of the volume, in bytes.
	SizeInBytes *int64 `type:"long"`

	// Specifies the size of the volume in megabytes.
	SizeInMegabytes *int64 `type:"integer"`

	// The configuration object for updating the SnapLock configuration of an FSx
	// for ONTAP SnapLock volume.
	SnaplockConfiguration *UpdateSnaplockConfiguration `type:"structure"`

	// Specifies the snapshot policy for the volume. There are three built-in snapshot
	// policies:
	//
	//    * default: This is the default policy. A maximum of six hourly snapshots
	//    taken five minutes past the hour. A maximum of two daily snapshots taken
	//    Monday through Saturday at 10 minutes after midnight. A maximum of two
	//    weekly snapshots taken every Sunday at 15 minutes after midnight.
	//
	//    * default-1weekly: This policy is the same as the default policy except
	//    that it only retains one snapshot from the weekly schedule.
	//
	//    * none: This policy does not take any snapshots. This policy can be assigned
	//    to volumes to prevent automatic snapshots from being taken.
	//
	// You can also provide the name of a custom policy that you created with the
	// ONTAP CLI or REST API.
	//
	// For more information, see Snapshot policies (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies)
	// in the Amazon FSx for NetApp ONTAP User Guide.
	SnapshotPolicy *string `min:"1" type:"string"`

	// 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) SetCopyTagsToBackups added in v1.44.147 

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

SetCopyTagsToBackups sets the CopyTagsToBackups field's value.

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) SetSizeInBytes added in v1.48.4 

func (s *UpdateOntapVolumeConfiguration) SetSizeInBytes(v int64) *UpdateOntapVolumeConfiguration

SetSizeInBytes sets the SizeInBytes 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) SetSnaplockConfiguration added in v1.44.300 

func (s *UpdateOntapVolumeConfiguration) SetSnaplockConfiguration(v *UpdateSnaplockConfiguration) *UpdateOntapVolumeConfiguration

SetSnaplockConfiguration sets the SnaplockConfiguration field's value.

func (*UpdateOntapVolumeConfiguration) SetSnapshotPolicy added in v1.44.147 

func (s *UpdateOntapVolumeConfiguration) SetSnapshotPolicy(v string) *UpdateOntapVolumeConfiguration

SetSnapshotPolicy sets the SnapshotPolicy 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 UpdateOpenZFSVolumeConfiguration added in v1.42.16 

type UpdateOpenZFSVolumeConfiguration struct {

	// Specifies the method used to compress the data on the volume. The compression
	// type is NONE by default.
	//
	//    * NONE - Doesn't compress the data on the volume. NONE is the default.
	//
	//    * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD)
	//    compression algorithm. Compared to LZ4, Z-Standard provides a better compression
	//    ratio to minimize on-disk storage utilization.
	//
	//    * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm.
	//    Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher
	//    write throughput speeds.
	DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"`

	// The configuration object for mounting a Network File System (NFS) file system.
	NfsExports []*OpenZFSNfsExport `type:"list"`

	// A Boolean value indicating whether the volume is read-only.
	ReadOnly *bool `type:"boolean"`

	// Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid
	// values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128
	// KiB. Most workloads should use the default record size. Database workflows
	// can benefit from a smaller record size, while streaming workflows can benefit
	// from a larger record size. For additional guidance on when to set a custom
	// record size, see Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs)
	// in the Amazon FSx for OpenZFS User Guide.
	RecordSizeKiB *int64 `min:"4" type:"integer"`

	// The maximum amount of storage in gibibytes (GiB) that the volume can use
	// from its parent. You can specify a quota larger than the storage on the parent
	// volume. You can specify a value of -1 to unset a volume's storage capacity
	// quota.
	StorageCapacityQuotaGiB *int64 `type:"integer"`

	// The amount of storage in gibibytes (GiB) to reserve from the parent volume.
	// You can't reserve more storage than the parent volume has reserved. You can
	// specify a value of -1 to unset a volume's storage capacity reservation.
	StorageCapacityReservationGiB *int64 `type:"integer"`

	// An object specifying how much storage users or groups can use on the volume.
	UserAndGroupQuotas []*OpenZFSUserOrGroupQuota `type:"list"`
	// contains filtered or unexported fields
}

Used to specify changes to the OpenZFS configuration for the volume that you are updating.

func (UpdateOpenZFSVolumeConfiguration) GoString added in v1.42.16 

func (s UpdateOpenZFSVolumeConfiguration) 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 (*UpdateOpenZFSVolumeConfiguration) SetDataCompressionType added in v1.42.16 

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

SetDataCompressionType sets the DataCompressionType field's value.

func (*UpdateOpenZFSVolumeConfiguration) SetNfsExports added in v1.42.16 

func (s *UpdateOpenZFSVolumeConfiguration) SetNfsExports(v []*OpenZFSNfsExport) *UpdateOpenZFSVolumeConfiguration

SetNfsExports sets the NfsExports field's value.

func (*UpdateOpenZFSVolumeConfiguration) SetReadOnly added in v1.42.16 

func (s *UpdateOpenZFSVolumeConfiguration) SetReadOnly(v bool) *UpdateOpenZFSVolumeConfiguration

SetReadOnly sets the ReadOnly field's value.

func (*UpdateOpenZFSVolumeConfiguration) SetRecordSizeKiB added in v1.43.8 

func (s *UpdateOpenZFSVolumeConfiguration) SetRecordSizeKiB(v int64) *UpdateOpenZFSVolumeConfiguration

SetRecordSizeKiB sets the RecordSizeKiB field's value.

func (*UpdateOpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB added in v1.42.16 

func (s *UpdateOpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB(v int64) *UpdateOpenZFSVolumeConfiguration

SetStorageCapacityQuotaGiB sets the StorageCapacityQuotaGiB field's value.

func (*UpdateOpenZFSVolumeConfiguration) SetStorageCapacityReservationGiB added in v1.42.16 

func (s *UpdateOpenZFSVolumeConfiguration) SetStorageCapacityReservationGiB(v int64) *UpdateOpenZFSVolumeConfiguration

SetStorageCapacityReservationGiB sets the StorageCapacityReservationGiB field's value.

func (*UpdateOpenZFSVolumeConfiguration) SetUserAndGroupQuotas added in v1.42.16 

func (s *UpdateOpenZFSVolumeConfiguration) SetUserAndGroupQuotas(v []*OpenZFSUserOrGroupQuota) *UpdateOpenZFSVolumeConfiguration

SetUserAndGroupQuotas sets the UserAndGroupQuotas field's value.

func (UpdateOpenZFSVolumeConfiguration) String added in v1.42.16 

func (s UpdateOpenZFSVolumeConfiguration) 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 (*UpdateOpenZFSVolumeConfiguration) Validate added in v1.42.16 

func (s *UpdateOpenZFSVolumeConfiguration) Validate() error

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

type UpdateSharedVpcConfigurationInput added in v1.48.4 

type UpdateSharedVpcConfigurationInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 whether participant accounts can create FSx for ONTAP Multi-AZ
	// file systems in shared subnets. Set to true to enable or false to disable.
	EnableFsxRouteTableUpdatesFromParticipantAccounts *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSharedVpcConfigurationInput) GoString added in v1.48.4 

func (s UpdateSharedVpcConfigurationInput) 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 (*UpdateSharedVpcConfigurationInput) SetClientRequestToken added in v1.48.4 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateSharedVpcConfigurationInput) SetEnableFsxRouteTableUpdatesFromParticipantAccounts added in v1.48.4 

func (s *UpdateSharedVpcConfigurationInput) SetEnableFsxRouteTableUpdatesFromParticipantAccounts(v string) *UpdateSharedVpcConfigurationInput

SetEnableFsxRouteTableUpdatesFromParticipantAccounts sets the EnableFsxRouteTableUpdatesFromParticipantAccounts field's value.

func (UpdateSharedVpcConfigurationInput) String added in v1.48.4 

func (s UpdateSharedVpcConfigurationInput) 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 (*UpdateSharedVpcConfigurationInput) Validate added in v1.48.4 

func (s *UpdateSharedVpcConfigurationInput) Validate() error

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

type UpdateSharedVpcConfigurationOutput added in v1.48.4 

type UpdateSharedVpcConfigurationOutput struct {

	// Indicates whether participant accounts can create FSx for ONTAP Multi-AZ
	// file systems in shared subnets.
	EnableFsxRouteTableUpdatesFromParticipantAccounts *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSharedVpcConfigurationOutput) GoString added in v1.48.4 

func (s UpdateSharedVpcConfigurationOutput) 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 (*UpdateSharedVpcConfigurationOutput) SetEnableFsxRouteTableUpdatesFromParticipantAccounts added in v1.48.4 

func (s *UpdateSharedVpcConfigurationOutput) SetEnableFsxRouteTableUpdatesFromParticipantAccounts(v string) *UpdateSharedVpcConfigurationOutput

SetEnableFsxRouteTableUpdatesFromParticipantAccounts sets the EnableFsxRouteTableUpdatesFromParticipantAccounts field's value.

func (UpdateSharedVpcConfigurationOutput) String added in v1.48.4 

func (s UpdateSharedVpcConfigurationOutput) 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 UpdateSnaplockConfiguration added in v1.44.300 

type UpdateSnaplockConfiguration struct {

	// Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume.
	// The default value is false. If you set AuditLogVolume to true, the SnapLock
	// volume is created as an audit log volume. The minimum retention period for
	// an audit log volume is six months.
	//
	// For more information, see SnapLock audit log volumes (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume).
	AuditLogVolume *bool `type:"boolean"`

	// The configuration object for setting the autocommit period of files in an
	// FSx for ONTAP SnapLock volume.
	AutocommitPeriod *AutocommitPeriod `type:"structure"`

	// Enables, disables, or permanently disables privileged delete on an FSx for
	// ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock
	// administrators to delete write once, read many (WORM) files even if they
	// have active retention periods. PERMANENTLY_DISABLED is a terminal state.
	// If privileged delete is permanently disabled on a SnapLock volume, you can't
	// re-enable it. The default value is DISABLED.
	//
	// For more information, see Privileged delete (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete).
	PrivilegedDelete *string `type:"string" enum:"PrivilegedDelete"`

	// Specifies the retention period of an FSx for ONTAP SnapLock volume.
	RetentionPeriod *SnaplockRetentionPeriod `type:"structure"`

	// Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
	// Volume-append mode allows you to create WORM-appendable files and write data
	// to them incrementally. The default value is false.
	//
	// For more information, see Volume-append mode (https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append).
	VolumeAppendModeEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Updates the SnapLock configuration for an existing FSx for ONTAP volume.

func (UpdateSnaplockConfiguration) GoString added in v1.44.300 

func (s UpdateSnaplockConfiguration) 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 (*UpdateSnaplockConfiguration) SetAuditLogVolume added in v1.44.300 

func (s *UpdateSnaplockConfiguration) SetAuditLogVolume(v bool) *UpdateSnaplockConfiguration

SetAuditLogVolume sets the AuditLogVolume field's value.

func (*UpdateSnaplockConfiguration) SetAutocommitPeriod added in v1.44.300 

func (s *UpdateSnaplockConfiguration) SetAutocommitPeriod(v *AutocommitPeriod) *UpdateSnaplockConfiguration

SetAutocommitPeriod sets the AutocommitPeriod field's value.

func (*UpdateSnaplockConfiguration) SetPrivilegedDelete added in v1.44.300 

func (s *UpdateSnaplockConfiguration) SetPrivilegedDelete(v string) *UpdateSnaplockConfiguration

SetPrivilegedDelete sets the PrivilegedDelete field's value.

func (*UpdateSnaplockConfiguration) SetRetentionPeriod added in v1.44.300 

func (s *UpdateSnaplockConfiguration) SetRetentionPeriod(v *SnaplockRetentionPeriod) *UpdateSnaplockConfiguration

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*UpdateSnaplockConfiguration) SetVolumeAppendModeEnabled added in v1.44.300 

func (s *UpdateSnaplockConfiguration) SetVolumeAppendModeEnabled(v bool) *UpdateSnaplockConfiguration

SetVolumeAppendModeEnabled sets the VolumeAppendModeEnabled field's value.

func (UpdateSnaplockConfiguration) String added in v1.44.300 

func (s UpdateSnaplockConfiguration) 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 (*UpdateSnaplockConfiguration) Validate added in v1.44.300 

func (s *UpdateSnaplockConfiguration) Validate() error

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

type UpdateSnapshotInput added in v1.42.16 

type UpdateSnapshotInput struct {

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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 snapshot to update.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The ID of the snapshot that you want to update, in the format fsvolsnap-0123456789abcdef0.
	//
	// SnapshotId is a required field
	SnapshotId *string `min:"11" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSnapshotInput) GoString added in v1.42.16 

func (s UpdateSnapshotInput) 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 (*UpdateSnapshotInput) SetClientRequestToken added in v1.42.16 

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateSnapshotInput) SetName added in v1.42.16 

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

SetName sets the Name field's value.

func (*UpdateSnapshotInput) SetSnapshotId added in v1.42.16 

func (s *UpdateSnapshotInput) SetSnapshotId(v string) *UpdateSnapshotInput

SetSnapshotId sets the SnapshotId field's value.

func (UpdateSnapshotInput) String added in v1.42.16 

func (s UpdateSnapshotInput) 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 (*UpdateSnapshotInput) Validate added in v1.42.16 

func (s *UpdateSnapshotInput) Validate() error

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

type UpdateSnapshotOutput added in v1.42.16 

type UpdateSnapshotOutput struct {

	// Returned after a successful UpdateSnapshot operation, describing the snapshot
	// that you updated.
	Snapshot *Snapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateSnapshotOutput) GoString added in v1.42.16 

func (s UpdateSnapshotOutput) 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 (*UpdateSnapshotOutput) SetSnapshot added in v1.42.16 

func (s *UpdateSnapshotOutput) SetSnapshot(v *Snapshot) *UpdateSnapshotOutput

SetSnapshot sets the Snapshot field's value.

func (UpdateSnapshotOutput) String added in v1.42.16 

func (s UpdateSnapshotOutput) 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 UpdateStorageVirtualMachineInput added in v1.40.36 

type UpdateStorageVirtualMachineInput struct {

	// Specifies updates to an SVM's Microsoft Active Directory (AD) configuration.
	ActiveDirectoryConfiguration *UpdateSvmActiveDirectoryConfiguration `type:"structure"`

	// (Optional) An idempotency token for resource creation, in a string of up
	// to 63 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"`

	// Specifies a new SvmAdminPassword.
	//
	// 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) configuration.
	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 {

	// Specifies an updated NetBIOS name of the AD computer object NetBiosName to
	// which an SVM is joined.
	NetBiosName *string `min:"1" type:"string"`

	// Specifies changes you are making to the self-managed Microsoft Active Directory
	// configuration to which an FSx for Windows File Server file system or an FSx
	// for ONTAP SVM is joined.
	SelfManagedActiveDirectoryConfiguration *SelfManagedActiveDirectoryConfigurationUpdates `type:"structure"`
	// contains filtered or unexported fields
}

Specifies updates to an FSx for ONTAP storage virtual machine's (SVM) Microsoft Active Directory (AD) configuration. Note that 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) SetNetBiosName added in v1.44.281 

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

SetNetBiosName sets the NetBiosName field's value.

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 63 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 OpenZFS volume. OpenZFS root volumes are automatically named
	// FSX. Child volume names must be unique among their parent volume's children.
	// The name of the volume is part of the mount string for the OpenZFS volume.
	Name *string `min:"1" type:"string"`

	// The configuration of the ONTAP volume that you are updating.
	OntapConfiguration *UpdateOntapVolumeConfiguration `type:"structure"`

	// The configuration of the OpenZFS volume that you are updating.
	OpenZFSConfiguration *UpdateOpenZFSVolumeConfiguration `type:"structure"`

	// The ID of the volume that you want to update, in the format 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) SetName added in v1.42.16 

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

SetName sets the Name 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) SetOpenZFSConfiguration added in v1.42.16 

func (s *UpdateVolumeInput) SetOpenZFSConfiguration(v *UpdateOpenZFSVolumeConfiguration) *UpdateVolumeInput

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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 {

	// A description of the volume just updated. Returned after a successful UpdateVolume
	// API operation.
	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 {

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

	// 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.
	//
	//    * AVAILABLE - The volume is fully available for use.
	//
	//    * CREATED - The volume has been created.
	//
	//    * 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 hasn't started creating the volume.
	Lifecycle *string `type:"string" enum:"VolumeLifecycle"`

	// The reason why the volume lifecycle status 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 configuration of an Amazon FSx for OpenZFS volume.
	OpenZFSConfiguration *OpenZFSVolumeConfiguration `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 the volume.
	VolumeType *string `type:"string" enum:"VolumeType"`
	// contains filtered or unexported fields
}

Describes an Amazon FSx 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) SetAdministrativeActions added in v1.42.16 

func (s *Volume) SetAdministrativeActions(v []*AdministrativeAction) *Volume

SetAdministrativeActions sets the AdministrativeActions field's value.

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) SetOpenZFSConfiguration added in v1.42.16 

func (s *Volume) SetOpenZFSConfiguration(v *OpenZFSVolumeConfiguration) *Volume

SetOpenZFSConfiguration sets the OpenZFSConfiguration 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 or Amazon FSx for OpenZFS 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 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 Firehose 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 Firehose 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 SSD IOPS (input/output operations per second) configuration for an Amazon
	// FSx for Windows file system. By default, Amazon FSx automatically provisions
	// 3 IOPS per GiB of storage capacity. You can provision additional IOPS per
	// GiB of storage, up to the maximum limit associated with your chosen throughput
	// capacity.
	DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"`

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

	// 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) SetDiskIopsConfiguration added in v1.44.320 

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

SetDiskIopsConfiguration sets the DiskIopsConfiguration 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.