| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DataSync.Types
Contents
- Service Configuration
- Errors
- AgentStatus
- Atime
- EndpointType
- FilterType
- Gid
- LocationFilterName
- LogLevel
- Mtime
- NfsVersion
- ObjectStorageServerProtocol
- Operator
- OverwriteMode
- PhaseStatus
- PosixPermissions
- PreserveDeletedFiles
- PreserveDevices
- S3StorageClass
- SmbSecurityDescriptorCopyFlags
- SmbVersion
- TaskExecutionStatus
- TaskFilterName
- TaskQueueing
- TaskStatus
- TransferMode
- Uid
- VerifyMode
- AgentListEntry
- Ec2Config
- FilterRule
- LocationFilter
- LocationListEntry
- NfsMountOptions
- OnPremConfig
- Options
- PrivateLinkConfig
- S3Config
- SmbMountOptions
- TagListEntry
- TaskExecutionListEntry
- TaskExecutionResultDetail
- TaskFilter
- TaskListEntry
- TaskSchedule
Description
Synopsis
- defaultService :: Service
- _InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AgentStatus where
- AgentStatus' { }
- pattern AgentStatus_OFFLINE :: AgentStatus
- pattern AgentStatus_ONLINE :: AgentStatus
- newtype Atime where
- Atime' { }
- pattern Atime_BEST_EFFORT :: Atime
- pattern Atime_NONE :: Atime
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_FIPS :: EndpointType
- pattern EndpointType_PRIVATE_LINK :: EndpointType
- pattern EndpointType_PUBLIC :: EndpointType
- newtype FilterType where
- FilterType' { }
- pattern FilterType_SIMPLE_PATTERN :: FilterType
- newtype Gid where
- newtype LocationFilterName where
- newtype LogLevel where
- LogLevel' {
- fromLogLevel :: Text
- pattern LogLevel_BASIC :: LogLevel
- pattern LogLevel_OFF :: LogLevel
- pattern LogLevel_TRANSFER :: LogLevel
- LogLevel' {
- newtype Mtime where
- Mtime' { }
- pattern Mtime_NONE :: Mtime
- pattern Mtime_PRESERVE :: Mtime
- newtype NfsVersion where
- NfsVersion' { }
- pattern NfsVersion_AUTOMATIC :: NfsVersion
- pattern NfsVersion_NFS3 :: NfsVersion
- pattern NfsVersion_NFS4_0 :: NfsVersion
- pattern NfsVersion_NFS4_1 :: NfsVersion
- newtype ObjectStorageServerProtocol where
- newtype Operator where
- Operator' {
- fromOperator :: Text
- pattern Operator_BeginsWith :: Operator
- pattern Operator_Contains :: Operator
- pattern Operator_Equals :: Operator
- pattern Operator_GreaterThan :: Operator
- pattern Operator_GreaterThanOrEqual :: Operator
- pattern Operator_In :: Operator
- pattern Operator_LessThan :: Operator
- pattern Operator_LessThanOrEqual :: Operator
- pattern Operator_NotContains :: Operator
- pattern Operator_NotEquals :: Operator
- Operator' {
- newtype OverwriteMode where
- OverwriteMode' { }
- pattern OverwriteMode_ALWAYS :: OverwriteMode
- pattern OverwriteMode_NEVER :: OverwriteMode
- newtype PhaseStatus where
- PhaseStatus' { }
- pattern PhaseStatus_ERROR :: PhaseStatus
- pattern PhaseStatus_PENDING :: PhaseStatus
- pattern PhaseStatus_SUCCESS :: PhaseStatus
- newtype PosixPermissions where
- PosixPermissions' { }
- pattern PosixPermissions_NONE :: PosixPermissions
- pattern PosixPermissions_PRESERVE :: PosixPermissions
- newtype PreserveDeletedFiles where
- newtype PreserveDevices where
- PreserveDevices' { }
- pattern PreserveDevices_NONE :: PreserveDevices
- pattern PreserveDevices_PRESERVE :: PreserveDevices
- newtype S3StorageClass where
- S3StorageClass' { }
- pattern S3StorageClass_DEEP_ARCHIVE :: S3StorageClass
- pattern S3StorageClass_GLACIER :: S3StorageClass
- pattern S3StorageClass_INTELLIGENT_TIERING :: S3StorageClass
- pattern S3StorageClass_ONEZONE_IA :: S3StorageClass
- pattern S3StorageClass_OUTPOSTS :: S3StorageClass
- pattern S3StorageClass_STANDARD :: S3StorageClass
- pattern S3StorageClass_STANDARD_IA :: S3StorageClass
- newtype SmbSecurityDescriptorCopyFlags where
- newtype SmbVersion where
- SmbVersion' { }
- pattern SmbVersion_AUTOMATIC :: SmbVersion
- pattern SmbVersion_SMB2 :: SmbVersion
- pattern SmbVersion_SMB3 :: SmbVersion
- newtype TaskExecutionStatus where
- TaskExecutionStatus' { }
- pattern TaskExecutionStatus_ERROR :: TaskExecutionStatus
- pattern TaskExecutionStatus_LAUNCHING :: TaskExecutionStatus
- pattern TaskExecutionStatus_PREPARING :: TaskExecutionStatus
- pattern TaskExecutionStatus_QUEUED :: TaskExecutionStatus
- pattern TaskExecutionStatus_SUCCESS :: TaskExecutionStatus
- pattern TaskExecutionStatus_TRANSFERRING :: TaskExecutionStatus
- pattern TaskExecutionStatus_VERIFYING :: TaskExecutionStatus
- newtype TaskFilterName where
- TaskFilterName' { }
- pattern TaskFilterName_CreationTime :: TaskFilterName
- pattern TaskFilterName_LocationId :: TaskFilterName
- newtype TaskQueueing where
- TaskQueueing' { }
- pattern TaskQueueing_DISABLED :: TaskQueueing
- pattern TaskQueueing_ENABLED :: TaskQueueing
- newtype TaskStatus where
- TaskStatus' { }
- pattern TaskStatus_AVAILABLE :: TaskStatus
- pattern TaskStatus_CREATING :: TaskStatus
- pattern TaskStatus_QUEUED :: TaskStatus
- pattern TaskStatus_RUNNING :: TaskStatus
- pattern TaskStatus_UNAVAILABLE :: TaskStatus
- newtype TransferMode where
- TransferMode' { }
- pattern TransferMode_ALL :: TransferMode
- pattern TransferMode_CHANGED :: TransferMode
- newtype Uid where
- newtype VerifyMode where
- VerifyMode' { }
- pattern VerifyMode_NONE :: VerifyMode
- pattern VerifyMode_ONLY_FILES_TRANSFERRED :: VerifyMode
- pattern VerifyMode_POINT_IN_TIME_CONSISTENT :: VerifyMode
- data AgentListEntry = AgentListEntry' {}
- newAgentListEntry :: AgentListEntry
- agentListEntry_status :: Lens' AgentListEntry (Maybe AgentStatus)
- agentListEntry_agentArn :: Lens' AgentListEntry (Maybe Text)
- agentListEntry_name :: Lens' AgentListEntry (Maybe Text)
- data Ec2Config = Ec2Config' {}
- newEc2Config :: Text -> NonEmpty Text -> Ec2Config
- ec2Config_subnetArn :: Lens' Ec2Config Text
- ec2Config_securityGroupArns :: Lens' Ec2Config (NonEmpty Text)
- data FilterRule = FilterRule' {
- filterType :: Maybe FilterType
- value :: Maybe Text
- newFilterRule :: FilterRule
- filterRule_filterType :: Lens' FilterRule (Maybe FilterType)
- filterRule_value :: Lens' FilterRule (Maybe Text)
- data LocationFilter = LocationFilter' {}
- newLocationFilter :: LocationFilterName -> Operator -> LocationFilter
- locationFilter_name :: Lens' LocationFilter LocationFilterName
- locationFilter_values :: Lens' LocationFilter [Text]
- locationFilter_operator :: Lens' LocationFilter Operator
- data LocationListEntry = LocationListEntry' {
- locationUri :: Maybe Text
- locationArn :: Maybe Text
- newLocationListEntry :: LocationListEntry
- locationListEntry_locationUri :: Lens' LocationListEntry (Maybe Text)
- locationListEntry_locationArn :: Lens' LocationListEntry (Maybe Text)
- data NfsMountOptions = NfsMountOptions' {}
- newNfsMountOptions :: NfsMountOptions
- nfsMountOptions_version :: Lens' NfsMountOptions (Maybe NfsVersion)
- data OnPremConfig = OnPremConfig' {}
- newOnPremConfig :: NonEmpty Text -> OnPremConfig
- onPremConfig_agentArns :: Lens' OnPremConfig (NonEmpty Text)
- data Options = Options' {
- atime :: Maybe Atime
- verifyMode :: Maybe VerifyMode
- taskQueueing :: Maybe TaskQueueing
- logLevel :: Maybe LogLevel
- posixPermissions :: Maybe PosixPermissions
- mtime :: Maybe Mtime
- uid :: Maybe Uid
- bytesPerSecond :: Maybe Integer
- securityDescriptorCopyFlags :: Maybe SmbSecurityDescriptorCopyFlags
- gid :: Maybe Gid
- overwriteMode :: Maybe OverwriteMode
- transferMode :: Maybe TransferMode
- preserveDeletedFiles :: Maybe PreserveDeletedFiles
- preserveDevices :: Maybe PreserveDevices
- newOptions :: Options
- options_atime :: Lens' Options (Maybe Atime)
- options_verifyMode :: Lens' Options (Maybe VerifyMode)
- options_taskQueueing :: Lens' Options (Maybe TaskQueueing)
- options_logLevel :: Lens' Options (Maybe LogLevel)
- options_posixPermissions :: Lens' Options (Maybe PosixPermissions)
- options_mtime :: Lens' Options (Maybe Mtime)
- options_uid :: Lens' Options (Maybe Uid)
- options_bytesPerSecond :: Lens' Options (Maybe Integer)
- options_securityDescriptorCopyFlags :: Lens' Options (Maybe SmbSecurityDescriptorCopyFlags)
- options_gid :: Lens' Options (Maybe Gid)
- options_overwriteMode :: Lens' Options (Maybe OverwriteMode)
- options_transferMode :: Lens' Options (Maybe TransferMode)
- options_preserveDeletedFiles :: Lens' Options (Maybe PreserveDeletedFiles)
- options_preserveDevices :: Lens' Options (Maybe PreserveDevices)
- data PrivateLinkConfig = PrivateLinkConfig' {}
- newPrivateLinkConfig :: PrivateLinkConfig
- privateLinkConfig_securityGroupArns :: Lens' PrivateLinkConfig (Maybe (NonEmpty Text))
- privateLinkConfig_subnetArns :: Lens' PrivateLinkConfig (Maybe (NonEmpty Text))
- privateLinkConfig_privateLinkEndpoint :: Lens' PrivateLinkConfig (Maybe Text)
- privateLinkConfig_vpcEndpointId :: Lens' PrivateLinkConfig (Maybe Text)
- data S3Config = S3Config' {}
- newS3Config :: Text -> S3Config
- s3Config_bucketAccessRoleArn :: Lens' S3Config Text
- data SmbMountOptions = SmbMountOptions' {}
- newSmbMountOptions :: SmbMountOptions
- smbMountOptions_version :: Lens' SmbMountOptions (Maybe SmbVersion)
- data TagListEntry = TagListEntry' {}
- newTagListEntry :: Text -> TagListEntry
- tagListEntry_value :: Lens' TagListEntry (Maybe Text)
- tagListEntry_key :: Lens' TagListEntry Text
- data TaskExecutionListEntry = TaskExecutionListEntry' {}
- newTaskExecutionListEntry :: TaskExecutionListEntry
- taskExecutionListEntry_status :: Lens' TaskExecutionListEntry (Maybe TaskExecutionStatus)
- taskExecutionListEntry_taskExecutionArn :: Lens' TaskExecutionListEntry (Maybe Text)
- data TaskExecutionResultDetail = TaskExecutionResultDetail' {}
- newTaskExecutionResultDetail :: TaskExecutionResultDetail
- taskExecutionResultDetail_prepareDuration :: Lens' TaskExecutionResultDetail (Maybe Natural)
- taskExecutionResultDetail_prepareStatus :: Lens' TaskExecutionResultDetail (Maybe PhaseStatus)
- taskExecutionResultDetail_verifyStatus :: Lens' TaskExecutionResultDetail (Maybe PhaseStatus)
- taskExecutionResultDetail_verifyDuration :: Lens' TaskExecutionResultDetail (Maybe Natural)
- taskExecutionResultDetail_totalDuration :: Lens' TaskExecutionResultDetail (Maybe Natural)
- taskExecutionResultDetail_transferStatus :: Lens' TaskExecutionResultDetail (Maybe PhaseStatus)
- taskExecutionResultDetail_errorCode :: Lens' TaskExecutionResultDetail (Maybe Text)
- taskExecutionResultDetail_transferDuration :: Lens' TaskExecutionResultDetail (Maybe Natural)
- taskExecutionResultDetail_errorDetail :: Lens' TaskExecutionResultDetail (Maybe Text)
- data TaskFilter = TaskFilter' {}
- newTaskFilter :: TaskFilterName -> Operator -> TaskFilter
- taskFilter_name :: Lens' TaskFilter TaskFilterName
- taskFilter_values :: Lens' TaskFilter [Text]
- taskFilter_operator :: Lens' TaskFilter Operator
- data TaskListEntry = TaskListEntry' {}
- newTaskListEntry :: TaskListEntry
- taskListEntry_status :: Lens' TaskListEntry (Maybe TaskStatus)
- taskListEntry_taskArn :: Lens' TaskListEntry (Maybe Text)
- taskListEntry_name :: Lens' TaskListEntry (Maybe Text)
- data TaskSchedule = TaskSchedule' {}
- newTaskSchedule :: Text -> TaskSchedule
- taskSchedule_scheduleExpression :: Lens' TaskSchedule Text
Service Configuration
defaultService :: Service Source #
API version 2018-11-09 of the Amazon DataSync SDK configuration.
Errors
_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the client submits a malformed request.
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when an error occurs in the DataSync service.
AgentStatus
newtype AgentStatus Source #
Constructors
| AgentStatus' | |
Fields | |
Bundled Patterns
| pattern AgentStatus_OFFLINE :: AgentStatus | |
| pattern AgentStatus_ONLINE :: AgentStatus |
Instances
Atime
Bundled Patterns
| pattern Atime_BEST_EFFORT :: Atime | |
| pattern Atime_NONE :: Atime |
Instances
EndpointType
newtype EndpointType Source #
Constructors
| EndpointType' | |
Fields | |
Bundled Patterns
| pattern EndpointType_FIPS :: EndpointType | |
| pattern EndpointType_PRIVATE_LINK :: EndpointType | |
| pattern EndpointType_PUBLIC :: EndpointType |
Instances
FilterType
newtype FilterType Source #
Constructors
| FilterType' | |
Fields | |
Bundled Patterns
| pattern FilterType_SIMPLE_PATTERN :: FilterType |
Instances
Gid
Bundled Patterns
| pattern Gid_BOTH :: Gid | |
| pattern Gid_INT_VALUE :: Gid | |
| pattern Gid_NAME :: Gid | |
| pattern Gid_NONE :: Gid |
Instances
LocationFilterName
newtype LocationFilterName Source #
Constructors
| LocationFilterName' | |
Fields | |
Bundled Patterns
| pattern LocationFilterName_CreationTime :: LocationFilterName | |
| pattern LocationFilterName_LocationType :: LocationFilterName | |
| pattern LocationFilterName_LocationUri :: LocationFilterName |
Instances
LogLevel
Constructors
| LogLevel' | |
Fields
| |
Bundled Patterns
| pattern LogLevel_BASIC :: LogLevel | |
| pattern LogLevel_OFF :: LogLevel | |
| pattern LogLevel_TRANSFER :: LogLevel |
Instances
Mtime
Bundled Patterns
| pattern Mtime_NONE :: Mtime | |
| pattern Mtime_PRESERVE :: Mtime |
Instances
NfsVersion
newtype NfsVersion Source #
Constructors
| NfsVersion' | |
Fields | |
Bundled Patterns
| pattern NfsVersion_AUTOMATIC :: NfsVersion | |
| pattern NfsVersion_NFS3 :: NfsVersion | |
| pattern NfsVersion_NFS4_0 :: NfsVersion | |
| pattern NfsVersion_NFS4_1 :: NfsVersion |
Instances
ObjectStorageServerProtocol
newtype ObjectStorageServerProtocol Source #
Constructors
| ObjectStorageServerProtocol' | |
Fields | |
Bundled Patterns
| pattern ObjectStorageServerProtocol_HTTP :: ObjectStorageServerProtocol | |
| pattern ObjectStorageServerProtocol_HTTPS :: ObjectStorageServerProtocol |
Instances
Operator
Constructors
| Operator' | |
Fields
| |
Bundled Patterns
| pattern Operator_BeginsWith :: Operator | |
| pattern Operator_Contains :: Operator | |
| pattern Operator_Equals :: Operator | |
| pattern Operator_GreaterThan :: Operator | |
| pattern Operator_GreaterThanOrEqual :: Operator | |
| pattern Operator_In :: Operator | |
| pattern Operator_LessThan :: Operator | |
| pattern Operator_LessThanOrEqual :: Operator | |
| pattern Operator_NotContains :: Operator | |
| pattern Operator_NotEquals :: Operator |
Instances
OverwriteMode
newtype OverwriteMode Source #
Constructors
| OverwriteMode' | |
Fields | |
Bundled Patterns
| pattern OverwriteMode_ALWAYS :: OverwriteMode | |
| pattern OverwriteMode_NEVER :: OverwriteMode |
Instances
PhaseStatus
newtype PhaseStatus Source #
Constructors
| PhaseStatus' | |
Fields | |
Bundled Patterns
| pattern PhaseStatus_ERROR :: PhaseStatus | |
| pattern PhaseStatus_PENDING :: PhaseStatus | |
| pattern PhaseStatus_SUCCESS :: PhaseStatus |
Instances
PosixPermissions
newtype PosixPermissions Source #
Constructors
| PosixPermissions' | |
Fields | |
Bundled Patterns
| pattern PosixPermissions_NONE :: PosixPermissions | |
| pattern PosixPermissions_PRESERVE :: PosixPermissions |
Instances
PreserveDeletedFiles
newtype PreserveDeletedFiles Source #
Constructors
| PreserveDeletedFiles' | |
Fields | |
Bundled Patterns
| pattern PreserveDeletedFiles_PRESERVE :: PreserveDeletedFiles | |
| pattern PreserveDeletedFiles_REMOVE :: PreserveDeletedFiles |
Instances
PreserveDevices
newtype PreserveDevices Source #
Constructors
| PreserveDevices' | |
Fields | |
Bundled Patterns
| pattern PreserveDevices_NONE :: PreserveDevices | |
| pattern PreserveDevices_PRESERVE :: PreserveDevices |
Instances
S3StorageClass
newtype S3StorageClass Source #
Constructors
| S3StorageClass' | |
Fields | |
Bundled Patterns
| pattern S3StorageClass_DEEP_ARCHIVE :: S3StorageClass | |
| pattern S3StorageClass_GLACIER :: S3StorageClass | |
| pattern S3StorageClass_INTELLIGENT_TIERING :: S3StorageClass | |
| pattern S3StorageClass_ONEZONE_IA :: S3StorageClass | |
| pattern S3StorageClass_OUTPOSTS :: S3StorageClass | |
| pattern S3StorageClass_STANDARD :: S3StorageClass | |
| pattern S3StorageClass_STANDARD_IA :: S3StorageClass |
Instances
SmbSecurityDescriptorCopyFlags
newtype SmbSecurityDescriptorCopyFlags Source #
Constructors
| SmbSecurityDescriptorCopyFlags' | |
Fields | |
Bundled Patterns
Instances
SmbVersion
newtype SmbVersion Source #
Constructors
| SmbVersion' | |
Fields | |
Bundled Patterns
| pattern SmbVersion_AUTOMATIC :: SmbVersion | |
| pattern SmbVersion_SMB2 :: SmbVersion | |
| pattern SmbVersion_SMB3 :: SmbVersion |
Instances
TaskExecutionStatus
newtype TaskExecutionStatus Source #
Constructors
| TaskExecutionStatus' | |
Fields | |
Bundled Patterns
| pattern TaskExecutionStatus_ERROR :: TaskExecutionStatus | |
| pattern TaskExecutionStatus_LAUNCHING :: TaskExecutionStatus | |
| pattern TaskExecutionStatus_PREPARING :: TaskExecutionStatus | |
| pattern TaskExecutionStatus_QUEUED :: TaskExecutionStatus | |
| pattern TaskExecutionStatus_SUCCESS :: TaskExecutionStatus | |
| pattern TaskExecutionStatus_TRANSFERRING :: TaskExecutionStatus | |
| pattern TaskExecutionStatus_VERIFYING :: TaskExecutionStatus |
Instances
TaskFilterName
newtype TaskFilterName Source #
Constructors
| TaskFilterName' | |
Fields | |
Bundled Patterns
| pattern TaskFilterName_CreationTime :: TaskFilterName | |
| pattern TaskFilterName_LocationId :: TaskFilterName |
Instances
TaskQueueing
newtype TaskQueueing Source #
Constructors
| TaskQueueing' | |
Fields | |
Bundled Patterns
| pattern TaskQueueing_DISABLED :: TaskQueueing | |
| pattern TaskQueueing_ENABLED :: TaskQueueing |
Instances
TaskStatus
newtype TaskStatus Source #
Constructors
| TaskStatus' | |
Fields | |
Bundled Patterns
| pattern TaskStatus_AVAILABLE :: TaskStatus | |
| pattern TaskStatus_CREATING :: TaskStatus | |
| pattern TaskStatus_QUEUED :: TaskStatus | |
| pattern TaskStatus_RUNNING :: TaskStatus | |
| pattern TaskStatus_UNAVAILABLE :: TaskStatus |
Instances
TransferMode
newtype TransferMode Source #
Constructors
| TransferMode' | |
Fields | |
Bundled Patterns
| pattern TransferMode_ALL :: TransferMode | |
| pattern TransferMode_CHANGED :: TransferMode |
Instances
Uid
Bundled Patterns
| pattern Uid_BOTH :: Uid | |
| pattern Uid_INT_VALUE :: Uid | |
| pattern Uid_NAME :: Uid | |
| pattern Uid_NONE :: Uid |
Instances
VerifyMode
newtype VerifyMode Source #
Constructors
| VerifyMode' | |
Fields | |
Bundled Patterns
| pattern VerifyMode_NONE :: VerifyMode | |
| pattern VerifyMode_ONLY_FILES_TRANSFERRED :: VerifyMode | |
| pattern VerifyMode_POINT_IN_TIME_CONSISTENT :: VerifyMode |
Instances
AgentListEntry
data AgentListEntry Source #
Represents a single entry in a list of agents. AgentListEntry returns
an array that contains a list of agents when the
ListAgents
operation is called.
See: newAgentListEntry smart constructor.
Constructors
| AgentListEntry' | |
Instances
newAgentListEntry :: AgentListEntry Source #
Create a value of AgentListEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:AgentListEntry', agentListEntry_status - The status of the agent.
$sel:agentArn:AgentListEntry', agentListEntry_agentArn - The Amazon Resource Name (ARN) of the agent.
$sel:name:AgentListEntry', agentListEntry_name - The name of the agent.
agentListEntry_status :: Lens' AgentListEntry (Maybe AgentStatus) Source #
The status of the agent.
agentListEntry_agentArn :: Lens' AgentListEntry (Maybe Text) Source #
The Amazon Resource Name (ARN) of the agent.
agentListEntry_name :: Lens' AgentListEntry (Maybe Text) Source #
The name of the agent.
Ec2Config
The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.
See: newEc2Config smart constructor.
Constructors
| Ec2Config' | |
Fields
| |
Instances
| Eq Ec2Config Source # | |
| Read Ec2Config Source # | |
| Show Ec2Config Source # | |
| Generic Ec2Config Source # | |
| NFData Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
| Hashable Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
| ToJSON Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config | |
| FromJSON Ec2Config Source # | |
| type Rep Ec2Config Source # | |
Defined in Amazonka.DataSync.Types.Ec2Config type Rep Ec2Config = D1 ('MetaData "Ec2Config" "Amazonka.DataSync.Types.Ec2Config" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "Ec2Config'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "securityGroupArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) | |
Create a value of Ec2Config with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subnetArn:Ec2Config', ec2Config_subnetArn - The ARN of the subnet and the security group that DataSync uses to
access the target EFS file system.
$sel:securityGroupArns:Ec2Config', ec2Config_securityGroupArns - The Amazon Resource Names (ARNs) of the security groups that are
configured for the Amazon EC2 resource.
ec2Config_subnetArn :: Lens' Ec2Config Text Source #
The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.
ec2Config_securityGroupArns :: Lens' Ec2Config (NonEmpty Text) Source #
The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.
FilterRule
data FilterRule Source #
Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
See: newFilterRule smart constructor.
Constructors
| FilterRule' | |
Fields
| |
Instances
newFilterRule :: FilterRule Source #
Create a value of FilterRule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filterType:FilterRule', filterRule_filterType - The type of filter rule to apply. DataSync only supports the
SIMPLE_PATTERN rule type.
$sel:value:FilterRule', filterRule_value - 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
filterRule_filterType :: Lens' FilterRule (Maybe FilterType) Source #
The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.
filterRule_value :: Lens' FilterRule (Maybe Text) Source #
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
LocationFilter
data LocationFilter Source #
You can use API filters to narrow down the list of resources returned by
ListLocations. For example, to retrieve all your Amazon S3 locations,
you can use ListLocations with filter name LocationType S3 and
Operator Equals.
See: newLocationFilter smart constructor.
Constructors
| LocationFilter' | |
Fields
| |
Instances
Arguments
| :: LocationFilterName | |
| -> Operator | |
| -> LocationFilter |
Create a value of LocationFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:LocationFilter', locationFilter_name - 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).
$sel:values:LocationFilter', locationFilter_values - The values that you want to filter for. For example, you might want to
display only Amazon S3 locations.
$sel:operator:LocationFilter', locationFilter_operator - The operator that is used to compare filter values (for example,
Equals or Contains). For more about API filtering operators, see
API filters for ListTasks and ListLocations.
locationFilter_name :: Lens' LocationFilter LocationFilterName Source #
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).
locationFilter_values :: Lens' LocationFilter [Text] Source #
The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
locationFilter_operator :: Lens' LocationFilter Operator Source #
The operator that is used to compare filter values (for example,
Equals or Contains). For more about API filtering operators, see
API filters for ListTasks and ListLocations.
LocationListEntry
data LocationListEntry Source #
Represents a single entry in a list of locations. LocationListEntry
returns an array that contains a list of locations when the
ListLocations
operation is called.
See: newLocationListEntry smart constructor.
Constructors
| LocationListEntry' | |
Fields
| |
Instances
newLocationListEntry :: LocationListEntry Source #
Create a value of LocationListEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locationUri:LocationListEntry', locationListEntry_locationUri - Represents a list of URLs of a location. LocationUri returns an array
that contains a list of locations when the
ListLocations
operation is called.
Format: TYPE://GLOBAL_ID/SUBDIR.
TYPE designates the type of location. Valid values: NFS | EFS | 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 host name 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.
$sel:locationArn:LocationListEntry', locationListEntry_locationArn - 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.
locationListEntry_locationUri :: Lens' LocationListEntry (Maybe Text) Source #
Represents a list of URLs of a location. LocationUri returns an array
that contains a list of locations when the
ListLocations
operation is called.
Format: TYPE://GLOBAL_ID/SUBDIR.
TYPE designates the type of location. Valid values: NFS | EFS | 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 host name 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.
locationListEntry_locationArn :: Lens' LocationListEntry (Maybe Text) Source #
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.
NfsMountOptions
data NfsMountOptions Source #
Represents the mount options that are available for DataSync to access an NFS location.
See: newNfsMountOptions smart constructor.
Constructors
| NfsMountOptions' | |
Fields
| |
Instances
newNfsMountOptions :: NfsMountOptions Source #
Create a value of NfsMountOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:version:NfsMountOptions', nfsMountOptions_version - The specific NFS version that you want DataSync to use to mount your NFS
share. If the server refuses to use the version specified, the sync will
fail. If you don't specify a version, DataSync defaults to AUTOMATIC.
That is, DataSync automatically selects a version based on negotiation
with the NFS server.
You can specify the following NFS versions:
- NFSv3 - stateless protocol version that allows for asynchronous writes on the server.
- NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.
- NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.
nfsMountOptions_version :: Lens' NfsMountOptions (Maybe NfsVersion) Source #
The specific NFS version that you want DataSync to use to mount your NFS
share. If the server refuses to use the version specified, the sync will
fail. If you don't specify a version, DataSync defaults to AUTOMATIC.
That is, DataSync automatically selects a version based on negotiation
with the NFS server.
You can specify the following NFS versions:
- NFSv3 - stateless protocol version that allows for asynchronous writes on the server.
- NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.
- NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.
OnPremConfig
data OnPremConfig Source #
A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
See: newOnPremConfig smart constructor.
Constructors
| OnPremConfig' | |
Instances
Arguments
| :: NonEmpty Text | |
| -> OnPremConfig |
Create a value of OnPremConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentArns:OnPremConfig', onPremConfig_agentArns - ARNs of the agents to use for an NFS location.
onPremConfig_agentArns :: Lens' OnPremConfig (NonEmpty Text) Source #
ARNs of the agents to use for an NFS location.
Options
Represents the options that are available to control the behavior of a StartTaskExecution 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,
the default value is used. You can override the defaults options on each
task execution by specifying an overriding Options value to
StartTaskExecution.
See: newOptions smart constructor.
Constructors
| Options' | |
Fields
| |
Instances
newOptions :: Options Source #
Create a value of Options with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:atime:Options', options_atime - 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_EFFORT.
BEST_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.
$sel:verifyMode:Options', options_verifyMode - 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.
Default value: POINT_IN_TIME_CONSISTENT.
ONLY_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 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.
$sel:taskQueueing:Options', options_taskQueueing - 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.
$sel:logLevel:Options', options_logLevel - 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.
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.
$sel:posixPermissions:Options', options_posixPermissions - 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.
This option should only be set for NFS, EFS, and S3 locations. For more
information about what metadata is copied by DataSync, see
Metadata Copied by DataSync.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
DataSync can preserve extant permissions of a source location.
$sel:mtime:Options', options_mtime - 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: PRESERVE.
PRESERVE: 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.
$sel:uid:Options', options_uid - The POSIX user ID (UID) of the file's owner. This option should only be
set for NFS, EFS, and S3 locations. To learn more about what metadata is
copied by DataSync, see
Metadata Copied by DataSync.
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.
$sel:bytesPerSecond:Options', options_bytesPerSecond - 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).
$sel:securityDescriptorCopyFlags:Options', options_securityDescriptorCopyFlags - 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.
Default value: OWNER_DACL.
OWNER_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.
$sel:gid:Options', options_gid - The POSIX group ID (GID) of the file's owners. This option should only
be set for NFS, EFS, and S3 locations. For more information about what
metadata is copied by DataSync, see
Metadata Copied by DataSync.
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.
$sel:overwriteMode:Options', options_overwriteMode - 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 in the DataSync User Guide.
$sel:transferMode:Options', options_transferMode - 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.
$sel:preserveDeletedFiles:Options', options_preserveDeletedFiles - 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
in the DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
$sel:preserveDevices:Options', options_preserveDevices - 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: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
options_atime :: Lens' Options (Maybe Atime) Source #
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_EFFORT.
BEST_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.
options_verifyMode :: Lens' Options (Maybe VerifyMode) Source #
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.
Default value: POINT_IN_TIME_CONSISTENT.
ONLY_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 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.
options_taskQueueing :: Lens' Options (Maybe TaskQueueing) Source #
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.
options_logLevel :: Lens' Options (Maybe LogLevel) Source #
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.
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.
options_posixPermissions :: Lens' Options (Maybe PosixPermissions) Source #
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. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
Default value: PRESERVE.
PRESERVE: Preserve POSIX-style permissions (recommended).
NONE: Ignore permissions.
DataSync can preserve extant permissions of a source location.
options_mtime :: Lens' Options (Maybe Mtime) Source #
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: PRESERVE.
PRESERVE: 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.
options_uid :: Lens' Options (Maybe Uid) Source #
The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.
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.
options_bytesPerSecond :: Lens' Options (Maybe Integer) Source #
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).
options_securityDescriptorCopyFlags :: Lens' Options (Maybe SmbSecurityDescriptorCopyFlags) Source #
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.
Default value: OWNER_DACL.
OWNER_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.
options_gid :: Lens' Options (Maybe Gid) Source #
The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.
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.
options_overwriteMode :: Lens' Options (Maybe OverwriteMode) Source #
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 in the DataSync User Guide.
options_transferMode :: Lens' Options (Maybe TransferMode) Source #
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.
options_preserveDeletedFiles :: Lens' Options (Maybe PreserveDeletedFiles) Source #
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 in the DataSync User Guide.
Default value: PRESERVE.
PRESERVE: Ignore such destination files (recommended).
REMOVE: Delete destination files that aren’t present in the source.
options_preserveDevices :: Lens' Options (Maybe PreserveDevices) Source #
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: NONE.
NONE: Ignore special devices (recommended).
PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
PrivateLinkConfig
data PrivateLinkConfig Source #
The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).
See: newPrivateLinkConfig smart constructor.
Constructors
| PrivateLinkConfig' | |
Fields
| |
Instances
newPrivateLinkConfig :: PrivateLinkConfig Source #
Create a value of PrivateLinkConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupArns:PrivateLinkConfig', privateLinkConfig_securityGroupArns - 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.
$sel:subnetArns:PrivateLinkConfig', privateLinkConfig_subnetArns - 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.
$sel:privateLinkEndpoint:PrivateLinkConfig', privateLinkConfig_privateLinkEndpoint - The private endpoint that is configured for an agent that has access to
IP addresses in a
PrivateLink.
An agent that is configured with this endpoint will not be accessible
over the public internet.
$sel:vpcEndpointId:PrivateLinkConfig', privateLinkConfig_vpcEndpointId - 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.
privateLinkConfig_securityGroupArns :: Lens' PrivateLinkConfig (Maybe (NonEmpty Text)) Source #
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.
privateLinkConfig_subnetArns :: Lens' PrivateLinkConfig (Maybe (NonEmpty Text)) Source #
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.
privateLinkConfig_privateLinkEndpoint :: Lens' PrivateLinkConfig (Maybe Text) Source #
The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is configured with this endpoint will not be accessible over the public internet.
privateLinkConfig_vpcEndpointId :: Lens' PrivateLinkConfig (Maybe Text) Source #
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.
S3Config
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that is 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.
See: newS3Config smart constructor.
Constructors
| S3Config' | |
Fields
| |
Instances
| Eq S3Config Source # | |
| Read S3Config Source # | |
| Show S3Config Source # | |
| Generic S3Config Source # | |
| NFData S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
| Hashable S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
| ToJSON S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config | |
| FromJSON S3Config Source # | |
| type Rep S3Config Source # | |
Defined in Amazonka.DataSync.Types.S3Config type Rep S3Config = D1 ('MetaData "S3Config" "Amazonka.DataSync.Types.S3Config" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "S3Config'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucketAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of S3Config with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucketAccessRoleArn:S3Config', s3Config_bucketAccessRoleArn - The Amazon S3 bucket to access. This bucket is used as a parameter in
the
CreateLocationS3
operation.
s3Config_bucketAccessRoleArn :: Lens' S3Config Text Source #
The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.
SmbMountOptions
data SmbMountOptions Source #
Represents the mount options that are available for DataSync to access an SMB location.
See: newSmbMountOptions smart constructor.
Constructors
| SmbMountOptions' | |
Fields
| |
Instances
newSmbMountOptions :: SmbMountOptions Source #
Create a value of SmbMountOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:version:SmbMountOptions', smbMountOptions_version - The specific SMB version that you want DataSync to use to mount your SMB
share. If you don't specify a version, DataSync defaults to
AUTOMATIC. That is, DataSync automatically selects a version based on
negotiation with the SMB server.
smbMountOptions_version :: Lens' SmbMountOptions (Maybe SmbVersion) Source #
The specific SMB version that you want DataSync to use to mount your SMB
share. If you don't specify a version, DataSync defaults to
AUTOMATIC. That is, DataSync automatically selects a version based on
negotiation with the SMB server.
TagListEntry
data TagListEntry Source #
Represents a single entry in a list of AWS resource tags. TagListEntry
returns an array that contains a list of tasks when the
ListTagsForResource
operation is called.
See: newTagListEntry smart constructor.
Constructors
| TagListEntry' | |
Instances
Arguments
| :: Text | |
| -> TagListEntry |
Create a value of TagListEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:TagListEntry', tagListEntry_value - The value for an Amazon Web Services resource tag.
$sel:key:TagListEntry', tagListEntry_key - The key for an Amazon Web Services resource tag.
tagListEntry_value :: Lens' TagListEntry (Maybe Text) Source #
The value for an Amazon Web Services resource tag.
tagListEntry_key :: Lens' TagListEntry Text Source #
The key for an Amazon Web Services resource tag.
TaskExecutionListEntry
data TaskExecutionListEntry Source #
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
operation is called.
See: newTaskExecutionListEntry smart constructor.
Constructors
| TaskExecutionListEntry' | |
Fields
| |
Instances
newTaskExecutionListEntry :: TaskExecutionListEntry Source #
Create a value of TaskExecutionListEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:TaskExecutionListEntry', taskExecutionListEntry_status - The status of a task execution.
$sel:taskExecutionArn:TaskExecutionListEntry', taskExecutionListEntry_taskExecutionArn - The Amazon Resource Name (ARN) of the task that was executed.
taskExecutionListEntry_status :: Lens' TaskExecutionListEntry (Maybe TaskExecutionStatus) Source #
The status of a task execution.
taskExecutionListEntry_taskExecutionArn :: Lens' TaskExecutionListEntry (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task that was executed.
TaskExecutionResultDetail
data TaskExecutionResultDetail Source #
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.
See: newTaskExecutionResultDetail smart constructor.
Constructors
| TaskExecutionResultDetail' | |
Fields
| |
Instances
newTaskExecutionResultDetail :: TaskExecutionResultDetail Source #
Create a value of TaskExecutionResultDetail with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prepareDuration:TaskExecutionResultDetail', taskExecutionResultDetail_prepareDuration - The total time in milliseconds that DataSync spent in the PREPARING
phase.
$sel:prepareStatus:TaskExecutionResultDetail', taskExecutionResultDetail_prepareStatus - The status of the PREPARING phase.
$sel:verifyStatus:TaskExecutionResultDetail', taskExecutionResultDetail_verifyStatus - The status of the VERIFYING phase.
$sel:verifyDuration:TaskExecutionResultDetail', taskExecutionResultDetail_verifyDuration - The total time in milliseconds that DataSync spent in the VERIFYING
phase.
$sel:totalDuration:TaskExecutionResultDetail', taskExecutionResultDetail_totalDuration - The total time in milliseconds that DataSync took to transfer the file
from the source to the destination location.
$sel:transferStatus:TaskExecutionResultDetail', taskExecutionResultDetail_transferStatus - The status of the TRANSFERRING phase.
$sel:errorCode:TaskExecutionResultDetail', taskExecutionResultDetail_errorCode - Errors that DataSync encountered during execution of the task. You can
use this error code to help troubleshoot issues.
$sel:transferDuration:TaskExecutionResultDetail', taskExecutionResultDetail_transferDuration - The total time in milliseconds that DataSync spent in the TRANSFERRING
phase.
$sel:errorDetail:TaskExecutionResultDetail', taskExecutionResultDetail_errorDetail - Detailed description of an error that was encountered during the task
execution. You can use this information to help troubleshoot issues.
taskExecutionResultDetail_prepareDuration :: Lens' TaskExecutionResultDetail (Maybe Natural) Source #
The total time in milliseconds that DataSync spent in the PREPARING phase.
taskExecutionResultDetail_prepareStatus :: Lens' TaskExecutionResultDetail (Maybe PhaseStatus) Source #
The status of the PREPARING phase.
taskExecutionResultDetail_verifyStatus :: Lens' TaskExecutionResultDetail (Maybe PhaseStatus) Source #
The status of the VERIFYING phase.
taskExecutionResultDetail_verifyDuration :: Lens' TaskExecutionResultDetail (Maybe Natural) Source #
The total time in milliseconds that DataSync spent in the VERIFYING phase.
taskExecutionResultDetail_totalDuration :: Lens' TaskExecutionResultDetail (Maybe Natural) Source #
The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.
taskExecutionResultDetail_transferStatus :: Lens' TaskExecutionResultDetail (Maybe PhaseStatus) Source #
The status of the TRANSFERRING phase.
taskExecutionResultDetail_errorCode :: Lens' TaskExecutionResultDetail (Maybe Text) Source #
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
taskExecutionResultDetail_transferDuration :: Lens' TaskExecutionResultDetail (Maybe Natural) Source #
The total time in milliseconds that DataSync spent in the TRANSFERRING phase.
taskExecutionResultDetail_errorDetail :: Lens' TaskExecutionResultDetail (Maybe Text) Source #
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
TaskFilter
data TaskFilter Source #
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.
See: newTaskFilter smart constructor.
Constructors
| TaskFilter' | |
Fields
| |
Instances
Create a value of TaskFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TaskFilter', taskFilter_name - 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.
$sel:values:TaskFilter', taskFilter_values - The values that you want to filter for. For example, you might want to
display only tasks for a specific destination location.
$sel:operator:TaskFilter', taskFilter_operator - The operator that is used to compare filter values (for example,
Equals or Contains). For more about API filtering operators, see
API filters for ListTasks and ListLocations.
taskFilter_name :: Lens' TaskFilter TaskFilterName Source #
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.
taskFilter_values :: Lens' TaskFilter [Text] Source #
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
taskFilter_operator :: Lens' TaskFilter Operator Source #
The operator that is used to compare filter values (for example,
Equals or Contains). For more about API filtering operators, see
API filters for ListTasks and ListLocations.
TaskListEntry
data TaskListEntry Source #
Represents a single entry in a list of tasks. TaskListEntry returns an
array that contains a list of tasks when the
ListTasks
operation is called. A task includes the source and destination file
systems to sync and the options to use for the tasks.
See: newTaskListEntry smart constructor.
Constructors
| TaskListEntry' | |
Instances
newTaskListEntry :: TaskListEntry Source #
Create a value of TaskListEntry with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:TaskListEntry', taskListEntry_status - The status of the task.
$sel:taskArn:TaskListEntry', taskListEntry_taskArn - The Amazon Resource Name (ARN) of the task.
$sel:name:TaskListEntry', taskListEntry_name - The name of the task.
taskListEntry_status :: Lens' TaskListEntry (Maybe TaskStatus) Source #
The status of the task.
taskListEntry_taskArn :: Lens' TaskListEntry (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task.
taskListEntry_name :: Lens' TaskListEntry (Maybe Text) Source #
The name of the task.
TaskSchedule
data TaskSchedule Source #
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
See: newTaskSchedule smart constructor.
Constructors
| TaskSchedule' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> TaskSchedule |
Create a value of TaskSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduleExpression:TaskSchedule', taskSchedule_scheduleExpression - A cron expression that specifies when DataSync initiates a scheduled
transfer from a source to a destination location.
taskSchedule_scheduleExpression :: Lens' TaskSchedule Text Source #
A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location.