package types
import "github.com/aws/aws-sdk-go-v2/service/datasync/types"
Index ¶
- type AgentListEntry
- type AgentStatus
- type Atime
- type Ec2Config
- type EfsInTransitEncryption
- type EndpointType
- type FilterRule
- type FilterType
- type FsxProtocol
- type FsxProtocolNfs
- type FsxProtocolSmb
- type Gid
- type HdfsAuthenticationType
- type HdfsDataTransferProtection
- type HdfsNameNode
- type HdfsRpcProtection
- type InternalException
- func (e *InternalException) Error() string
- func (e *InternalException) ErrorCode() string
- func (e *InternalException) ErrorFault() smithy.ErrorFault
- func (e *InternalException) ErrorMessage() string
- type InvalidRequestException
- func (e *InvalidRequestException) Error() string
- func (e *InvalidRequestException) ErrorCode() string
- func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
- func (e *InvalidRequestException) ErrorMessage() string
- type LocationFilter
- type LocationFilterName
- type LocationListEntry
- type LogLevel
- type Mtime
- type NfsMountOptions
- type NfsVersion
- type ObjectStorageServerProtocol
- type ObjectTags
- type OnPremConfig
- type Operator
- type Options
- type OverwriteMode
- type PhaseStatus
- type PosixPermissions
- type PreserveDeletedFiles
- type PreserveDevices
- type PrivateLinkConfig
- type QopConfiguration
- type S3Config
- type S3StorageClass
- type SmbMountOptions
- type SmbSecurityDescriptorCopyFlags
- type SmbVersion
- type TagListEntry
- type TaskExecutionListEntry
- type TaskExecutionResultDetail
- type TaskExecutionStatus
- type TaskFilter
- type TaskFilterName
- type TaskListEntry
- type TaskQueueing
- type TaskSchedule
- type TaskStatus
- type TransferMode
- type Uid
- type VerifyMode
Types ¶
type AgentListEntry ¶
type AgentListEntry struct { // The Amazon Resource Name (ARN) of the agent. AgentArn *string // The name of the agent. Name *string // The status of the agent. Status AgentStatus // contains filtered or unexported fields }
Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) operation is called.
type AgentStatus ¶
type AgentStatus string
const ( AgentStatusOnline AgentStatus = "ONLINE" AgentStatusOffline AgentStatus = "OFFLINE" )
Enum values for AgentStatus
func (AgentStatus) Values ¶
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
Enum values for Atime
func (Atime) Values ¶
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 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 ¶
type EfsInTransitEncryption string
const ( EfsInTransitEncryptionNone EfsInTransitEncryption = "NONE" EfsInTransitEncryptionTls12 EfsInTransitEncryption = "TLS1_2" )
Enum values for EfsInTransitEncryption
func (EfsInTransitEncryption) Values ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 name that can mount the location and access the files, folders, // and metadata that you need in the SVM. If you provide a user in your Active // Directory, note the following: // // * If you're using Directory Service for // Microsoft Active Directory, the user must be a member of the Amazon Web Services // Delegated FSx Administrators group. // // * If you're using a self-managed Active // Directory, the user must be a member of either the Domain Admins group or a // custom group that you specified for file system administration when you created // your file system. // // Make sure that the user has the permissions it needs to copy // the data you want: // // * SE_TCB_NAME: Required to set object ownership and file // metadata. With this privilege, you also can copy NTFS discretionary access lists // (DACLs). // // * SE_SECURITY_NAME: May be needed to copy NTFS system access control // lists (SACLs). This operation specifically requires the Windows privilege, which // is granted to members of the Domain Admins group. If you configure your task to // copy SACLs, make sure that the user has the required privileges. For information // about copying SACLs, see Ownership and permissions-related options // (https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions). // // 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. Domain *string // Specifies how DataSync can access a location using the SMB protocol. 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 ¶
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 ¶
type HdfsAuthenticationType string
const ( HdfsAuthenticationTypeSimple HdfsAuthenticationType = "SIMPLE" HdfsAuthenticationTypeKerberos HdfsAuthenticationType = "KERBEROS" )
Enum values for HdfsAuthenticationType
func (HdfsAuthenticationType) Values ¶
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 ¶
type HdfsDataTransferProtection string
const ( HdfsDataTransferProtectionDisabled HdfsDataTransferProtection = "DISABLED" HdfsDataTransferProtectionAuthentication HdfsDataTransferProtection = "AUTHENTICATION" HdfsDataTransferProtectionIntegrity HdfsDataTransferProtection = "INTEGRITY" HdfsDataTransferProtectionPrivacy HdfsDataTransferProtection = "PRIVACY" )
Enum values for HdfsDataTransferProtection
func (HdfsDataTransferProtection) Values ¶
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 ¶
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 ¶
type HdfsRpcProtection string
const ( HdfsRpcProtectionDisabled HdfsRpcProtection = "DISABLED" HdfsRpcProtectionAuthentication HdfsRpcProtection = "AUTHENTICATION" HdfsRpcProtectionIntegrity HdfsRpcProtection = "INTEGRITY" HdfsRpcProtectionPrivacy HdfsRpcProtection = "PRIVACY" )
Enum values for HdfsRpcProtection
func (HdfsRpcProtection) Values ¶
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 InternalException ¶
type InternalException struct { Message *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 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 LocationFilter ¶
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 ¶
type LocationFilterName string
const ( LocationFilterNameLocationUri LocationFilterName = "LocationUri" LocationFilterNameLocationType LocationFilterName = "LocationType" LocationFilterNameCreationTime LocationFilterName = "CreationTime" )
Enum values for LocationFilterName
func (LocationFilterName) Values ¶
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 ¶
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 Mtime ¶
type Mtime string
Enum values for Mtime
func (Mtime) Values ¶
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 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 ¶
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 ¶
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 ¶
type ObjectTags string
const ( ObjectTagsPreserve ObjectTags = "PRESERVE" ObjectTagsNone ObjectTags = "NONE" )
Enum values for ObjectTags
func (ObjectTags) Values ¶
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 OnPremConfig ¶
type OnPremConfig struct { // ARNs of the agents to use for an NFS location. // // This member is required. AgentArns []string // contains filtered or unexported fields }
A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
type Operator ¶
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 ¶
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 { // A file metadata value that shows the last time a file was accessed (that is, // when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync // attempts to preserve the original Atime attribute on all source files (that is, // the version before the PREPARING phase). However, Atime's behavior is not fully // standard across platforms, so DataSync can only do this on a best-effort basis. // Default value: BEST_EFFORTBEST_EFFORT: Attempt to preserve the per-file Atime // value (recommended). NONE: Ignore 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 // A value that limits the bandwidth used by DataSync. For example, if you want // DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024). BytesPerSecond *int64 // The POSIX group ID (GID) of the file's owners. For more information, see // Metadata copied by DataSync // (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). // Default value: INT_VALUE. This preserves the integer value of the ID. INT_VALUE: // Preserve the integer value of user ID (UID) and GID (recommended). NONE: Ignore // UID and GID. Gid Gid // A value that determines the type of logs that DataSync publishes to a log stream // in the Amazon CloudWatch log group that you provide. For more information about // providing a log group for DataSync, see CloudWatchLogGroupArn // (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn). // If set to OFF, no logs are published. BASIC publishes logs on errors for // individual files transferred, and TRANSFER publishes logs for every file or // object that is transferred and integrity checked. LogLevel LogLevel // A value that indicates the last time that a file was modified (that is, a file // was written to) before the PREPARING phase. This option is required for cases // when you need to run the same task more than one time. Default Value: // PRESERVEPRESERVE: Preserve original Mtime (recommended) NONE: Ignore 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 object tags are maintained when transferring between object // storage systems. If you want your DataSync task to ignore object tags, specify // the NONE value. Default Value: PRESERVE ObjectTags ObjectTags // A value that determines whether files at the destination should be overwritten // or preserved when copying files. If set to NEVER a destination file will not be // replaced by a source file, even if the destination file differs from the source // file. If you modify files in the destination and you sync the files, you can use // this value to protect against overwriting those changes. Some storage classes // have specific behaviors that can affect your S3 storage cost. 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) // in the DataSync User Guide. OverwriteMode OverwriteMode // A value that determines 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). // Default value: PRESERVEPRESERVE: Preserve POSIX-style permissions (recommended). // NONE: Ignore permissions. DataSync can preserve extant permissions of a source // location. PosixPermissions PosixPermissions // A value that specifies whether files in the destination that don't exist in the // source file system should be preserved. This option can affect your 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) // in the DataSync User Guide. Default value: PRESERVEPRESERVE: Ignore such // destination files (recommended). REMOVE: Delete destination files that aren’t // present in the source. PreserveDeletedFiles PreserveDeletedFiles // A value that determines whether DataSync should preserve the metadata of block // and character devices in the source file system, and re-create the files with // that device name and metadata on the destination. DataSync does not copy the // contents of such devices, only the name and metadata. DataSync can't sync the // actual contents of such devices, because they are nonterminal and don't return // an end-of-file (EOF) marker. Default value: NONENONE: Ignore special devices // (recommended). PRESERVE: Preserve character and block device metadata. This // option isn't currently supported for Amazon EFS. PreserveDevices PreserveDevices // A value that determines 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 // Amazon FSx for Windows File Server locations. For more information about how // DataSync handles metadata, see How DataSync Handles Metadata and Special Files // (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html). // Default value: OWNER_DACLOWNER_DACL: For each copied object, DataSync copies the // following metadata: // // * Object owner. // // * NTFS discretionary access control lists // (DACLs), which determine whether to grant access to an object. // // When choosing // this option, DataSync does NOT copy the NTFS system access control lists // (SACLs), which are used by administrators to log attempts to access a secured // object. OWNER_DACL_SACL: For each copied object, DataSync copies the following // metadata: // // * Object owner. // // * NTFS discretionary access control lists (DACLs), // which determine whether to grant access to an object. // // * NTFS system access // control lists (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 that ensures sufficient permissions to files, // folders, and metadata, see user. 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 // A value that determines whether tasks should be queued before executing the // tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED. If // you use the same agent to run multiple tasks, you can enable the tasks to run in // series. For more information, see Queueing task executions // (https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution). TaskQueueing TaskQueueing // A value that determines whether DataSync transfers only the data and metadata // that differ between the source and the destination location, or whether DataSync // transfers all the content from the source, without comparing to the destination // location. CHANGED: DataSync copies only data or metadata that is new or // different content from the source location to the destination location. ALL: // DataSync copies all source location content to the destination, without // comparing to existing content on the destination. TransferMode TransferMode // The POSIX user ID (UID) of the file's owner. For more information, see Metadata // copied by DataSync // (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). // Default value: INT_VALUE. This preserves the integer value of the ID. INT_VALUE: // Preserve the integer value of UID and group ID (GID) (recommended). NONE: Ignore // UID and GID. Uid Uid // A value that determines whether a data integrity verification should be // performed at the end of a task execution after all data and metadata have been // transferred. For more information, see Configure task settings // (https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html). // Default value: POINT_IN_TIME_CONSISTENTONLY_FILES_TRANSFERRED (recommended): // Perform verification only on files that were transferred. // POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the // end of the transfer to verify that source and destination are fully // synchronized. This option isn't supported when transferring to S3 Glacier // Flexible Retrieval or S3 Glacier Deep Archive storage classes. NONE: No // additional verification is done at the end of the transfer, but all data // transmissions are integrity-checked with checksum verification during the // transfer. VerifyMode VerifyMode // contains filtered or unexported fields }
Represents the options that are available to control the behavior of a StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on. A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html), the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).
type OverwriteMode ¶
type OverwriteMode string
const ( OverwriteModeAlways OverwriteMode = "ALWAYS" OverwriteModeNever OverwriteMode = "NEVER" )
Enum values for OverwriteMode
func (OverwriteMode) Values ¶
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 PhaseStatus ¶
type PhaseStatus string
const ( PhaseStatusPending PhaseStatus = "PENDING" PhaseStatusSuccess PhaseStatus = "SUCCESS" PhaseStatusError PhaseStatus = "ERROR" )
Enum values for PhaseStatus
func (PhaseStatus) Values ¶
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 PosixPermissions ¶
type PosixPermissions string
const ( PosixPermissionsNone PosixPermissions = "NONE" PosixPermissionsPreserve PosixPermissions = "PRESERVE" )
Enum values for PosixPermissions
func (PosixPermissions) Values ¶
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 ¶
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 ¶
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 { // The private endpoint that is configured for an agent that has access to IP // addresses in a PrivateLink // (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html). An // agent that is configured with this endpoint will not be accessible over the // public internet. PrivateLinkEndpoint *string // The Amazon Resource Names (ARNs) of the security groups that are configured for // the EC2 resource that hosts an agent activated in a VPC or an agent that has // access to a VPC endpoint. SecurityGroupArns []string // The Amazon Resource Names (ARNs) of the subnets that are configured for an agent // activated in a VPC or an agent that has access to a VPC endpoint. SubnetArns []string // The ID of the VPC endpoint that is configured for an agent. An agent that is // configured with a VPC endpoint will not be accessible over the public internet. VpcEndpointId *string // contains filtered or unexported fields }
The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).
type QopConfiguration ¶
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 S3Config ¶
type S3Config struct { // The ARN of the IAM role for accessing the S3 bucket. // // This member is required. BucketAccessRoleArn *string // contains filtered or unexported fields }
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket. For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide.
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" )
Enum values for S3StorageClass
func (S3StorageClass) Values ¶
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 SmbMountOptions ¶
type SmbMountOptions struct { // Specifies the SMB version that you want DataSync to use when mounting your SMB // share. If you don't specify a version, DataSync defaults to AUTOMATIC and // chooses a version based on negotiation with the SMB server. Version SmbVersion // contains filtered or unexported fields }
Specifies how DataSync can access a location using the SMB protocol.
type SmbSecurityDescriptorCopyFlags ¶
type SmbSecurityDescriptorCopyFlags string
const ( SmbSecurityDescriptorCopyFlagsNone SmbSecurityDescriptorCopyFlags = "NONE" SmbSecurityDescriptorCopyFlagsOwnerDacl SmbSecurityDescriptorCopyFlags = "OWNER_DACL" SmbSecurityDescriptorCopyFlagsOwnerDaclSacl SmbSecurityDescriptorCopyFlags = "OWNER_DACL_SACL" )
Enum values for SmbSecurityDescriptorCopyFlags
func (SmbSecurityDescriptorCopyFlags) Values ¶
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" )
Enum values for SmbVersion
func (SmbVersion) Values ¶
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 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 }
Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html) operation is called.
type TaskExecutionListEntry ¶
type TaskExecutionListEntry struct { // The status of a task execution. Status TaskExecutionStatus // The Amazon Resource Name (ARN) of the task that was executed. TaskExecutionArn *string // contains filtered or unexported fields }
Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when the ListTaskExecutions (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) operation is called.
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 ¶
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 ¶
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 ¶
type TaskFilterName string
const ( TaskFilterNameLocationId TaskFilterName = "LocationId" TaskFilterNameCreationTime TaskFilterName = "CreationTime" )
Enum values for TaskFilterName
func (TaskFilterName) Values ¶
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 ¶
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 TaskSchedule ¶
type TaskSchedule struct { // A cron expression that specifies when DataSync initiates a scheduled transfer // from a source to a destination location. // // This member is required. ScheduleExpression *string // contains filtered or unexported fields }
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html).
type TaskStatus ¶
type TaskStatus string
const ( TaskStatusAvailable TaskStatus = "AVAILABLE" TaskStatusCreating TaskStatus = "CREATING" TaskStatusQueued TaskStatus = "QUEUED" TaskStatusRunning TaskStatus = "RUNNING" TaskStatus = "UNAVAILABLE" )
Enum values for TaskStatus
func (TaskStatus) Values ¶
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 TransferMode ¶
type TransferMode string
const ( TransferModeChanged TransferMode = "CHANGED" TransferModeAll TransferMode = "ALL" )
Enum values for TransferMode
func (TransferMode) Values ¶
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 ¶
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 ¶
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 ¶
- Version
- v1.18.6
- Published
- Aug 9, 2022
- Platform
- darwin/amd64
- Imports
- 3 packages
- Last checked
- 6 hours ago –
Tools for package owners.