types

package
v1.37.0 Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentListEntry 

type AgentListEntry struct {

	// The Amazon Resource Name (ARN) of a DataSync agent.
	AgentArn *string

	// The name of an agent.
	Name *string

	// The platform-related details about the agent, such as the version number.
	Platform *Platform

	// The status of an agent.
	//   - If the status is ONLINE , the agent is configured properly and ready to use.
	//   - If the status is OFFLINE , the agent has been out of contact with DataSync
	//   for five minutes or longer. This can happen for a few reasons. For more
	//   information, see What do I do if my agent is offline? (https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline)
	Status AgentStatus
	// contains filtered or unexported fields
}

Represents a single entry in a list (or array) of DataSync agents when you call the ListAgents (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) operation.

type AgentStatus 

type AgentStatus string
const (
	AgentStatusOnline  AgentStatus = "ONLINE"
	AgentStatusOffline AgentStatus = "OFFLINE"
)

Enum values for AgentStatus

func (AgentStatus) Values added in v0.29.0 

func (AgentStatus) Values() []AgentStatus

Values returns all known values for AgentStatus. 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 Atime 

type Atime string
const (
	AtimeNone       Atime = "NONE"
	AtimeBestEffort Atime = "BEST_EFFORT"
)

Enum values for Atime

func (Atime) Values added in v0.29.0 

func (Atime) Values() []Atime

Values returns all known values for Atime. 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 AzureAccessTier added in v1.26.0 

type AzureAccessTier string
const (
	AzureAccessTierHot     AzureAccessTier = "HOT"
	AzureAccessTierCool    AzureAccessTier = "COOL"
	AzureAccessTierArchive AzureAccessTier = "ARCHIVE"
)

Enum values for AzureAccessTier

func (AzureAccessTier) Values added in v1.26.0 

func (AzureAccessTier) Values() []AzureAccessTier

Values returns all known values for AzureAccessTier. 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 AzureBlobAuthenticationType added in v1.26.0 

type AzureBlobAuthenticationType string
const (
	AzureBlobAuthenticationTypeSas AzureBlobAuthenticationType = "SAS"
)

Enum values for AzureBlobAuthenticationType

func (AzureBlobAuthenticationType) Values added in v1.26.0 

func (AzureBlobAuthenticationType) Values() []AzureBlobAuthenticationType

Values returns all known values for AzureBlobAuthenticationType. 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 AzureBlobSasConfiguration added in v1.26.0 

type AzureBlobSasConfiguration struct {

	// Specifies a SAS token that provides permissions to access your Azure Blob
	// Storage. The token is part of the SAS URI string that comes after the storage
	// resource URI and a question mark. A token looks something like this:
	// sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D
	//
	// This member is required.
	Token *string
	// contains filtered or unexported fields
}

The shared access signature (SAS) configuration that allows DataSync to access your Microsoft Azure Blob Storage. For more information, see SAS tokens (https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens) for accessing your Azure Blob Storage.

type AzureBlobType added in v1.26.0 

type AzureBlobType string
const (
	AzureBlobTypeBlock AzureBlobType = "BLOCK"
)

Enum values for AzureBlobType

func (AzureBlobType) Values added in v1.26.0 

func (AzureBlobType) Values() []AzureBlobType

Values returns all known values for AzureBlobType. 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 Capacity added in v1.24.0 

type Capacity struct {

	// The amount of space in the cluster that's in cloud storage (for example, if
	// you're using data tiering).
	ClusterCloudStorageUsed *int64

	// The amount of space that's being used in a storage system resource without
	// accounting for compression or deduplication.
	LogicalUsed *int64

	// The total amount of space available in a storage system resource.
	Provisioned *int64

	// The amount of space that's being used in a storage system resource.
	Used *int64
	// contains filtered or unexported fields
}

The storage capacity of an on-premises storage system resource (for example, a volume).

type Credentials added in v1.24.0 

type Credentials struct {

	// Specifies the password for your storage system's management interface.
	//
	// This member is required.
	Password *string

	// Specifies the user name for your storage system's management interface.
	//
	// This member is required.
	Username *string
	// contains filtered or unexported fields
}

The credentials that provide DataSync Discovery read access to your on-premises storage system's management interface. DataSync Discovery stores these credentials in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) . For more information, see Accessing your on-premises storage system (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html) .

type DiscoveryJobListEntry added in v1.24.0 

type DiscoveryJobListEntry struct {

	// The Amazon Resource Name (ARN) of a discovery job.
	DiscoveryJobArn *string

	// The status of a discovery job. For more information, see Discovery job statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table)
	// .
	Status DiscoveryJobStatus
	// contains filtered or unexported fields
}

The details about a specific DataSync discovery job.

type DiscoveryJobStatus added in v1.24.0 

type DiscoveryJobStatus string
const (
	DiscoveryJobStatusRunning             DiscoveryJobStatus = "RUNNING"
	DiscoveryJobStatusWarning             DiscoveryJobStatus = "WARNING"
	DiscoveryJobStatusTerminated          DiscoveryJobStatus = "TERMINATED"
	DiscoveryJobStatusFailed              DiscoveryJobStatus = "FAILED"
	DiscoveryJobStatusStopped             DiscoveryJobStatus = "STOPPED"
	DiscoveryJobStatusCompleted           DiscoveryJobStatus = "COMPLETED"
	DiscoveryJobStatusCompletedWithIssues DiscoveryJobStatus = "COMPLETED_WITH_ISSUES"
)

Enum values for DiscoveryJobStatus

func (DiscoveryJobStatus) Values added in v1.24.0 

func (DiscoveryJobStatus) Values() []DiscoveryJobStatus

Values returns all known values for DiscoveryJobStatus. 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 DiscoveryResourceFilter added in v1.24.0 

type DiscoveryResourceFilter string
const (
	DiscoveryResourceFilterSvm DiscoveryResourceFilter = "SVM"
)

Enum values for DiscoveryResourceFilter

func (DiscoveryResourceFilter) Values added in v1.24.0 

func (DiscoveryResourceFilter) Values() []DiscoveryResourceFilter

Values returns all known values for DiscoveryResourceFilter. 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 DiscoveryResourceType added in v1.24.0 

type DiscoveryResourceType string
const (
	DiscoveryResourceTypeSvm     DiscoveryResourceType = "SVM"
	DiscoveryResourceTypeVolume  DiscoveryResourceType = "VOLUME"
	DiscoveryResourceTypeCluster DiscoveryResourceType = "CLUSTER"
)

Enum values for DiscoveryResourceType

func (DiscoveryResourceType) Values added in v1.24.0 

func (DiscoveryResourceType) Values() []DiscoveryResourceType

Values returns all known values for DiscoveryResourceType. 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 DiscoveryServerConfiguration added in v1.24.0 

type DiscoveryServerConfiguration struct {

	// The domain name or IP address of your storage system's management interface.
	//
	// This member is required.
	ServerHostname *string

	// The network port for accessing the storage system's management interface.
	ServerPort *int32
	// contains filtered or unexported fields
}

The network settings that DataSync Discovery uses to connect with your on-premises storage system's management interface.

type DiscoverySystemType added in v1.24.0 

type DiscoverySystemType string
const (
	DiscoverySystemTypeNetAppONTAP DiscoverySystemType = "NetAppONTAP"
)

Enum values for DiscoverySystemType

func (DiscoverySystemType) Values added in v1.24.0 

func (DiscoverySystemType) Values() []DiscoverySystemType

Values returns all known values for DiscoverySystemType. 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 Ec2Config 

type Ec2Config struct {

	// Specifies the Amazon Resource Names (ARNs) of the security groups associated
	// with an Amazon EFS file system's mount target.
	//
	// This member is required.
	SecurityGroupArns []string

	// Specifies the ARN of a subnet where DataSync creates the network interfaces (https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)
	// for managing traffic during your transfer. The subnet must be located:
	//   - In the same virtual private cloud (VPC) as the Amazon EFS file system.
	//   - In the same Availability Zone as at least one mount target for the Amazon
	//   EFS file system.
	// You don't need to specify a subnet that includes a file system mount target.
	//
	// This member is required.
	SubnetArn *string
	// contains filtered or unexported fields
}

The subnet and security groups that DataSync uses to access your Amazon EFS file system.

type EfsInTransitEncryption added in v1.17.0 

type EfsInTransitEncryption string
const (
	EfsInTransitEncryptionNone  EfsInTransitEncryption = "NONE"
	EfsInTransitEncryptionTls12 EfsInTransitEncryption = "TLS1_2"
)

Enum values for EfsInTransitEncryption

func (EfsInTransitEncryption) Values added in v1.17.0 

func (EfsInTransitEncryption) Values() []EfsInTransitEncryption

Values returns all known values for EfsInTransitEncryption. 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 EndpointType 

type EndpointType string
const (
	EndpointTypePublic      EndpointType = "PUBLIC"
	EndpointTypePrivateLink EndpointType = "PRIVATE_LINK"
	EndpointTypeFips        EndpointType = "FIPS"
)

Enum values for EndpointType

func (EndpointType) Values added in v0.29.0 

func (EndpointType) Values() []EndpointType

Values returns all known values for EndpointType. 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 FilterRule 

type FilterRule struct {

	// The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN
	// rule type.
	FilterType FilterType

	// A single filter string that consists of the patterns to include or exclude. The
	// patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
	Value *string
	// contains filtered or unexported fields
}

Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.

type FilterType 

type FilterType string
const (
	FilterTypeSimplePattern FilterType = "SIMPLE_PATTERN"
)

Enum values for FilterType

func (FilterType) Values added in v0.29.0 

func (FilterType) Values() []FilterType

Values returns all known values for FilterType. 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 FsxProtocol added in v1.15.0 

type FsxProtocol struct {

	// Specifies the Network File System (NFS) protocol configuration that DataSync
	// uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's
	// storage virtual machine (SVM).
	NFS *FsxProtocolNfs

	// Specifies the Server Message Block (SMB) protocol configuration that DataSync
	// uses to access your FSx for ONTAP file system's SVM.
	SMB *FsxProtocolSmb
	// contains filtered or unexported fields
}

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

type FsxProtocolNfs added in v1.15.0 

type FsxProtocolNfs struct {

	// Specifies how DataSync can access a location using the NFS protocol.
	MountOptions *NfsMountOptions
	// contains filtered or unexported fields
}

Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file system.

type FsxProtocolSmb added in v1.18.0 

type FsxProtocolSmb struct {

	// Specifies the password of a user who has permission to access your SVM.
	//
	// This member is required.
	Password *string

	// Specifies a user that can mount and access the files, folders, and metadata in
	// your SVM. For information about choosing a user with the right level of access
	// for your transfer, see Using the SMB protocol (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb)
	// .
	//
	// This member is required.
	User *string

	// Specifies the fully qualified domain name (FQDN) of the Microsoft Active
	// Directory that your storage virtual machine (SVM) belongs to. If you have
	// multiple domains in your environment, configuring this setting makes sure that
	// DataSync connects to the right SVM.
	Domain *string

	// Specifies the version of the Server Message Block (SMB) protocol that DataSync
	// uses to access an SMB file server.
	MountOptions *SmbMountOptions
	// contains filtered or unexported fields
}

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see Accessing FSx for ONTAP file systems (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access) .

type Gid 

type Gid string
const (
	GidNone     Gid = "NONE"
	GidIntValue Gid = "INT_VALUE"
	GidName     Gid = "NAME"
	GidBoth     Gid = "BOTH"
)

Enum values for Gid

func (Gid) Values added in v0.29.0 

func (Gid) Values() []Gid

Values returns all known values for Gid. 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 HdfsAuthenticationType added in v1.8.0 

type HdfsAuthenticationType string
const (
	HdfsAuthenticationTypeSimple   HdfsAuthenticationType = "SIMPLE"
	HdfsAuthenticationTypeKerberos HdfsAuthenticationType = "KERBEROS"
)

Enum values for HdfsAuthenticationType

func (HdfsAuthenticationType) Values added in v1.8.0 

func (HdfsAuthenticationType) Values() []HdfsAuthenticationType

Values returns all known values for HdfsAuthenticationType. 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 HdfsDataTransferProtection added in v1.8.0 

type HdfsDataTransferProtection string
const (
	HdfsDataTransferProtectionDisabled       HdfsDataTransferProtection = "DISABLED"
	HdfsDataTransferProtectionAuthentication HdfsDataTransferProtection = "AUTHENTICATION"
	HdfsDataTransferProtectionIntegrity      HdfsDataTransferProtection = "INTEGRITY"
	HdfsDataTransferProtectionPrivacy        HdfsDataTransferProtection = "PRIVACY"
)

Enum values for HdfsDataTransferProtection

func (HdfsDataTransferProtection) Values added in v1.8.0 

func (HdfsDataTransferProtection) Values() []HdfsDataTransferProtection

Values returns all known values for HdfsDataTransferProtection. 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 HdfsNameNode added in v1.8.0 

type HdfsNameNode struct {

	// The hostname of the NameNode in the HDFS cluster. This value is the IP address
	// or Domain Name Service (DNS) name of the NameNode. An agent that's installed
	// on-premises uses this hostname to communicate with the NameNode in the network.
	//
	// This member is required.
	Hostname *string

	// The port that the NameNode uses to listen to client requests.
	//
	// This member is required.
	Port *int32
	// contains filtered or unexported fields
}

The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes.

type HdfsRpcProtection added in v1.8.0 

type HdfsRpcProtection string
const (
	HdfsRpcProtectionDisabled       HdfsRpcProtection = "DISABLED"
	HdfsRpcProtectionAuthentication HdfsRpcProtection = "AUTHENTICATION"
	HdfsRpcProtectionIntegrity      HdfsRpcProtection = "INTEGRITY"
	HdfsRpcProtectionPrivacy        HdfsRpcProtection = "PRIVACY"
)

Enum values for HdfsRpcProtection

func (HdfsRpcProtection) Values added in v1.8.0 

func (HdfsRpcProtection) Values() []HdfsRpcProtection

Values returns all known values for HdfsRpcProtection. 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 IOPS added in v1.24.0 

type IOPS struct {

	// Peak IOPS unrelated to read and write operations.
	Other *float64

	// Peak IOPS related to read operations.
	Read *float64

	// Peak total IOPS on your on-premises storage system resource.
	Total *float64

	// Peak IOPS related to write operations.
	Write *float64
	// contains filtered or unexported fields
}

The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.

type InternalException 

type InternalException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	// contains filtered or unexported fields
}

This exception is thrown when an error occurs in the DataSync service.

func (*InternalException) Error 

func (e *InternalException) Error() string

func (*InternalException) ErrorCode 

func (e *InternalException) ErrorCode() string

func (*InternalException) ErrorFault 

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

func (*InternalException) ErrorMessage 

func (e *InternalException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_        *string
	DatasyncErrorCode *string
	// contains filtered or unexported fields
}

This exception is thrown when the client submits a malformed request.

func (*InvalidRequestException) Error 

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode 

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault 

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

func (*InvalidRequestException) ErrorMessage 

func (e *InvalidRequestException) ErrorMessage() string

type Latency added in v1.24.0 

type Latency struct {

	// Peak latency for operations unrelated to read and write operations.
	Other *float64

	// Peak latency for read operations.
	Read *float64

	// Peak latency for write operations.
	Write *float64
	// contains filtered or unexported fields
}

The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.

type LocationFilter added in v0.29.0 

type LocationFilter struct {

	// The name of the filter being used. Each API call supports a list of filters
	// that are available for it (for example, LocationType for ListLocations ).
	//
	// This member is required.
	Name LocationFilterName

	// The operator that is used to compare filter values (for example, Equals or
	// Contains ).
	//
	// This member is required.
	Operator Operator

	// The values that you want to filter for. For example, you might want to display
	// only Amazon S3 locations.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Narrow down the list of resources returned by ListLocations . For example, to see all your Amazon S3 locations, create a filter using "Name": "LocationType" , "Operator": "Equals" , and "Values": "S3" . For more information, see filtering resources (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html) .

type LocationFilterName added in v0.29.0 

type LocationFilterName string
const (
	LocationFilterNameLocationUri  LocationFilterName = "LocationUri"
	LocationFilterNameLocationType LocationFilterName = "LocationType"
	LocationFilterNameCreationTime LocationFilterName = "CreationTime"
)

Enum values for LocationFilterName

func (LocationFilterName) Values added in v0.29.0 

func (LocationFilterName) Values() []LocationFilterName

Values returns all known values for LocationFilterName. 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 LocationListEntry 

type LocationListEntry struct {

	// The Amazon Resource Name (ARN) of the location. For Network File System (NFS)
	// or Amazon EFS, the location is the export path. For Amazon S3, the location is
	// the prefix path that you want to mount and use as the root of the location.
	LocationArn *string

	// Represents a list of URIs of a location. LocationUri returns an array that
	// contains a list of locations when the ListLocations (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html)
	// operation is called. Format: TYPE://GLOBAL_ID/SUBDIR . TYPE designates the type
	// of location (for example, nfs or s3 ). GLOBAL_ID is the globally unique
	// identifier of the resource that backs the location. An example for EFS is
	// us-east-2.fs-abcd1234 . An example for Amazon S3 is the bucket name, such as
	// myBucket . An example for NFS is a valid IPv4 address or a hostname that is
	// compliant with Domain Name Service (DNS). SUBDIR is a valid file system path,
	// delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS,
	// it's the export path to mount the location. For Amazon S3, it's the prefix path
	// that you mount to and treat as the root of the location.
	LocationUri *string
	// contains filtered or unexported fields
}

Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) operation is called.

type LogLevel 

type LogLevel string
const (
	LogLevelOff      LogLevel = "OFF"
	LogLevelBasic    LogLevel = "BASIC"
	LogLevelTransfer LogLevel = "TRANSFER"
)

Enum values for LogLevel

func (LogLevel) Values added in v0.29.0 

func (LogLevel) Values() []LogLevel

Values returns all known values for LogLevel. 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 ManifestAction added in v1.34.0 

type ManifestAction string
const (
	ManifestActionTransfer ManifestAction = "TRANSFER"
)

Enum values for ManifestAction

func (ManifestAction) Values added in v1.34.0 

func (ManifestAction) Values() []ManifestAction

Values returns all known values for ManifestAction. 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 ManifestConfig added in v1.34.0 

type ManifestConfig struct {

	// Specifies what DataSync uses the manifest for.
	Action ManifestAction

	// Specifies the file format of your manifest. For more information, see Creating
	// a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create)
	// .
	Format ManifestFormat

	// Specifies the manifest that you want DataSync to use and where it's hosted. You
	// must specify this parameter if you're configuring a new manifest on or after
	// February 7, 2024. If you don't, you'll get a 400 status code and
	// ValidationException error stating that you're missing the IAM role for DataSync
	// to access the S3 bucket where you're hosting your manifest. For more
	// information, see Providing DataSync access to your manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access)
	// .
	Source *SourceManifestConfig
	// contains filtered or unexported fields
}

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) .

type ManifestFormat added in v1.34.0 

type ManifestFormat string
const (
	ManifestFormatCsv ManifestFormat = "CSV"
)

Enum values for ManifestFormat

func (ManifestFormat) Values added in v1.34.0 

func (ManifestFormat) Values() []ManifestFormat

Values returns all known values for ManifestFormat. 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 MaxP95Performance added in v1.24.0 

type MaxP95Performance struct {

	// Peak IOPS unrelated to read and write operations.
	IopsOther *float64

	// Peak IOPS related to read operations.
	IopsRead *float64

	// Peak total IOPS on your on-premises storage system resource.
	IopsTotal *float64

	// Peak IOPS related to write operations.
	IopsWrite *float64

	// Peak latency for operations unrelated to read and write operations.
	LatencyOther *float64

	// Peak latency for read operations.
	LatencyRead *float64

	// Peak latency for write operations.
	LatencyWrite *float64

	// Peak throughput unrelated to read and write operations.
	ThroughputOther *float64

	// Peak throughput related to read operations.
	ThroughputRead *float64

	// Peak total throughput on your on-premises storage system resource.
	ThroughputTotal *float64

	// Peak throughput related to write operations.
	ThroughputWrite *float64
	// contains filtered or unexported fields
}

The performance data that DataSync Discovery collects about an on-premises storage system resource.

type Mtime 

type Mtime string
const (
	MtimeNone     Mtime = "NONE"
	MtimePreserve Mtime = "PRESERVE"
)

Enum values for Mtime

func (Mtime) Values added in v0.29.0 

func (Mtime) Values() []Mtime

Values returns all known values for Mtime. 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 NetAppONTAPCluster added in v1.24.0 

type NetAppONTAPCluster struct {

	// The number of CIFS shares in the cluster.
	CifsShareCount *int64

	// The storage space that's being used in the cluster without accounting for
	// compression or deduplication.
	ClusterBlockStorageLogicalUsed *int64

	// The total storage space that's available in the cluster.
	ClusterBlockStorageSize *int64

	// The storage space that's being used in a cluster.
	ClusterBlockStorageUsed *int64

	// The amount of space in the cluster that's in cloud storage (for example, if
	// you're using data tiering).
	ClusterCloudStorageUsed *int64

	// The name of the cluster.
	ClusterName *string

	// The number of LUNs (logical unit numbers) in the cluster.
	LunCount *int64

	// The performance data that DataSync Discovery collects about the cluster.
	MaxP95Performance *MaxP95Performance

	// The number of NFS volumes in the cluster.
	NfsExportedVolumes *int64

	// Indicates whether DataSync Discovery recommendations for the cluster are ready
	// to view, incomplete, or can't be determined. For more information, see
	// Recommendation statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table)
	// .
	RecommendationStatus RecommendationStatus

	// The Amazon Web Services storage services that DataSync Discovery recommends for
	// the cluster. For more information, see Recommendations provided by DataSync
	// Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html)
	// .
	Recommendations []Recommendation

	// The universally unique identifier (UUID) of the cluster.
	ResourceId *string
	// contains filtered or unexported fields
}

The information that DataSync Discovery collects about an on-premises storage system cluster.

type NetAppONTAPSVM added in v1.24.0 

type NetAppONTAPSVM struct {

	// The number of CIFS shares in the SVM.
	CifsShareCount *int64

	// The universally unique identifier (UUID) of the cluster associated with the SVM.
	ClusterUuid *string

	// The data transfer protocols (such as NFS) configured for the SVM.
	EnabledProtocols []string

	// The number of LUNs (logical unit numbers) in the SVM.
	LunCount *int64

	// The performance data that DataSync Discovery collects about the SVM.
	MaxP95Performance *MaxP95Performance

	// The number of NFS volumes in the SVM.
	NfsExportedVolumes *int64

	// Indicates whether DataSync Discovery recommendations for the SVM are ready to
	// view, incomplete, or can't be determined. For more information, see
	// Recommendation statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table)
	// .
	RecommendationStatus RecommendationStatus

	// The Amazon Web Services storage services that DataSync Discovery recommends for
	// the SVM. For more information, see Recommendations provided by DataSync
	// Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html)
	// .
	Recommendations []Recommendation

	// The UUID of the SVM.
	ResourceId *string

	// The name of the SVM
	SvmName *string

	// The total storage space that's available in the SVM.
	TotalCapacityProvisioned *int64

	// The storage space that's being used in the SVM.
	TotalCapacityUsed *int64

	// The storage space that's being used in the SVM without accounting for
	// compression or deduplication.
	TotalLogicalCapacityUsed *int64

	// The amount of storage in the SVM that's being used for snapshots.
	TotalSnapshotCapacityUsed *int64
	// contains filtered or unexported fields
}

The information that DataSync Discovery collects about a storage virtual machine (SVM) in your on-premises storage system.

type NetAppONTAPVolume added in v1.24.0 

type NetAppONTAPVolume struct {

	// The total storage space that's available in the volume.
	CapacityProvisioned *int64

	// The storage space that's being used in the volume.
	CapacityUsed *int64

	// The number of CIFS shares in the volume.
	CifsShareCount *int64

	// The storage space that's being used in the volume without accounting for
	// compression or deduplication.
	LogicalCapacityUsed *int64

	// The number of LUNs (logical unit numbers) in the volume.
	LunCount *int64

	// The performance data that DataSync Discovery collects about the volume.
	MaxP95Performance *MaxP95Performance

	// The number of NFS volumes in the volume.
	NfsExported bool

	// Indicates whether DataSync Discovery recommendations for the volume are ready
	// to view, incomplete, or can't be determined. For more information, see
	// Recommendation statuses (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#recommendation-statuses-table)
	// .
	RecommendationStatus RecommendationStatus

	// The Amazon Web Services storage services that DataSync Discovery recommends for
	// the volume. For more information, see Recommendations provided by DataSync
	// Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html)
	// .
	Recommendations []Recommendation

	// The universally unique identifier (UUID) of the volume.
	ResourceId *string

	// The volume's security style (such as Unix or NTFS).
	SecurityStyle *string

	// The amount of storage in the volume that's being used for snapshots.
	SnapshotCapacityUsed *int64

	// The name of the SVM associated with the volume.
	SvmName *string

	// The UUID of the storage virtual machine (SVM) associated with the volume.
	SvmUuid *string

	// The name of the volume.
	VolumeName *string
	// contains filtered or unexported fields
}

The information that DataSync Discovery collects about a volume in your on-premises storage system.

type NfsMountOptions 

type NfsMountOptions struct {

	// Specifies the NFS version that you want DataSync to use when mounting your NFS
	// share. If the server refuses to use the version specified, the task fails. You
	// can specify the following options:
	//   - AUTOMATIC (default): DataSync chooses NFS version 4.1.
	//   - NFS3 : Stateless protocol version that allows for asynchronous writes on the
	//   server.
	//   - NFSv4_0 : Stateful, firewall-friendly protocol version that supports
	//   delegations and pseudo file systems.
	//   - NFSv4_1 : Stateful protocol version that supports sessions, directory
	//   delegations, and parallel data processing. NFS version 4.1 also includes all
	//   features available in version 4.0.
	// DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP
	// locations.
	Version NfsVersion
	// contains filtered or unexported fields
}

Specifies how DataSync can access a location using the NFS protocol.

type NfsVersion 

type NfsVersion string
const (
	NfsVersionAutomatic NfsVersion = "AUTOMATIC"
	NfsVersionNfs3      NfsVersion = "NFS3"
	NfsVersionNfs40     NfsVersion = "NFS4_0"
	NfsVersionNfs41     NfsVersion = "NFS4_1"
)

Enum values for NfsVersion

func (NfsVersion) Values added in v0.29.0 

func (NfsVersion) Values() []NfsVersion

Values returns all known values for NfsVersion. 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 ObjectStorageServerProtocol 

type ObjectStorageServerProtocol string
const (
	ObjectStorageServerProtocolHttps ObjectStorageServerProtocol = "HTTPS"
	ObjectStorageServerProtocolHttp  ObjectStorageServerProtocol = "HTTP"
)

Enum values for ObjectStorageServerProtocol

func (ObjectStorageServerProtocol) Values added in v0.29.0 

func (ObjectStorageServerProtocol) Values() []ObjectStorageServerProtocol

Values returns all known values for ObjectStorageServerProtocol. 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 ObjectTags added in v1.16.0 

type ObjectTags string
const (
	ObjectTagsPreserve ObjectTags = "PRESERVE"
	ObjectTagsNone     ObjectTags = "NONE"
)

Enum values for ObjectTags

func (ObjectTags) Values added in v1.16.0 

func (ObjectTags) Values() []ObjectTags

Values returns all known values for ObjectTags. 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 ObjectVersionIds added in v1.29.0 

type ObjectVersionIds string
const (
	ObjectVersionIdsInclude ObjectVersionIds = "INCLUDE"
	ObjectVersionIdsNone    ObjectVersionIds = "NONE"
)

Enum values for ObjectVersionIds

func (ObjectVersionIds) Values added in v1.29.0 

func (ObjectVersionIds) Values() []ObjectVersionIds

Values returns all known values for ObjectVersionIds. 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 OnPremConfig 

type OnPremConfig struct {

	// The Amazon Resource Names (ARNs) of the agents connecting to a transfer
	// location.
	//
	// This member is required.
	AgentArns []string
	// contains filtered or unexported fields
}

The DataSync agents that are connecting to a Network File System (NFS) location.

type Operator added in v0.29.0 

type Operator string
const (
	OperatorEq          Operator = "Equals"
	OperatorNe          Operator = "NotEquals"
	OperatorIn          Operator = "In"
	OperatorLe          Operator = "LessThanOrEqual"
	OperatorLt          Operator = "LessThan"
	OperatorGe          Operator = "GreaterThanOrEqual"
	OperatorGt          Operator = "GreaterThan"
	OperatorContains    Operator = "Contains"
	OperatorNotContains Operator = "NotContains"
	OperatorBeginsWith  Operator = "BeginsWith"
)

Enum values for Operator

func (Operator) Values added in v0.29.0 

func (Operator) Values() []Operator

Values returns all known values for Operator. 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 Options 

type Options struct {

	// Specifies whether to preserve metadata indicating the last time a file was read
	// or written to. The behavior of Atime isn't fully standard across platforms, so
	// DataSync can only do this on a best-effort basis.
	//   - BEST_EFFORT (default) - DataSync attempts to preserve the original Atime
	//   attribute on all source files (that is, the version before the PREPARING phase
	//   of the task execution). This option is recommended.
	//   - NONE - Ignores Atime .
	// If Atime is set to BEST_EFFORT , Mtime must be set to PRESERVE . If Atime is
	// set to NONE , Mtime must also be NONE .
	Atime Atime

	// Limits the bandwidth used by a DataSync task. For example, if you want DataSync
	// to use a maximum of 1 MB, set this value to 1048576 ( =1024*1024 ).
	BytesPerSecond *int64

	// Specifies the POSIX group ID (GID) of the file's owners.
	//   - INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID,
	//   which is recommended.
	//   - NONE - Ignores UID and GID.
	// For more information, see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied)
	// .
	Gid Gid

	// Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs
	// log group. To specify the log group, see CloudWatchLogGroupArn (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn)
	// .
	//   - BASIC - Publishes logs with only basic information (such as transfer
	//   errors).
	//   - TRANSFER - Publishes logs for all files or objects that your DataSync task
	//   transfers and performs data-integrity checks on.
	//   - OFF - No logs are published.
	LogLevel LogLevel

	// Specifies whether to preserve metadata indicating the last time that a file was
	// written to before the PREPARING phase of your task execution. This option is
	// required when you need to run the a task more than once.
	//   - PRESERVE (default) - Preserves original Mtime , which is recommended.
	//   - NONE - Ignores Mtime .
	// If Mtime is set to PRESERVE , Atime must be set to BEST_EFFORT . If Mtime is
	// set to NONE , Atime must also be set to NONE .
	Mtime Mtime

	// Specifies whether you want DataSync to PRESERVE object tags (default behavior)
	// when transferring between object storage systems. If you want your DataSync task
	// to ignore object tags, specify the NONE value.
	ObjectTags ObjectTags

	// Specifies whether DataSync should modify or preserve data at the destination
	// location.
	//   - ALWAYS (default) - DataSync modifies data in the destination location when
	//   source data (including metadata) has changed. If DataSync overwrites objects,
	//   you might incur additional charges for certain Amazon S3 storage classes (for
	//   example, for retrieval or early deletion). For more information, see Storage
	//   class considerations with Amazon S3 transfers (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
	//   .
	//   - NEVER - DataSync doesn't overwrite data in the destination location even if
	//   the source data has changed. You can use this option to protect against
	//   overwriting changes made to files or objects in the destination.
	OverwriteMode OverwriteMode

	// Specifies which users or groups can access a file for a specific purpose such
	// as reading, writing, or execution of the file. For more information, see
	// Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied)
	// .
	//   - PRESERVE (default) - Preserves POSIX-style permissions, which is
	//   recommended.
	//   - NONE - Ignores POSIX-style permissions.
	// DataSync can preserve extant permissions of a source location.
	PosixPermissions PosixPermissions

	// Specifies whether files in the destination location that don't exist in the
	// source should be preserved. This option can affect your Amazon S3 storage cost.
	// If your task deletes objects, you might incur minimum storage duration charges
	// for certain storage classes. For detailed information, see Considerations when
	// working with Amazon S3 storage classes in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
	// .
	//   - PRESERVE (default) - Ignores such destination files, which is recommended.
	//   - REMOVE - Deletes destination files that aren’t present in the source.
	// If you set this parameter to REMOVE , you can't set TransferMode to ALL . When
	// you transfer all data, DataSync doesn't scan your destination location and
	// doesn't know what to delete.
	PreserveDeletedFiles PreserveDeletedFiles

	// Specifies whether DataSync should preserve the metadata of block and character
	// devices in the source location and recreate the files with that device name and
	// metadata on the destination. DataSync copies only the name and metadata of such
	// devices. DataSync can't copy the actual contents of these devices because
	// they're nonterminal and don't return an end-of-file (EOF) marker.
	//   - NONE (default) - Ignores special devices (recommended).
	//   - PRESERVE - Preserves character and block device metadata. This option
	//   currently isn't supported for Amazon EFS.
	PreserveDevices PreserveDevices

	// Specifies which components of the SMB security descriptor are copied from
	// source to destination objects. This value is only used for transfers between SMB
	// and Amazon FSx for Windows File Server locations or between two FSx for Windows
	// File Server locations. For more information, see how DataSync handles metadata (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html)
	// .
	//   - OWNER_DACL (default) - For each copied object, DataSync copies the following
	//   metadata:
	//   - The object owner.
	//   - NTFS discretionary access control lists (DACLs), which determine whether to
	//   grant access to an object. DataSync won't copy NTFS system access control lists
	//   (SACLs) with this option.
	//   - OWNER_DACL_SACL - For each copied object, DataSync copies the following
	//   metadata:
	//   - The object owner.
	//   - NTFS discretionary access control lists (DACLs), which determine whether to
	//   grant access to an object.
	//   - SACLs, which are used by administrators to log attempts to access a secured
	//   object. Copying SACLs requires granting additional permissions to the Windows
	//   user that DataSync uses to access your SMB location. For information about
	//   choosing a user with the right permissions, see required permissions for SMB (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)
	//   , FSx for Windows File Server (https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions)
	//   , or FSx for ONTAP (https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb)
	//   (depending on the type of location in your transfer).
	//   - NONE - None of the SMB security descriptor components are copied.
	//   Destination objects are owned by the user that was provided for accessing the
	//   destination location. DACLs and SACLs are set based on the destination server’s
	//   configuration.
	SecurityDescriptorCopyFlags SmbSecurityDescriptorCopyFlags

	// Specifies whether your transfer tasks should be put into a queue during certain
	// scenarios when running multiple tasks (https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks)
	// . This is ENABLED by default.
	TaskQueueing TaskQueueing

	// Determines whether DataSync transfers only the data and metadata that differ
	// between the source and the destination location or transfers all the content
	// from the source (without comparing what's in the destination).
	//   - CHANGED (default) - DataSync copies only data or metadata that is new or
	//   different content from the source location to the destination location.
	//   - ALL - DataSync copies everything in the source to the destination without
	//   comparing differences between the locations.
	TransferMode TransferMode

	// Specifies the POSIX user ID (UID) of the file's owner.
	//   - INT_VALUE (default) - Preserves the integer value of UID and group ID (GID),
	//   which is recommended.
	//   - NONE - Ignores UID and GID.
	// For more information, see Metadata copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied)
	// .
	Uid Uid

	// Specifies how and when DataSync checks the integrity of your data during a
	// transfer.
	//   - ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of
	//   transferred files and metadata at the source location. At the end of the
	//   transfer, DataSync then compares this checksum to the checksum calculated on
	//   those files at the destination. We recommend this option when transferring to S3
	//   Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more
	//   information, see Storage class considerations with Amazon S3 locations (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
	//   .
	//   - POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer, DataSync
	//   scans the entire source and destination to verify that both locations are fully
	//   synchronized. If you use a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)
	//   , DataSync only scans and verifies what's listed in the manifest. You can't use
	//   this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier
	//   Deep Archive storage classes. For more information, see Storage class
	//   considerations with Amazon S3 locations (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
	//   .
	//   - NONE - DataSync doesn't run additional verification at the end of the
	//   transfer. All data transmissions are still integrity-checked with checksum
	//   verification during the transfer.
	VerifyMode VerifyMode
	// contains filtered or unexported fields
}

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options. Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) . You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

type OverwriteMode 

type OverwriteMode string
const (
	OverwriteModeAlways OverwriteMode = "ALWAYS"
	OverwriteModeNever  OverwriteMode = "NEVER"
)

Enum values for OverwriteMode

func (OverwriteMode) Values added in v0.29.0 

func (OverwriteMode) Values() []OverwriteMode

Values returns all known values for OverwriteMode. 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 P95Metrics added in v1.24.0 

type P95Metrics struct {

	// The IOPS peaks for an on-premises storage system resource. Each data point
	// represents the 95th percentile peak value during a 1-hour interval.
	IOPS *IOPS

	// The latency peaks for an on-premises storage system resource. Each data point
	// represents the 95th percentile peak value during a 1-hour interval.
	Latency *Latency

	// The throughput peaks for an on-premises storage system resource. Each data
	// point represents the 95th percentile peak value during a 1-hour interval.
	Throughput *Throughput
	// contains filtered or unexported fields
}

The types of performance data that DataSync Discovery collects about an on-premises storage system resource.

type PhaseStatus 

type PhaseStatus string
const (
	PhaseStatusPending PhaseStatus = "PENDING"
	PhaseStatusSuccess PhaseStatus = "SUCCESS"
	PhaseStatusError   PhaseStatus = "ERROR"
)

Enum values for PhaseStatus

func (PhaseStatus) Values added in v0.29.0 

func (PhaseStatus) Values() []PhaseStatus

Values returns all known values for PhaseStatus. 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 Platform added in v1.30.0 

type Platform struct {

	// The version of the DataSync agent.
	Version *string
	// contains filtered or unexported fields
}

The platform-related details about the DataSync agent, such as the version number.

type PosixPermissions 

type PosixPermissions string
const (
	PosixPermissionsNone     PosixPermissions = "NONE"
	PosixPermissionsPreserve PosixPermissions = "PRESERVE"
)

Enum values for PosixPermissions

func (PosixPermissions) Values added in v0.29.0 

func (PosixPermissions) Values() []PosixPermissions

Values returns all known values for PosixPermissions. 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 PreserveDeletedFiles 

type PreserveDeletedFiles string
const (
	PreserveDeletedFilesPreserve PreserveDeletedFiles = "PRESERVE"
	PreserveDeletedFilesRemove   PreserveDeletedFiles = "REMOVE"
)

Enum values for PreserveDeletedFiles

func (PreserveDeletedFiles) Values added in v0.29.0 

func (PreserveDeletedFiles) Values() []PreserveDeletedFiles

Values returns all known values for PreserveDeletedFiles. 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 PreserveDevices 

type PreserveDevices string
const (
	PreserveDevicesNone     PreserveDevices = "NONE"
	PreserveDevicesPreserve PreserveDevices = "PRESERVE"
)

Enum values for PreserveDevices

func (PreserveDevices) Values added in v0.29.0 

func (PreserveDevices) Values() []PreserveDevices

Values returns all known values for PreserveDevices. 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 PrivateLinkConfig 

type PrivateLinkConfig struct {

	// Specifies the VPC endpoint provided by Amazon Web Services PrivateLink (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html)
	// that your agent connects to.
	PrivateLinkEndpoint *string

	// Specifies the Amazon Resource Names (ARN) of the security group that provides
	// DataSync access to your VPC endpoint. You can only specify one ARN.
	SecurityGroupArns []string

	// Specifies the ARN of the subnet where your VPC endpoint is located. You can
	// only specify one ARN.
	SubnetArns []string

	// Specifies the ID of the VPC endpoint that your agent connects to.
	VpcEndpointId *string
	// contains filtered or unexported fields
}

Specifies how your DataSync agent connects to Amazon Web Services using a virtual private cloud (VPC) service endpoint (https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc) . An agent that uses a VPC endpoint isn't accessible over the public internet.

type QopConfiguration added in v1.8.0 

type QopConfiguration struct {

	// The data transfer protection setting configured on the HDFS cluster. This
	// setting corresponds to your dfs.data.transfer.protection setting in the
	// hdfs-site.xml file on your Hadoop cluster.
	DataTransferProtection HdfsDataTransferProtection

	// The RPC protection setting configured on the HDFS cluster. This setting
	// corresponds to your hadoop.rpc.protection setting in your core-site.xml file on
	// your Hadoop cluster.
	RpcProtection HdfsRpcProtection
	// contains filtered or unexported fields
}

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.

type Recommendation added in v1.24.0 

type Recommendation struct {

	// The estimated monthly cost of the recommended Amazon Web Services storage
	// service.
	EstimatedMonthlyStorageCost *string

	// Information about how you can set up a recommended Amazon Web Services storage
	// service.
	StorageConfiguration map[string]string

	// A recommended Amazon Web Services storage service that you can migrate data to
	// based on information that DataSync Discovery collects about your on-premises
	// storage system.
	StorageType *string
	// contains filtered or unexported fields
}

The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system. For more information, see Recommendations provided by DataSync Discovery (https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html) .

type RecommendationStatus added in v1.24.0 

type RecommendationStatus string
const (
	RecommendationStatusNone       RecommendationStatus = "NONE"
	RecommendationStatusInProgress RecommendationStatus = "IN_PROGRESS"
	RecommendationStatusCompleted  RecommendationStatus = "COMPLETED"
	RecommendationStatusFailed     RecommendationStatus = "FAILED"
)

Enum values for RecommendationStatus

func (RecommendationStatus) Values added in v1.24.0 

func (RecommendationStatus) Values() []RecommendationStatus

Values returns all known values for RecommendationStatus. 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 ReportDestination added in v1.29.0 

type ReportDestination struct {

	// Specifies the Amazon S3 bucket where DataSync uploads your task report.
	S3 *ReportDestinationS3
	// contains filtered or unexported fields
}

Specifies where DataSync uploads your task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) .

type ReportDestinationS3 added in v1.29.0 

type ReportDestinationS3 struct {

	// Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync
	// to upload a task report to your S3 bucket. For more information, see Allowing
	// DataSync to upload a task report to an Amazon S3 bucket (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)
	// .
	//
	// This member is required.
	BucketAccessRoleArn *string

	// Specifies the ARN of the S3 bucket where DataSync uploads your report.
	//
	// This member is required.
	S3BucketArn *string

	// Specifies a bucket prefix for your report.
	Subdirectory *string
	// contains filtered or unexported fields
}

Specifies the Amazon S3 bucket where DataSync uploads your task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) .

type ReportLevel added in v1.29.0 

type ReportLevel string
const (
	ReportLevelErrorsOnly         ReportLevel = "ERRORS_ONLY"
	ReportLevelSuccessesAndErrors ReportLevel = "SUCCESSES_AND_ERRORS"
)

Enum values for ReportLevel

func (ReportLevel) Values added in v1.29.0 

func (ReportLevel) Values() []ReportLevel

Values returns all known values for ReportLevel. 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 ReportOutputType added in v1.29.0 

type ReportOutputType string
const (
	ReportOutputTypeSummaryOnly ReportOutputType = "SUMMARY_ONLY"
	ReportOutputTypeStandard    ReportOutputType = "STANDARD"
)

Enum values for ReportOutputType

func (ReportOutputType) Values added in v1.29.0 

func (ReportOutputType) Values() []ReportOutputType

Values returns all known values for ReportOutputType. 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 ReportOverride added in v1.29.0 

type ReportOverride struct {

	// Specifies whether your task report includes errors only or successes and
	// errors. For example, your report might mostly include only what didn't go well
	// in your transfer ( ERRORS_ONLY ). At the same time, you want to verify that your
	// task filter (https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)
	// is working correctly. In this situation, you can get a list of what files
	// DataSync successfully skipped and if something transferred that you didn't to
	// transfer ( SUCCESSES_AND_ERRORS ).
	ReportLevel ReportLevel
	// contains filtered or unexported fields
}

Specifies the level of detail for a particular aspect of your DataSync task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) .

type ReportOverrides added in v1.29.0 

type ReportOverrides struct {

	// Specifies the level of reporting for the files, objects, and directories that
	// DataSync attempted to delete in your destination location. This only applies if
	// you configure your task (https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)
	// to delete data in the destination that isn't in the source.
	Deleted *ReportOverride

	// Specifies the level of reporting for the files, objects, and directories that
	// DataSync attempted to skip during your transfer.
	Skipped *ReportOverride

	// Specifies the level of reporting for the files, objects, and directories that
	// DataSync attempted to transfer.
	Transferred *ReportOverride

	// Specifies the level of reporting for the files, objects, and directories that
	// DataSync attempted to verify at the end of your transfer.
	Verified *ReportOverride
	// contains filtered or unexported fields
}

The level of detail included in each aspect of your DataSync task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) .

type ReportResult added in v1.29.0 

type ReportResult struct {

	// Indicates the code associated with the error if DataSync can't create a
	// complete report.
	ErrorCode *string

	// Provides details about issues creating a report.
	ErrorDetail *string

	// Indicates whether DataSync is still working on your report, created a report,
	// or can't create a complete report.
	Status PhaseStatus
	// contains filtered or unexported fields
}

Indicates whether DataSync created a complete task report (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) for your transfer.

type ResourceDetails added in v1.24.0 

type ResourceDetails struct {

	// The information that DataSync Discovery collects about the cluster in your
	// on-premises storage system.
	NetAppONTAPClusters []NetAppONTAPCluster

	// The information that DataSync Discovery collects about storage virtual machines
	// (SVMs) in your on-premises storage system.
	NetAppONTAPSVMs []NetAppONTAPSVM

	// The information that DataSync Discovery collects about volumes in your
	// on-premises storage system.
	NetAppONTAPVolumes []NetAppONTAPVolume
	// contains filtered or unexported fields
}

Information provided by DataSync Discovery about the resources in your on-premises storage system.

type ResourceMetrics added in v1.24.0 

type ResourceMetrics struct {

	// The storage capacity of the on-premises storage system resource.
	Capacity *Capacity

	// The types of performance data that DataSync Discovery collects about the
	// on-premises storage system resource.
	P95Metrics *P95Metrics

	// The universally unique identifier (UUID) of the on-premises storage system
	// resource.
	ResourceId *string

	// The type of on-premises storage system resource.
	ResourceType DiscoveryResourceType

	// The time when DataSync Discovery collected this information from the resource.
	Timestamp *time.Time
	// contains filtered or unexported fields
}

Information, including performance data and capacity usage, provided by DataSync Discovery about a resource in your on-premises storage system.

type S3Config 

type S3Config struct {

	// Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.
	//
	// This member is required.
	BucketAccessRoleArn *string
	// contains filtered or unexported fields
}

Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket. For more information, see Accessing S3 buckets (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access) .

type S3ManifestConfig added in v1.34.0 

type S3ManifestConfig struct {

	// Specifies the Identity and Access Management (IAM) role that allows DataSync to
	// access your manifest. For more information, see Providing DataSync access to
	// your manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access)
	// .
	//
	// This member is required.
	BucketAccessRoleArn *string

	// Specifies the Amazon S3 object key of your manifest. This can include a prefix
	// (for example, prefix/my-manifest.csv ).
	//
	// This member is required.
	ManifestObjectPath *string

	// Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting
	// your manifest.
	//
	// This member is required.
	S3BucketArn *string

	// Specifies the object version ID of the manifest that you want DataSync to use.
	// If you don't set this, DataSync uses the latest version of the object.
	ManifestObjectVersionId *string
	// contains filtered or unexported fields
}

Specifies the S3 bucket where you're hosting the manifest that you want DataSync to use. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) .

type S3StorageClass 

type S3StorageClass string
const (
	S3StorageClassStandard                S3StorageClass = "STANDARD"
	S3StorageClassStandardIa              S3StorageClass = "STANDARD_IA"
	S3StorageClassOnezoneIa               S3StorageClass = "ONEZONE_IA"
	S3StorageClassIntelligentTiering      S3StorageClass = "INTELLIGENT_TIERING"
	S3StorageClassGlacier                 S3StorageClass = "GLACIER"
	S3StorageClassDeepArchive             S3StorageClass = "DEEP_ARCHIVE"
	S3StorageClassOutposts                S3StorageClass = "OUTPOSTS"
	S3StorageClassGlacierInstantRetrieval S3StorageClass = "GLACIER_INSTANT_RETRIEVAL"
)

Enum values for S3StorageClass

func (S3StorageClass) Values added in v0.29.0 

func (S3StorageClass) Values() []S3StorageClass

Values returns all known values for S3StorageClass. 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 ScheduleDisabledBy added in v1.37.0 

type ScheduleDisabledBy string
const (
	ScheduleDisabledByUser    ScheduleDisabledBy = "USER"
	ScheduleDisabledByService ScheduleDisabledBy = "SERVICE"
)

Enum values for ScheduleDisabledBy

func (ScheduleDisabledBy) Values added in v1.37.0 

func (ScheduleDisabledBy) Values() []ScheduleDisabledBy

Values returns all known values for ScheduleDisabledBy. 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 ScheduleStatus added in v1.37.0 

type ScheduleStatus string
const (
	ScheduleStatusEnabled  ScheduleStatus = "ENABLED"
	ScheduleStatusDisabled ScheduleStatus = "DISABLED"
)

Enum values for ScheduleStatus

func (ScheduleStatus) Values added in v1.37.0 

func (ScheduleStatus) Values() []ScheduleStatus

Values returns all known values for ScheduleStatus. 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 SmbMountOptions 

type SmbMountOptions struct {

	// By default, DataSync automatically chooses an SMB protocol version based on
	// negotiation with your SMB file server. You also can configure DataSync to use a
	// specific SMB version, but we recommend doing this only if DataSync has trouble
	// negotiating with the SMB file server automatically. These are the following
	// options for configuring the SMB version:
	//   - AUTOMATIC (default): DataSync and the SMB file server negotiate the highest
	//   version of SMB that they mutually support between 2.1 and 3.1.1. This is the
	//   recommended option. If you instead choose a specific version that your file
	//   server doesn't support, you may get an Operation Not Supported error.
	//   - SMB3 : Restricts the protocol negotiation to only SMB version 3.0.2.
	//   - SMB2 : Restricts the protocol negotiation to only SMB version 2.1.
	//   - SMB2_0 : Restricts the protocol negotiation to only SMB version 2.0.
	//   - SMB1 : Restricts the protocol negotiation to only SMB version 1.0. The SMB1
	//   option isn't available when creating an Amazon FSx for NetApp ONTAP location (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html)
	//   .
	Version SmbVersion
	// contains filtered or unexported fields
}

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

type SmbSecurityDescriptorCopyFlags added in v1.4.0 

type SmbSecurityDescriptorCopyFlags string
const (
	SmbSecurityDescriptorCopyFlagsNone          SmbSecurityDescriptorCopyFlags = "NONE"
	SmbSecurityDescriptorCopyFlagsOwnerDacl     SmbSecurityDescriptorCopyFlags = "OWNER_DACL"
	SmbSecurityDescriptorCopyFlagsOwnerDaclSacl SmbSecurityDescriptorCopyFlags = "OWNER_DACL_SACL"
)

Enum values for SmbSecurityDescriptorCopyFlags

func (SmbSecurityDescriptorCopyFlags) Values added in v1.4.0 

func (SmbSecurityDescriptorCopyFlags) Values() []SmbSecurityDescriptorCopyFlags

Values returns all known values for SmbSecurityDescriptorCopyFlags. 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 SmbVersion 

type SmbVersion string
const (
	SmbVersionAutomatic SmbVersion = "AUTOMATIC"
	SmbVersionSmb2      SmbVersion = "SMB2"
	SmbVersionSmb3      SmbVersion = "SMB3"
	SmbVersionSmb1      SmbVersion = "SMB1"
	SmbVersionSmb20     SmbVersion = "SMB2_0"
)

Enum values for SmbVersion

func (SmbVersion) Values added in v0.29.0 

func (SmbVersion) Values() []SmbVersion

Values returns all known values for SmbVersion. 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 SourceManifestConfig added in v1.34.0 

type SourceManifestConfig struct {

	// Specifies the S3 bucket where you're hosting your manifest.
	//
	// This member is required.
	S3 *S3ManifestConfig
	// contains filtered or unexported fields
}

Specifies the manifest that you want DataSync to use and where it's hosted. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest (https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html) .

type StorageSystemConnectivityStatus added in v1.24.0 

type StorageSystemConnectivityStatus string
const (
	StorageSystemConnectivityStatusPass    StorageSystemConnectivityStatus = "PASS"
	StorageSystemConnectivityStatusFail    StorageSystemConnectivityStatus = "FAIL"
	StorageSystemConnectivityStatusUnknown StorageSystemConnectivityStatus = "UNKNOWN"
)

Enum values for StorageSystemConnectivityStatus

func (StorageSystemConnectivityStatus) Values added in v1.24.0 

func (StorageSystemConnectivityStatus) Values() []StorageSystemConnectivityStatus

Values returns all known values for StorageSystemConnectivityStatus. 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 StorageSystemListEntry added in v1.24.0 

type StorageSystemListEntry struct {

	// The name of an on-premises storage system that you added to DataSync Discovery.
	Name *string

	// The Amazon Resource Names (ARN) of an on-premises storage system that you added
	// to DataSync Discovery.
	StorageSystemArn *string
	// contains filtered or unexported fields
}

Information that identifies an on-premises storage system that you're using with DataSync Discovery.

type TagListEntry 

type TagListEntry struct {

	// The key for an Amazon Web Services resource tag.
	//
	// This member is required.
	Key *string

	// The value for an Amazon Web Services resource tag.
	Value *string
	// contains filtered or unexported fields
}

A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.

type TaskExecutionListEntry 

type TaskExecutionListEntry struct {

	// The status of a task execution. For more information, see Task execution
	// statuses (https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-execution-statuses)
	// .
	Status TaskExecutionStatus

	// The Amazon Resource Name (ARN) of a task execution.
	TaskExecutionArn *string
	// contains filtered or unexported fields
}

Represents a single entry in a list of DataSync task executions that's returned with the ListTaskExecutions (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) operation.

type TaskExecutionResultDetail 

type TaskExecutionResultDetail struct {

	// Errors that DataSync encountered during execution of the task. You can use this
	// error code to help troubleshoot issues.
	ErrorCode *string

	// Detailed description of an error that was encountered during the task
	// execution. You can use this information to help troubleshoot issues.
	ErrorDetail *string

	// The total time in milliseconds that DataSync spent in the PREPARING phase.
	PrepareDuration *int64

	// The status of the PREPARING phase.
	PrepareStatus PhaseStatus

	// The total time in milliseconds that DataSync took to transfer the file from the
	// source to the destination location.
	TotalDuration *int64

	// The total time in milliseconds that DataSync spent in the TRANSFERRING phase.
	TransferDuration *int64

	// The status of the TRANSFERRING phase.
	TransferStatus PhaseStatus

	// The total time in milliseconds that DataSync spent in the VERIFYING phase.
	VerifyDuration *int64

	// The status of the VERIFYING phase.
	VerifyStatus PhaseStatus
	// contains filtered or unexported fields
}

Describes the detailed result of a TaskExecution operation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.

type TaskExecutionStatus 

type TaskExecutionStatus string
const (
	TaskExecutionStatusQueued       TaskExecutionStatus = "QUEUED"
	TaskExecutionStatusLaunching    TaskExecutionStatus = "LAUNCHING"
	TaskExecutionStatusPreparing    TaskExecutionStatus = "PREPARING"
	TaskExecutionStatusTransferring TaskExecutionStatus = "TRANSFERRING"
	TaskExecutionStatusVerifying    TaskExecutionStatus = "VERIFYING"
	TaskExecutionStatusSuccess      TaskExecutionStatus = "SUCCESS"
	TaskExecutionStatusError        TaskExecutionStatus = "ERROR"
)

Enum values for TaskExecutionStatus

func (TaskExecutionStatus) Values added in v0.29.0 

func (TaskExecutionStatus) Values() []TaskExecutionStatus

Values returns all known values for TaskExecutionStatus. 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 TaskFilter added in v0.29.0 

type TaskFilter struct {

	// The name of the filter being used. Each API call supports a list of filters
	// that are available for it. For example, LocationId for ListTasks .
	//
	// This member is required.
	Name TaskFilterName

	// The operator that is used to compare filter values (for example, Equals or
	// Contains ).
	//
	// This member is required.
	Operator Operator

	// The values that you want to filter for. For example, you might want to display
	// only tasks for a specific destination location.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

You can use API filters to narrow down the list of resources returned by ListTasks . For example, to retrieve all tasks on a source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location. For more information, see filtering DataSync resources (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html) .

type TaskFilterName added in v0.29.0 

type TaskFilterName string
const (
	TaskFilterNameLocationId   TaskFilterName = "LocationId"
	TaskFilterNameCreationTime TaskFilterName = "CreationTime"
)

Enum values for TaskFilterName

func (TaskFilterName) Values added in v0.29.0 

func (TaskFilterName) Values() []TaskFilterName

Values returns all known values for TaskFilterName. 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 TaskListEntry 

type TaskListEntry struct {

	// The name of the task.
	Name *string

	// The status of the task.
	Status TaskStatus

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string
	// contains filtered or unexported fields
}

Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html) operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

type TaskQueueing 

type TaskQueueing string
const (
	TaskQueueingEnabled  TaskQueueing = "ENABLED"
	TaskQueueingDisabled TaskQueueing = "DISABLED"
)

Enum values for TaskQueueing

func (TaskQueueing) Values added in v0.29.0 

func (TaskQueueing) Values() []TaskQueueing

Values returns all known values for TaskQueueing. 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 TaskReportConfig added in v1.29.0 

type TaskReportConfig struct {

	// Specifies the Amazon S3 bucket where DataSync uploads your task report. For
	// more information, see Task reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access)
	// .
	Destination *ReportDestination

	// Specifies whether your task report includes the new version of each object
	// transferred into an S3 bucket. This only applies if you enable versioning on
	// your bucket (https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html)
	// . Keep in mind that setting this to INCLUDE can increase the duration of your
	// task execution.
	ObjectVersionIds ObjectVersionIds

	// Specifies the type of task report that you want:
	//   - SUMMARY_ONLY : Provides necessary details about your task, including the
	//   number of files, objects, and directories transferred and transfer duration.
	//   - STANDARD : Provides complete details about your task, including a full list
	//   of files, objects, and directories that were transferred, skipped, verified, and
	//   more.
	OutputType ReportOutputType

	// Customizes the reporting level for aspects of your task report. For example,
	// your report might generally only include errors, but you could specify that you
	// want a list of successes and errors just for the files that DataSync attempted
	// to delete in your destination location.
	Overrides *ReportOverrides

	// Specifies whether you want your task report to include only what went wrong
	// with your transfer or a list of what succeeded and didn't.
	//   - ERRORS_ONLY : A report shows what DataSync was unable to transfer, skip,
	//   verify, and delete.
	//   - SUCCESSES_AND_ERRORS : A report shows what DataSync was able and unable to
	//   transfer, skip, verify, and delete.
	ReportLevel ReportLevel
	// contains filtered or unexported fields
}

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer. For more information, see Task reports (https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) .

type TaskSchedule 

type TaskSchedule struct {

	// Specifies your task schedule by using a cron expression in UTC time. For
	// information about cron expression syntax, see the Amazon EventBridge User Guide  (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html)
	// .
	//
	// This member is required.
	ScheduleExpression *string

	// Specifies whether to enable or disable your task schedule. Your schedule is
	// enabled by default, but there can be situations where you need to disable it.
	// For example, you might need to pause a recurring transfer or fix an issue with
	// your task or perform maintenance on your storage system. DataSync might disable
	// your schedule automatically if your task fails repeatedly with the same error.
	// For more information, see TaskScheduleDetails (https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html)
	// .
	Status ScheduleStatus
	// contains filtered or unexported fields
}

Configures your DataSync task to run on a schedule (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) (at a minimum interval of 1 hour).

type TaskScheduleDetails added in v1.37.0 

type TaskScheduleDetails struct {

	// Indicates how your task schedule was disabled.
	//   - USER - Your schedule was manually disabled by using the UpdateTask (https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html)
	//   operation or DataSync console.
	//   - SERVICE - Your schedule was automatically disabled by DataSync because the
	//   task failed repeatedly with the same error.
	DisabledBy ScheduleDisabledBy

	// Provides a reason if the task schedule is disabled. If your schedule is
	// disabled by USER , you see a Manually disabled by user. message. If your
	// schedule is disabled by SERVICE , you see an error message to help you
	// understand why the task keeps failing. For information on resolving DataSync
	// errors, see Troubleshooting issues with DataSync transfers (https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)
	// .
	DisabledReason *string

	// Indicates the last time the status of your task schedule changed. For example,
	// if DataSync automatically disables your schedule because of a repeated error,
	// you can see when the schedule was disabled.
	StatusUpdateTime *time.Time
	// contains filtered or unexported fields
}

Provides information about your DataSync task schedule (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) .

type TaskStatus 

type TaskStatus string
const (
	TaskStatusAvailable   TaskStatus = "AVAILABLE"
	TaskStatusCreating    TaskStatus = "CREATING"
	TaskStatusQueued      TaskStatus = "QUEUED"
	TaskStatusRunning     TaskStatus = "RUNNING"
	TaskStatusUnavailable TaskStatus = "UNAVAILABLE"
)

Enum values for TaskStatus

func (TaskStatus) Values added in v0.29.0 

func (TaskStatus) Values() []TaskStatus

Values returns all known values for TaskStatus. 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 Throughput added in v1.24.0 

type Throughput struct {

	// Peak throughput unrelated to read and write operations.
	Other *float64

	// Peak throughput related to read operations.
	Read *float64

	// Peak total throughput on your on-premises storage system resource.
	Total *float64

	// Peak throughput related to write operations.
	Write *float64
	// contains filtered or unexported fields
}

The throughput peaks for an on-premises storage system volume. Each data point represents the 95th percentile peak value during a 1-hour interval.

type TransferMode 

type TransferMode string
const (
	TransferModeChanged TransferMode = "CHANGED"
	TransferModeAll     TransferMode = "ALL"
)

Enum values for TransferMode

func (TransferMode) Values added in v0.29.0 

func (TransferMode) Values() []TransferMode

Values returns all known values for TransferMode. 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 Uid 

type Uid string
const (
	UidNone     Uid = "NONE"
	UidIntValue Uid = "INT_VALUE"
	UidName     Uid = "NAME"
	UidBoth     Uid = "BOTH"
)

Enum values for Uid

func (Uid) Values added in v0.29.0 

func (Uid) Values() []Uid

Values returns all known values for Uid. 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 VerifyMode 

type VerifyMode string
const (
	VerifyModePointInTimeConsistent VerifyMode = "POINT_IN_TIME_CONSISTENT"
	VerifyModeOnlyFilesTransferred  VerifyMode = "ONLY_FILES_TRANSFERRED"
	VerifyModeNone                  VerifyMode = "NONE"
)

Enum values for VerifyMode

func (VerifyMode) Values added in v0.29.0 

func (VerifyMode) Values() []VerifyMode

Values returns all known values for VerifyMode. 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.

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.