types

package
v0.30.0 Latest Latest
Warning

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

 Go to latest Published: Nov 30, 2020 License: Apache-2.0 Imports: 3 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveDirectoryBackupAttributes 

type ActiveDirectoryBackupAttributes struct {

	// The ID of the AWS Managed Microsoft Active Directory instance to which the file
	// system is joined.
	ActiveDirectoryId *string

	// The fully qualified domain name of the self-managed AD directory.
	DomainName *string
}

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

type ActiveDirectoryError 

type ActiveDirectoryError struct {
	Message *string

	ActiveDirectoryId *string
	Type              ActiveDirectoryErrorType
}

An Active Directory error.

func (*ActiveDirectoryError) Error 

func (e *ActiveDirectoryError) Error() string

func (*ActiveDirectoryError) ErrorCode 

func (e *ActiveDirectoryError) ErrorCode() string

func (*ActiveDirectoryError) ErrorFault 

func (e *ActiveDirectoryError) ErrorFault() smithy.ErrorFault

func (*ActiveDirectoryError) ErrorMessage 

func (e *ActiveDirectoryError) ErrorMessage() string

type ActiveDirectoryErrorType 

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

Enum values for ActiveDirectoryErrorType

func (ActiveDirectoryErrorType) Values added in v0.29.0 

func (ActiveDirectoryErrorType) Values() []ActiveDirectoryErrorType

Values returns all known values for ActiveDirectoryErrorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AdministrativeAction 

type AdministrativeAction struct {

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

	// Provides information about a failed administrative action.
	FailureDetails *AdministrativeActionFailureDetails

	// Provides the percent complete of a STORAGE_OPTIMIZATION administrative action.
	// Does not apply to any other administrative action type.
	ProgressPercent *int32

	// Time that the administrative action request was received.
	RequestTime *time.Time

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

	// Describes the target value for the administration action, provided in the
	// UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative
	// actions.
	TargetFileSystemValues *FileSystem
}

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

type AdministrativeActionFailureDetails 

type AdministrativeActionFailureDetails struct {

	// Error message providing details about the failed administrative action.
	Message *string
}

Provides information about a failed administrative action.

type AdministrativeActionType 

type AdministrativeActionType string
const (
	AdministrativeActionTypeFileSystemUpdate              AdministrativeActionType = "FILE_SYSTEM_UPDATE"
	AdministrativeActionTypeStorageOptimization           AdministrativeActionType = "STORAGE_OPTIMIZATION"
	AdministrativeActionTypeFileSystemAliasAssociation    AdministrativeActionType = "FILE_SYSTEM_ALIAS_ASSOCIATION"
	AdministrativeActionTypeFileSystemAliasDisassociation AdministrativeActionType = "FILE_SYSTEM_ALIAS_DISASSOCIATION"
)

Enum values for AdministrativeActionType

func (AdministrativeActionType) Values added in v0.29.0 

func (AdministrativeActionType) Values() []AdministrativeActionType

Values returns all known values for AdministrativeActionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Alias added in v0.30.0 

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 disassocate the DNS alias from the file
	// system.
	Lifecycle 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 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
}

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.

type AliasLifecycle added in v0.30.0 

type AliasLifecycle string
const (
	AliasLifecycleAvailable    AliasLifecycle = "AVAILABLE"
	AliasLifecycleCreating     AliasLifecycle = "CREATING"
	AliasLifecycleDeleting     AliasLifecycle = "DELETING"
	AliasLifecycleCreateFailed AliasLifecycle = "CREATE_FAILED"
	AliasLifecycleDeleteFailed AliasLifecycle = "DELETE_FAILED"
)

Enum values for AliasLifecycle

func (AliasLifecycle) Values added in v0.30.0 

func (AliasLifecycle) Values() []AliasLifecycle

Values returns all known values for AliasLifecycle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AutoImportPolicyType 

type AutoImportPolicyType string
const (
	AutoImportPolicyTypeNone       AutoImportPolicyType = "NONE"
	AutoImportPolicyTypeNew        AutoImportPolicyType = "NEW"
	AutoImportPolicyTypeNewChanged AutoImportPolicyType = "NEW_CHANGED"
)

Enum values for AutoImportPolicyType

func (AutoImportPolicyType) Values added in v0.29.0 

func (AutoImportPolicyType) Values() []AutoImportPolicyType

Values returns all known values for AutoImportPolicyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Backup 

type Backup struct {

	// The ID of the backup.
	//
	// This member is required.
	BackupId *string

	// The time when a particular backup was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Metadata of the file system associated with the backup. This metadata is
	// persisted even if the file system is deleted.
	//
	// This member is required.
	FileSystem *FileSystem

	// The lifecycle status of the backup.
	//
	// * AVAILABLE - The backup is fully
	// available.
	//
	// * CREATING - FSx is creating the backup.
	//
	// * TRANSFERRING - For
	// Lustre file systems only; FSx is transferring the backup to S3.
	//
	// * DELETED - The
	// backup was deleted is no longer available.
	//
	// * FAILED - Amazon FSx could not
	// complete the backup.
	//
	// This member is required.
	Lifecycle BackupLifecycle

	// The type of the file system backup.
	//
	// This member is required.
	Type BackupType

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

	// Details explaining any failures that occur when creating a backup.
	FailureDetails *BackupFailureDetails

	// The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the
	// backup of the Amazon FSx file system's data at rest.
	KmsKeyId *string

	// The current percent of progress of an asynchronous task.
	ProgressPercent *int32

	// The Amazon Resource Name (ARN) for the backup resource.
	ResourceARN *string

	// Tags associated with a particular file system.
	Tags []Tag
}

A backup of an Amazon FSx for file system.

type BackupFailureDetails 

type BackupFailureDetails struct {

	// A message describing the backup creation failure.
	Message *string
}

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

type BackupInProgress 

type BackupInProgress struct {
	Message *string
}

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

func (*BackupInProgress) Error 

func (e *BackupInProgress) Error() string

func (*BackupInProgress) ErrorCode 

func (e *BackupInProgress) ErrorCode() string

func (*BackupInProgress) ErrorFault 

func (e *BackupInProgress) ErrorFault() smithy.ErrorFault

func (*BackupInProgress) ErrorMessage 

func (e *BackupInProgress) ErrorMessage() string

type BackupLifecycle 

type BackupLifecycle string
const (
	BackupLifecycleAvailable    BackupLifecycle = "AVAILABLE"
	BackupLifecycleCreating     BackupLifecycle = "CREATING"
	BackupLifecycleTransferring BackupLifecycle = "TRANSFERRING"
	BackupLifecycleDeleted      BackupLifecycle = "DELETED"
	BackupLifecycleFailed       BackupLifecycle = "FAILED"
)

Enum values for BackupLifecycle

func (BackupLifecycle) Values added in v0.29.0 

func (BackupLifecycle) Values() []BackupLifecycle

Values returns all known values for BackupLifecycle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BackupNotFound 

type BackupNotFound struct {
	Message *string
}

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

func (*BackupNotFound) Error 

func (e *BackupNotFound) Error() string

func (*BackupNotFound) ErrorCode 

func (e *BackupNotFound) ErrorCode() string

func (*BackupNotFound) ErrorFault 

func (e *BackupNotFound) ErrorFault() smithy.ErrorFault

func (*BackupNotFound) ErrorMessage 

func (e *BackupNotFound) ErrorMessage() string

type BackupRestoring 

type BackupRestoring struct {
	Message *string

	FileSystemId *string
}

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

func (*BackupRestoring) Error 

func (e *BackupRestoring) Error() string

func (*BackupRestoring) ErrorCode 

func (e *BackupRestoring) ErrorCode() string

func (*BackupRestoring) ErrorFault 

func (e *BackupRestoring) ErrorFault() smithy.ErrorFault

func (*BackupRestoring) ErrorMessage 

func (e *BackupRestoring) ErrorMessage() string

type BackupType 

type BackupType string
const (
	BackupTypeAutomatic     BackupType = "AUTOMATIC"
	BackupTypeUserInitiated BackupType = "USER_INITIATED"
	BackupTypeAwsBackup     BackupType = "AWS_BACKUP"
)

Enum values for BackupType

func (BackupType) Values added in v0.29.0 

func (BackupType) Values() []BackupType

Values returns all known values for BackupType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BadRequest 

type BadRequest struct {
	Message *string
}

A generic error indicating a failure with a client request.

func (*BadRequest) Error 

func (e *BadRequest) Error() string

func (*BadRequest) ErrorCode 

func (e *BadRequest) ErrorCode() string

func (*BadRequest) ErrorFault 

func (e *BadRequest) ErrorFault() smithy.ErrorFault

func (*BadRequest) ErrorMessage 

func (e *BadRequest) ErrorMessage() string

type CompletionReport 

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.
	//
	// This member is required.
	Enabled *bool

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

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

	// Required if Enabled is set to true. Specifies the scope of the CompletionReport;
	// FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to
	// FAILED_FILES_ONLY, the CompletionReport only contains information about files
	// that the data repository task failed to process.
	Scope ReportScope
}

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.

type CreateFileSystemLustreConfiguration 

type CreateFileSystemLustreConfiguration struct {

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

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 90 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int32

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

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

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

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

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

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

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

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

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

The Lustre configuration for the file system being created.

type CreateFileSystemWindowsConfiguration 

type CreateFileSystemWindowsConfiguration struct {

	// The throughput of an Amazon FSx file system, measured in megabytes per second,
	// in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
	//
	// This member is required.
	ThroughputCapacity *int32

	// The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that
	// the file system should join when it's created.
	ActiveDirectoryId *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 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

	// The number of days to retain automatic backups. The default is to retain backups
	// for 7 days. Setting this value to 0 disables the creation of automatic backups.
	// The maximum retention period for backups is 90 days.
	AutomaticBackupRetentionDays *int32

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

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

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

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

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

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

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

type DataRepositoryConfiguration 

type DataRepositoryConfiguration struct {

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

	// Provides detailed information about the data respository if its Lifecycle is set
	// to MISCONFIGURED.
	FailureDetails *DataRepositoryFailureDetails

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

	// 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 *int32

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

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

type DataRepositoryFailureDetails 

type DataRepositoryFailureDetails struct {

	// A detailed error message.
	Message *string
}

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

type DataRepositoryLifecycle 

type DataRepositoryLifecycle string
const (
	DataRepositoryLifecycleCreating      DataRepositoryLifecycle = "CREATING"
	DataRepositoryLifecycleAvailable     DataRepositoryLifecycle = "AVAILABLE"
	DataRepositoryLifecycleMisconfigured DataRepositoryLifecycle = "MISCONFIGURED"
	DataRepositoryLifecycleUpdating      DataRepositoryLifecycle = "UPDATING"
	DataRepositoryLifecycleDeleting      DataRepositoryLifecycle = "DELETING"
)

Enum values for DataRepositoryLifecycle

func (DataRepositoryLifecycle) Values added in v0.29.0 

func (DataRepositoryLifecycle) Values() []DataRepositoryLifecycle

Values returns all known values for DataRepositoryLifecycle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataRepositoryTask 

type DataRepositoryTask struct {

	// The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z),
	// also known as Unix time.
	//
	// This member is required.
	CreationTime *time.Time

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

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

	// The system-generated, unique 17-digit ID of the data repository task.
	//
	// This member is required.
	TaskId *string

	// The type of data repository task; EXPORT_TO_REPOSITORY is the only type
	// currently supported.
	//
	// This member is required.
	Type DataRepositoryTaskType

	// The time that Amazon FSx completed processing the task, populated after the task
	// is complete.
	EndTime *time.Time

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

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

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

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

	// The time that Amazon FSx began processing the task.
	StartTime *time.Time

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

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

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

type DataRepositoryTaskEnded 

type DataRepositoryTaskEnded struct {
	Message *string
}

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

func (*DataRepositoryTaskEnded) Error 

func (e *DataRepositoryTaskEnded) Error() string

func (*DataRepositoryTaskEnded) ErrorCode 

func (e *DataRepositoryTaskEnded) ErrorCode() string

func (*DataRepositoryTaskEnded) ErrorFault 

func (e *DataRepositoryTaskEnded) ErrorFault() smithy.ErrorFault

func (*DataRepositoryTaskEnded) ErrorMessage 

func (e *DataRepositoryTaskEnded) ErrorMessage() string

type DataRepositoryTaskExecuting 

type DataRepositoryTaskExecuting struct {
	Message *string
}

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

func (e *DataRepositoryTaskExecuting) Error() string

func (*DataRepositoryTaskExecuting) ErrorCode 

func (e *DataRepositoryTaskExecuting) ErrorCode() string

func (*DataRepositoryTaskExecuting) ErrorFault 

func (e *DataRepositoryTaskExecuting) ErrorFault() smithy.ErrorFault

func (*DataRepositoryTaskExecuting) ErrorMessage 

func (e *DataRepositoryTaskExecuting) ErrorMessage() string

type DataRepositoryTaskFailureDetails 

type DataRepositoryTaskFailureDetails struct {

	// A detailed error message.
	Message *string
}

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

type DataRepositoryTaskFilter 

type DataRepositoryTaskFilter struct {

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

	// Use Values to include the specific file system IDs and task lifecycle states for
	// the filters you are using.
	Values []string
}

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

type DataRepositoryTaskFilterName 

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

Enum values for DataRepositoryTaskFilterName

func (DataRepositoryTaskFilterName) Values added in v0.29.0 

func (DataRepositoryTaskFilterName) Values() []DataRepositoryTaskFilterName

Values returns all known values for DataRepositoryTaskFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataRepositoryTaskLifecycle 

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

Enum values for DataRepositoryTaskLifecycle

func (DataRepositoryTaskLifecycle) Values added in v0.29.0 

func (DataRepositoryTaskLifecycle) Values() []DataRepositoryTaskLifecycle

Values returns all known values for DataRepositoryTaskLifecycle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DataRepositoryTaskNotFound 

type DataRepositoryTaskNotFound struct {
	Message *string
}

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

func (*DataRepositoryTaskNotFound) Error 

func (e *DataRepositoryTaskNotFound) Error() string

func (*DataRepositoryTaskNotFound) ErrorCode 

func (e *DataRepositoryTaskNotFound) ErrorCode() string

func (*DataRepositoryTaskNotFound) ErrorFault 

func (e *DataRepositoryTaskNotFound) ErrorFault() smithy.ErrorFault

func (*DataRepositoryTaskNotFound) ErrorMessage 

func (e *DataRepositoryTaskNotFound) ErrorMessage() string

type DataRepositoryTaskStatus 

type DataRepositoryTaskStatus struct {

	// A running total of the number of files that the task failed to process.
	FailedCount *int64

	// The time at which the task status was last updated.
	LastUpdatedTime *time.Time

	// A running total of the number of files that the task has successfully processed.
	SucceededCount *int64

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

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.

type DataRepositoryTaskType 

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

Enum values for DataRepositoryTaskType

func (DataRepositoryTaskType) Values added in v0.29.0 

func (DataRepositoryTaskType) Values() []DataRepositoryTaskType

Values returns all known values for DataRepositoryTaskType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DeleteFileSystemLustreConfiguration 

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

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

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

type DeleteFileSystemLustreResponse 

type DeleteFileSystemLustreResponse struct {

	// The ID of the final backup for this file system.
	FinalBackupId *string

	// The set of tags applied to the final backup.
	FinalBackupTags []Tag
}

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

type DeleteFileSystemWindowsConfiguration 

type DeleteFileSystemWindowsConfiguration struct {

	// A set of tags for your final backup.
	FinalBackupTags []Tag

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

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

type DeleteFileSystemWindowsResponse 

type DeleteFileSystemWindowsResponse struct {

	// The ID of the final backup for this file system.
	FinalBackupId *string

	// The set of tags applied to the final backup.
	FinalBackupTags []Tag
}

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

type DriveCacheType added in v0.29.0 

type DriveCacheType string
const (
	DriveCacheTypeNone DriveCacheType = "NONE"
	DriveCacheTypeRead DriveCacheType = "READ"
)

Enum values for DriveCacheType

func (DriveCacheType) Values added in v0.29.0 

func (DriveCacheType) Values() []DriveCacheType

Values returns all known values for DriveCacheType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FileSystem 

type FileSystem struct {

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

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

	// The DNS name for the file system.
	DNSName *string

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

	// The system-generated, unique 17-digit ID of the file system.
	FileSystemId *string

	// The type of Amazon FSx file system, either LUSTRE or WINDOWS.
	FileSystemType FileSystemType

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

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

	// The configuration for the Amazon FSx for Lustre file system.
	LustreConfiguration *LustreFileSystemConfiguration

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

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

	// The Amazon Resource Name (ARN) for the file system resource.
	ResourceARN *string

	// The storage capacity of the file system in gigabytes (GB).
	StorageCapacity *int32

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

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

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

	// The ID of the primary VPC for the file system.
	VpcId *string

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

A description of a specific Amazon FSx file system.

type FileSystemFailureDetails 

type FileSystemFailureDetails struct {

	// A message describing any failures that occurred during file system creation.
	Message *string
}

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

type FileSystemLifecycle 

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

Enum values for FileSystemLifecycle

func (FileSystemLifecycle) Values added in v0.29.0 

func (FileSystemLifecycle) Values() []FileSystemLifecycle

Values returns all known values for FileSystemLifecycle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FileSystemMaintenanceOperation 

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

Enum values for FileSystemMaintenanceOperation

func (FileSystemMaintenanceOperation) Values added in v0.29.0 

func (FileSystemMaintenanceOperation) Values() []FileSystemMaintenanceOperation

Values returns all known values for FileSystemMaintenanceOperation. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FileSystemNotFound 

type FileSystemNotFound struct {
	Message *string
}

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

func (*FileSystemNotFound) Error 

func (e *FileSystemNotFound) Error() string

func (*FileSystemNotFound) ErrorCode 

func (e *FileSystemNotFound) ErrorCode() string

func (*FileSystemNotFound) ErrorFault 

func (e *FileSystemNotFound) ErrorFault() smithy.ErrorFault

func (*FileSystemNotFound) ErrorMessage 

func (e *FileSystemNotFound) ErrorMessage() string

type FileSystemType 

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

Enum values for FileSystemType

func (FileSystemType) Values added in v0.29.0 

func (FileSystemType) Values() []FileSystemType

Values returns all known values for FileSystemType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Filter 

type Filter struct {

	// The name for this filter.
	Name FilterName

	// The values of the filter. These are all the values for any of the applied
	// filters.
	Values []string
}

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

type FilterName 

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

Enum values for FilterName

func (FilterName) Values added in v0.29.0 

func (FilterName) Values() []FilterName

Values returns all known values for FilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IncompatibleParameterError 

type IncompatibleParameterError struct {
	Message *string

	Parameter *string
}

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

func (e *IncompatibleParameterError) Error() string

func (*IncompatibleParameterError) ErrorCode 

func (e *IncompatibleParameterError) ErrorCode() string

func (*IncompatibleParameterError) ErrorFault 

func (e *IncompatibleParameterError) ErrorFault() smithy.ErrorFault

func (*IncompatibleParameterError) ErrorMessage 

func (e *IncompatibleParameterError) ErrorMessage() string

type InternalServerError 

type InternalServerError struct {
	Message *string
}

A generic error indicating a server-side failure.

func (*InternalServerError) Error 

func (e *InternalServerError) Error() string

func (*InternalServerError) ErrorCode 

func (e *InternalServerError) ErrorCode() string

func (*InternalServerError) ErrorFault 

func (e *InternalServerError) ErrorFault() smithy.ErrorFault

func (*InternalServerError) ErrorMessage 

func (e *InternalServerError) ErrorMessage() string

type InvalidExportPath 

type InvalidExportPath struct {
	Message *string
}

The path provided for data repository export isn't valid.

func (*InvalidExportPath) Error 

func (e *InvalidExportPath) Error() string

func (*InvalidExportPath) ErrorCode 

func (e *InvalidExportPath) ErrorCode() string

func (*InvalidExportPath) ErrorFault 

func (e *InvalidExportPath) ErrorFault() smithy.ErrorFault

func (*InvalidExportPath) ErrorMessage 

func (e *InvalidExportPath) ErrorMessage() string

type InvalidImportPath 

type InvalidImportPath struct {
	Message *string
}

The path provided for data repository import isn't valid.

func (*InvalidImportPath) Error 

func (e *InvalidImportPath) Error() string

func (*InvalidImportPath) ErrorCode 

func (e *InvalidImportPath) ErrorCode() string

func (*InvalidImportPath) ErrorFault 

func (e *InvalidImportPath) ErrorFault() smithy.ErrorFault

func (*InvalidImportPath) ErrorMessage 

func (e *InvalidImportPath) ErrorMessage() string

type InvalidNetworkSettings 

type InvalidNetworkSettings struct {
	Message *string

	InvalidSubnetId        *string
	InvalidSecurityGroupId *string
}

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

func (*InvalidNetworkSettings) Error 

func (e *InvalidNetworkSettings) Error() string

func (*InvalidNetworkSettings) ErrorCode 

func (e *InvalidNetworkSettings) ErrorCode() string

func (*InvalidNetworkSettings) ErrorFault 

func (e *InvalidNetworkSettings) ErrorFault() smithy.ErrorFault

func (*InvalidNetworkSettings) ErrorMessage 

func (e *InvalidNetworkSettings) ErrorMessage() string

type InvalidPerUnitStorageThroughput 

type InvalidPerUnitStorageThroughput struct {
	Message *string
}

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

func (*InvalidPerUnitStorageThroughput) Error 

func (e *InvalidPerUnitStorageThroughput) Error() string

func (*InvalidPerUnitStorageThroughput) ErrorCode 

func (e *InvalidPerUnitStorageThroughput) ErrorCode() string

func (*InvalidPerUnitStorageThroughput) ErrorFault 

func (e *InvalidPerUnitStorageThroughput) ErrorFault() smithy.ErrorFault

func (*InvalidPerUnitStorageThroughput) ErrorMessage 

func (e *InvalidPerUnitStorageThroughput) ErrorMessage() string

type LustreDeploymentType 

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

Enum values for LustreDeploymentType

func (LustreDeploymentType) Values added in v0.29.0 

func (LustreDeploymentType) Values() []LustreDeploymentType

Values returns all known values for LustreDeploymentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LustreFileSystemConfiguration 

type LustreFileSystemConfiguration struct {

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 90 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int32

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

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

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

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

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

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

	// Per unit storage throughput represents the megabytes per second of read or write
	// throughput per 1 tebibyte of storage provisioned. File system throughput
	// capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput
	// (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types. Valid
	// values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
	PerUnitStorageThroughput *int32

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

The configuration for the Amazon FSx for Lustre file system.

type MissingFileSystemConfiguration 

type MissingFileSystemConfiguration struct {
	Message *string
}

A file system configuration is required for this operation.

func (*MissingFileSystemConfiguration) Error 

func (e *MissingFileSystemConfiguration) Error() string

func (*MissingFileSystemConfiguration) ErrorCode 

func (e *MissingFileSystemConfiguration) ErrorCode() string

func (*MissingFileSystemConfiguration) ErrorFault 

func (e *MissingFileSystemConfiguration) ErrorFault() smithy.ErrorFault

func (*MissingFileSystemConfiguration) ErrorMessage 

func (e *MissingFileSystemConfiguration) ErrorMessage() string

type NotServiceResourceError 

type NotServiceResourceError struct {
	Message *string

	ResourceARN *string
}

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

func (e *NotServiceResourceError) Error() string

func (*NotServiceResourceError) ErrorCode 

func (e *NotServiceResourceError) ErrorCode() string

func (*NotServiceResourceError) ErrorFault 

func (e *NotServiceResourceError) ErrorFault() smithy.ErrorFault

func (*NotServiceResourceError) ErrorMessage 

func (e *NotServiceResourceError) ErrorMessage() string

type ReportFormat 

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

Enum values for ReportFormat

func (ReportFormat) Values added in v0.29.0 

func (ReportFormat) Values() []ReportFormat

Values returns all known values for ReportFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ReportScope 

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

Enum values for ReportScope

func (ReportScope) Values added in v0.29.0 

func (ReportScope) Values() []ReportScope

Values returns all known values for ReportScope. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceDoesNotSupportTagging 

type ResourceDoesNotSupportTagging struct {
	Message *string

	ResourceARN *string
}

The resource specified does not support tagging.

func (*ResourceDoesNotSupportTagging) Error 

func (e *ResourceDoesNotSupportTagging) Error() string

func (*ResourceDoesNotSupportTagging) ErrorCode 

func (e *ResourceDoesNotSupportTagging) ErrorCode() string

func (*ResourceDoesNotSupportTagging) ErrorFault 

func (e *ResourceDoesNotSupportTagging) ErrorFault() smithy.ErrorFault

func (*ResourceDoesNotSupportTagging) ErrorMessage 

func (e *ResourceDoesNotSupportTagging) ErrorMessage() string

type ResourceNotFound 

type ResourceNotFound struct {
	Message *string

	ResourceARN *string
}

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

func (*ResourceNotFound) Error 

func (e *ResourceNotFound) Error() string

func (*ResourceNotFound) ErrorCode 

func (e *ResourceNotFound) ErrorCode() string

func (*ResourceNotFound) ErrorFault 

func (e *ResourceNotFound) ErrorFault() smithy.ErrorFault

func (*ResourceNotFound) ErrorMessage 

func (e *ResourceNotFound) ErrorMessage() string

type SelfManagedActiveDirectoryAttributes 

type SelfManagedActiveDirectoryAttributes struct {

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

	// The fully qualified domain name of the self-managed AD directory.
	DomainName *string

	// The name of the domain group whose members have administrative privileges for
	// the FSx file system.
	FileSystemAdministratorsGroup *string

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

	// The user name for the service account on your self-managed AD domain that FSx
	// uses to join to your AD domain.
	UserName *string
}

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

type SelfManagedActiveDirectoryConfiguration 

type SelfManagedActiveDirectoryConfiguration struct {

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

	// The fully qualified domain name of the self-managed AD directory, such as
	// corp.example.com.
	//
	// This member is required.
	DomainName *string

	// The password for the service account on your self-managed AD domain that Amazon
	// FSx will use to join to your AD domain.
	//
	// This member is required.
	Password *string

	// 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.
	//
	// This member is required.
	UserName *string

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

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

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

type SelfManagedActiveDirectoryConfigurationUpdates 

type SelfManagedActiveDirectoryConfigurationUpdates struct {

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

	// The password for the service account on your self-managed AD domain that Amazon
	// FSx will use to join to your AD domain.
	Password *string

	// The user name for the service account on your self-managed AD domain that Amazon
	// FSx will use to join to your AD domain. This account must have the permission to
	// join computers to the domain in the organizational unit provided in
	// OrganizationalUnitDistinguishedName.
	UserName *string
}

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

type ServiceLimit 

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

Enum values for ServiceLimit

func (ServiceLimit) Values added in v0.29.0 

func (ServiceLimit) Values() []ServiceLimit

Values returns all known values for ServiceLimit. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ServiceLimitExceeded 

type ServiceLimitExceeded struct {
	Message *string

	Limit ServiceLimit
}

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

func (*ServiceLimitExceeded) Error 

func (e *ServiceLimitExceeded) Error() string

func (*ServiceLimitExceeded) ErrorCode 

func (e *ServiceLimitExceeded) ErrorCode() string

func (*ServiceLimitExceeded) ErrorFault 

func (e *ServiceLimitExceeded) ErrorFault() smithy.ErrorFault

func (*ServiceLimitExceeded) ErrorMessage 

func (e *ServiceLimitExceeded) ErrorMessage() string

type Status 

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

Enum values for Status

func (Status) Values added in v0.29.0 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type StorageType 

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

Enum values for StorageType

func (StorageType) Values added in v0.29.0 

func (StorageType) Values() []StorageType

Values returns all known values for StorageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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.
	//
	// This member is required.
	Key *string

	// A value that specifies the TagValue, the value assigned to the corresponding tag
	// key. Tag values can be null and don't have to be unique in a tag set. For
	// example, you can have a key-value pair in a tag set of finances : April and also
	// of payroll : April.
	//
	// This member is required.
	Value *string
}

Specifies a key-value pair for a resource tag.

type UnsupportedOperation 

type UnsupportedOperation struct {
	Message *string
}

The requested operation is not supported for this resource or API.

func (*UnsupportedOperation) Error 

func (e *UnsupportedOperation) Error() string

func (*UnsupportedOperation) ErrorCode 

func (e *UnsupportedOperation) ErrorCode() string

func (*UnsupportedOperation) ErrorFault 

func (e *UnsupportedOperation) ErrorFault() smithy.ErrorFault

func (*UnsupportedOperation) ErrorMessage 

func (e *UnsupportedOperation) ErrorMessage() string

type UpdateFileSystemLustreConfiguration 

type UpdateFileSystemLustreConfiguration struct {

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

	// The number of days to retain automatic backups. Setting this to 0 disables
	// automatic backups. You can retain automatic backups for a maximum of 90 days.
	// The default is 0.
	AutomaticBackupRetentionDays *int32

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

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

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

type UpdateFileSystemWindowsConfiguration 

type UpdateFileSystemWindowsConfiguration struct {

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

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

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

	// 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 *int32

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

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.

type WindowsDeploymentType 

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

Enum values for WindowsDeploymentType

func (WindowsDeploymentType) Values added in v0.29.0 

func (WindowsDeploymentType) Values() []WindowsDeploymentType

Values returns all known values for WindowsDeploymentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WindowsFileSystemConfiguration 

type WindowsFileSystemConfiguration struct {

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

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

	// 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 *int32

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

	// The preferred time to take daily automatic backups, in the UTC time zone.
	DailyAutomaticBackupStartTime *string

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

	// The list of maintenance operations in progress for this file system.
	MaintenanceOperationsInProgress []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

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

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

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

	// The throughput of an Amazon FSx file system, measured in megabytes per second.
	ThroughputCapacity *int32

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

The configuration for this Microsoft Windows file system.

Source Files

View all Source files

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.