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.DMS
Contents
- Service Configuration
- Errors
- KMSAccessDeniedFault
- KMSDisabledFault
- KMSFault
- InvalidSubnet
- KMSKeyNotAccessibleFault
- ReplicationSubnetGroupDoesNotCoverEnoughAZs
- S3ResourceNotFoundFault
- InvalidResourceStateFault
- InvalidCertificateFault
- SNSNoAuthorizationFault
- ResourceAlreadyExistsFault
- InsufficientResourceCapacityFault
- S3AccessDeniedFault
- SNSInvalidTopicFault
- KMSNotFoundFault
- KMSThrottlingFault
- ResourceQuotaExceededFault
- UpgradeDependencyFailureFault
- ResourceNotFoundFault
- StorageQuotaExceededFault
- AccessDeniedFault
- SubnetAlreadyInUse
- KMSInvalidStateFault
- Waiters
- Operations
- DeleteReplicationInstance
- RebootReplicationInstance
- ReloadTables
- StartReplicationTaskAssessment
- DeleteReplicationTaskAssessmentRun
- CreateEndpoint
- DescribeSchemas (Paginated)
- DeleteConnection
- ModifyEventSubscription
- DescribeReplicationInstanceTaskLogs
- DescribeEvents (Paginated)
- DeleteEndpoint
- ListTagsForResource
- DescribeEndpointTypes (Paginated)
- DeleteReplicationTask
- DescribeReplicationTaskAssessmentRuns
- DescribeReplicationTaskAssessmentResults (Paginated)
- TestConnection
- DescribeConnections (Paginated)
- MoveReplicationTask
- RemoveTagsFromResource
- ModifyEndpoint
- CreateEventSubscription
- DescribeEndpointSettings
- DescribeCertificates (Paginated)
- StartReplicationTaskAssessmentRun
- DeleteEventSubscription
- DescribeTableStatistics (Paginated)
- DescribeReplicationSubnetGroups (Paginated)
- StartReplicationTask
- DescribeEventSubscriptions (Paginated)
- AddTagsToResource
- CreateReplicationSubnetGroup
- DescribeApplicableIndividualAssessments
- DeleteCertificate
- RefreshSchemas
- DescribeReplicationTasks (Paginated)
- DescribeEventCategories
- DescribeOrderableReplicationInstances (Paginated)
- DescribePendingMaintenanceActions
- CreateReplicationTask
- DescribeEndpoints (Paginated)
- ModifyReplicationInstance
- ImportCertificate
- CancelReplicationTaskAssessmentRun
- ModifyReplicationSubnetGroup
- DescribeReplicationTaskIndividualAssessments
- ApplyPendingMaintenanceAction
- DescribeAccountAttributes
- DescribeReplicationInstances (Paginated)
- DescribeRefreshSchemasStatus
- StopReplicationTask
- ModifyReplicationTask
- CreateReplicationInstance
- DeleteReplicationSubnetGroup
- Types
- AuthMechanismValue
- AuthTypeValue
- CannedAclForObjectsValue
- CharLengthSemantics
- CompressionTypeValue
- DataFormatValue
- DatePartitionDelimiterValue
- DatePartitionSequenceValue
- DmsSslModeValue
- EncodingTypeValue
- EncryptionModeValue
- EndpointSettingTypeValue
- KafkaSecurityProtocol
- MessageFormatValue
- MigrationTypeValue
- NestingLevelValue
- ParquetVersionValue
- PluginNameValue
- RedisAuthTypeValue
- RefreshSchemasStatusTypeValue
- ReleaseStatusValues
- ReloadOptionValue
- ReplicationEndpointTypeValue
- SafeguardPolicy
- SourceType
- SslSecurityProtocolValue
- StartReplicationTaskTypeValue
- TargetDbType
- AccountQuota
- AvailabilityZone
- Certificate
- Connection
- DmsTransferSettings
- DocDbSettings
- DynamoDbSettings
- ElasticsearchSettings
- Endpoint
- EndpointSetting
- Event
- EventCategoryGroup
- EventSubscription
- Filter
- IBMDb2Settings
- KafkaSettings
- KinesisSettings
- MicrosoftSQLServerSettings
- MongoDbSettings
- MySQLSettings
- NeptuneSettings
- OracleSettings
- OrderableReplicationInstance
- PendingMaintenanceAction
- PostgreSQLSettings
- RedisSettings
- RedshiftSettings
- RefreshSchemasStatus
- ReplicationInstance
- ReplicationInstanceTaskLog
- ReplicationPendingModifiedValues
- ReplicationSubnetGroup
- ReplicationTask
- ReplicationTaskAssessmentResult
- ReplicationTaskAssessmentRun
- ReplicationTaskAssessmentRunProgress
- ReplicationTaskIndividualAssessment
- ReplicationTaskStats
- ResourcePendingMaintenanceActions
- S3Settings
- Subnet
- SupportedEndpointType
- SybaseSettings
- TableStatistics
- TableToReload
- Tag
- VpcSecurityGroupMembership
Description
Derived from API version 2016-01-01
of the AWS service descriptions, licensed under Apache 2.0.
Database Migration Service
Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.
For more information about DMS, see What Is Database Migration Service? in the Database Migration Service User Guide.
Synopsis
- defaultService :: Service
- _KMSAccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSDisabledFault :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicationSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError
- _S3ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidResourceStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCertificateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientResourceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _S3AccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSThrottlingFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _UpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSInvalidStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- newReplicationInstanceAvailable :: Wait DescribeReplicationInstances
- newReplicationTaskDeleted :: Wait DescribeReplicationTasks
- newReplicationTaskReady :: Wait DescribeReplicationTasks
- newReplicationInstanceDeleted :: Wait DescribeReplicationInstances
- newEndpointDeleted :: Wait DescribeEndpoints
- newReplicationTaskStopped :: Wait DescribeReplicationTasks
- newReplicationTaskRunning :: Wait DescribeReplicationTasks
- newTestConnectionSucceeds :: Wait DescribeConnections
- data DeleteReplicationInstance = DeleteReplicationInstance' Text
- newDeleteReplicationInstance :: Text -> DeleteReplicationInstance
- data DeleteReplicationInstanceResponse = DeleteReplicationInstanceResponse' (Maybe ReplicationInstance) Int
- newDeleteReplicationInstanceResponse :: Int -> DeleteReplicationInstanceResponse
- data RebootReplicationInstance = RebootReplicationInstance' (Maybe Bool) (Maybe Bool) Text
- newRebootReplicationInstance :: Text -> RebootReplicationInstance
- data RebootReplicationInstanceResponse = RebootReplicationInstanceResponse' (Maybe ReplicationInstance) Int
- newRebootReplicationInstanceResponse :: Int -> RebootReplicationInstanceResponse
- data ReloadTables = ReloadTables' (Maybe ReloadOptionValue) Text [TableToReload]
- newReloadTables :: Text -> ReloadTables
- data ReloadTablesResponse = ReloadTablesResponse' (Maybe Text) Int
- newReloadTablesResponse :: Int -> ReloadTablesResponse
- data StartReplicationTaskAssessment = StartReplicationTaskAssessment' Text
- newStartReplicationTaskAssessment :: Text -> StartReplicationTaskAssessment
- data StartReplicationTaskAssessmentResponse = StartReplicationTaskAssessmentResponse' (Maybe ReplicationTask) Int
- newStartReplicationTaskAssessmentResponse :: Int -> StartReplicationTaskAssessmentResponse
- data DeleteReplicationTaskAssessmentRun = DeleteReplicationTaskAssessmentRun' Text
- newDeleteReplicationTaskAssessmentRun :: Text -> DeleteReplicationTaskAssessmentRun
- data DeleteReplicationTaskAssessmentRunResponse = DeleteReplicationTaskAssessmentRunResponse' (Maybe ReplicationTaskAssessmentRun) Int
- newDeleteReplicationTaskAssessmentRunResponse :: Int -> DeleteReplicationTaskAssessmentRunResponse
- data CreateEndpoint = CreateEndpoint' (Maybe DmsTransferSettings) (Maybe MySQLSettings) (Maybe Text) (Maybe MicrosoftSQLServerSettings) (Maybe Text) (Maybe Text) (Maybe DocDbSettings) (Maybe PostgreSQLSettings) (Maybe Text) (Maybe KafkaSettings) (Maybe OracleSettings) (Maybe RedshiftSettings) (Maybe ElasticsearchSettings) (Maybe Text) (Maybe Text) (Maybe RedisSettings) (Maybe NeptuneSettings) (Maybe IBMDb2Settings) (Maybe Text) (Maybe MongoDbSettings) (Maybe DmsSslModeValue) (Maybe (Sensitive Text)) (Maybe SybaseSettings) (Maybe Text) (Maybe S3Settings) (Maybe KinesisSettings) (Maybe DynamoDbSettings) (Maybe Text) (Maybe [Tag]) (Maybe Int) Text ReplicationEndpointTypeValue Text
- newCreateEndpoint :: Text -> ReplicationEndpointTypeValue -> Text -> CreateEndpoint
- data CreateEndpointResponse = CreateEndpointResponse' (Maybe Endpoint) Int
- newCreateEndpointResponse :: Int -> CreateEndpointResponse
- data DescribeSchemas = DescribeSchemas' (Maybe Text) (Maybe Int) Text
- newDescribeSchemas :: Text -> DescribeSchemas
- data DescribeSchemasResponse = DescribeSchemasResponse' (Maybe [Text]) (Maybe Text) Int
- newDescribeSchemasResponse :: Int -> DescribeSchemasResponse
- data DeleteConnection = DeleteConnection' Text Text
- newDeleteConnection :: Text -> Text -> DeleteConnection
- data DeleteConnectionResponse = DeleteConnectionResponse' (Maybe Connection) Int
- newDeleteConnectionResponse :: Int -> DeleteConnectionResponse
- data ModifyEventSubscription = ModifyEventSubscription' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) Text
- newModifyEventSubscription :: Text -> ModifyEventSubscription
- data ModifyEventSubscriptionResponse = ModifyEventSubscriptionResponse' (Maybe EventSubscription) Int
- newModifyEventSubscriptionResponse :: Int -> ModifyEventSubscriptionResponse
- data DescribeReplicationInstanceTaskLogs = DescribeReplicationInstanceTaskLogs' (Maybe Text) (Maybe Int) Text
- newDescribeReplicationInstanceTaskLogs :: Text -> DescribeReplicationInstanceTaskLogs
- data DescribeReplicationInstanceTaskLogsResponse = DescribeReplicationInstanceTaskLogsResponse' (Maybe [ReplicationInstanceTaskLog]) (Maybe Text) (Maybe Text) Int
- newDescribeReplicationInstanceTaskLogsResponse :: Int -> DescribeReplicationInstanceTaskLogsResponse
- data DescribeEvents = DescribeEvents' (Maybe POSIX) (Maybe SourceType) (Maybe [Filter]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe POSIX) (Maybe Int)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DeleteEndpoint = DeleteEndpoint' Text
- newDeleteEndpoint :: Text -> DeleteEndpoint
- data DeleteEndpointResponse = DeleteEndpointResponse' (Maybe Endpoint) Int
- newDeleteEndpointResponse :: Int -> DeleteEndpointResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Text) (Maybe [Text])
- newListTagsForResource :: ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DescribeEndpointTypes = DescribeEndpointTypes' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeEndpointTypes :: DescribeEndpointTypes
- data DescribeEndpointTypesResponse = DescribeEndpointTypesResponse' (Maybe [SupportedEndpointType]) (Maybe Text) Int
- newDescribeEndpointTypesResponse :: Int -> DescribeEndpointTypesResponse
- data DeleteReplicationTask = DeleteReplicationTask' Text
- newDeleteReplicationTask :: Text -> DeleteReplicationTask
- data DeleteReplicationTaskResponse = DeleteReplicationTaskResponse' (Maybe ReplicationTask) Int
- newDeleteReplicationTaskResponse :: Int -> DeleteReplicationTaskResponse
- data DescribeReplicationTaskAssessmentRuns = DescribeReplicationTaskAssessmentRuns' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeReplicationTaskAssessmentRuns :: DescribeReplicationTaskAssessmentRuns
- data DescribeReplicationTaskAssessmentRunsResponse = DescribeReplicationTaskAssessmentRunsResponse' (Maybe [ReplicationTaskAssessmentRun]) (Maybe Text) Int
- newDescribeReplicationTaskAssessmentRunsResponse :: Int -> DescribeReplicationTaskAssessmentRunsResponse
- data DescribeReplicationTaskAssessmentResults = DescribeReplicationTaskAssessmentResults' (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeReplicationTaskAssessmentResults :: DescribeReplicationTaskAssessmentResults
- data DescribeReplicationTaskAssessmentResultsResponse = DescribeReplicationTaskAssessmentResultsResponse' (Maybe Text) (Maybe Text) (Maybe [ReplicationTaskAssessmentResult]) Int
- newDescribeReplicationTaskAssessmentResultsResponse :: Int -> DescribeReplicationTaskAssessmentResultsResponse
- data TestConnection = TestConnection' Text Text
- newTestConnection :: Text -> Text -> TestConnection
- data TestConnectionResponse = TestConnectionResponse' (Maybe Connection) Int
- newTestConnectionResponse :: Int -> TestConnectionResponse
- data DescribeConnections = DescribeConnections' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeConnections :: DescribeConnections
- data DescribeConnectionsResponse = DescribeConnectionsResponse' (Maybe [Connection]) (Maybe Text) Int
- newDescribeConnectionsResponse :: Int -> DescribeConnectionsResponse
- data MoveReplicationTask = MoveReplicationTask' Text Text
- newMoveReplicationTask :: Text -> Text -> MoveReplicationTask
- data MoveReplicationTaskResponse = MoveReplicationTaskResponse' (Maybe ReplicationTask) Int
- newMoveReplicationTaskResponse :: Int -> MoveReplicationTaskResponse
- data RemoveTagsFromResource = RemoveTagsFromResource' Text [Text]
- newRemoveTagsFromResource :: Text -> RemoveTagsFromResource
- data RemoveTagsFromResourceResponse = RemoveTagsFromResourceResponse' Int
- newRemoveTagsFromResourceResponse :: Int -> RemoveTagsFromResourceResponse
- data ModifyEndpoint = ModifyEndpoint' (Maybe DmsTransferSettings) (Maybe MySQLSettings) (Maybe Text) (Maybe MicrosoftSQLServerSettings) (Maybe Text) (Maybe Text) (Maybe DocDbSettings) (Maybe PostgreSQLSettings) (Maybe Text) (Maybe KafkaSettings) (Maybe OracleSettings) (Maybe ReplicationEndpointTypeValue) (Maybe RedshiftSettings) (Maybe ElasticsearchSettings) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RedisSettings) (Maybe NeptuneSettings) (Maybe IBMDb2Settings) (Maybe MongoDbSettings) (Maybe DmsSslModeValue) (Maybe (Sensitive Text)) (Maybe SybaseSettings) (Maybe Text) (Maybe S3Settings) (Maybe KinesisSettings) (Maybe Text) (Maybe DynamoDbSettings) (Maybe Int) Text
- newModifyEndpoint :: Text -> ModifyEndpoint
- data ModifyEndpointResponse = ModifyEndpointResponse' (Maybe Endpoint) Int
- newModifyEndpointResponse :: Int -> ModifyEndpointResponse
- data CreateEventSubscription = CreateEventSubscription' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text
- newCreateEventSubscription :: Text -> Text -> CreateEventSubscription
- data CreateEventSubscriptionResponse = CreateEventSubscriptionResponse' (Maybe EventSubscription) Int
- newCreateEventSubscriptionResponse :: Int -> CreateEventSubscriptionResponse
- data DescribeEndpointSettings = DescribeEndpointSettings' (Maybe Text) (Maybe Int) Text
- newDescribeEndpointSettings :: Text -> DescribeEndpointSettings
- data DescribeEndpointSettingsResponse = DescribeEndpointSettingsResponse' (Maybe [EndpointSetting]) (Maybe Text) Int
- newDescribeEndpointSettingsResponse :: Int -> DescribeEndpointSettingsResponse
- data DescribeCertificates = DescribeCertificates' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeCertificates :: DescribeCertificates
- data DescribeCertificatesResponse = DescribeCertificatesResponse' (Maybe [Certificate]) (Maybe Text) Int
- newDescribeCertificatesResponse :: Int -> DescribeCertificatesResponse
- data StartReplicationTaskAssessmentRun = StartReplicationTaskAssessmentRun' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Text Text Text Text
- newStartReplicationTaskAssessmentRun :: Text -> Text -> Text -> Text -> StartReplicationTaskAssessmentRun
- data StartReplicationTaskAssessmentRunResponse = StartReplicationTaskAssessmentRunResponse' (Maybe ReplicationTaskAssessmentRun) Int
- newStartReplicationTaskAssessmentRunResponse :: Int -> StartReplicationTaskAssessmentRunResponse
- data DeleteEventSubscription = DeleteEventSubscription' Text
- newDeleteEventSubscription :: Text -> DeleteEventSubscription
- data DeleteEventSubscriptionResponse = DeleteEventSubscriptionResponse' (Maybe EventSubscription) Int
- newDeleteEventSubscriptionResponse :: Int -> DeleteEventSubscriptionResponse
- data DescribeTableStatistics = DescribeTableStatistics' (Maybe [Filter]) (Maybe Text) (Maybe Int) Text
- newDescribeTableStatistics :: Text -> DescribeTableStatistics
- data DescribeTableStatisticsResponse = DescribeTableStatisticsResponse' (Maybe Text) (Maybe Text) (Maybe [TableStatistics]) Int
- newDescribeTableStatisticsResponse :: Int -> DescribeTableStatisticsResponse
- data DescribeReplicationSubnetGroups = DescribeReplicationSubnetGroups' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeReplicationSubnetGroups :: DescribeReplicationSubnetGroups
- data DescribeReplicationSubnetGroupsResponse = DescribeReplicationSubnetGroupsResponse' (Maybe Text) (Maybe [ReplicationSubnetGroup]) Int
- newDescribeReplicationSubnetGroupsResponse :: Int -> DescribeReplicationSubnetGroupsResponse
- data StartReplicationTask = StartReplicationTask' (Maybe Text) (Maybe Text) (Maybe POSIX) Text StartReplicationTaskTypeValue
- newStartReplicationTask :: Text -> StartReplicationTaskTypeValue -> StartReplicationTask
- data StartReplicationTaskResponse = StartReplicationTaskResponse' (Maybe ReplicationTask) Int
- newStartReplicationTaskResponse :: Int -> StartReplicationTaskResponse
- data DescribeEventSubscriptions = DescribeEventSubscriptions' (Maybe Text) (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeEventSubscriptions :: DescribeEventSubscriptions
- data DescribeEventSubscriptionsResponse = DescribeEventSubscriptionsResponse' (Maybe [EventSubscription]) (Maybe Text) Int
- newDescribeEventSubscriptionsResponse :: Int -> DescribeEventSubscriptionsResponse
- data AddTagsToResource = AddTagsToResource' Text [Tag]
- newAddTagsToResource :: Text -> AddTagsToResource
- data AddTagsToResourceResponse = AddTagsToResourceResponse' Int
- newAddTagsToResourceResponse :: Int -> AddTagsToResourceResponse
- data CreateReplicationSubnetGroup = CreateReplicationSubnetGroup' (Maybe [Tag]) Text Text [Text]
- newCreateReplicationSubnetGroup :: Text -> Text -> CreateReplicationSubnetGroup
- data CreateReplicationSubnetGroupResponse = CreateReplicationSubnetGroupResponse' (Maybe ReplicationSubnetGroup) Int
- newCreateReplicationSubnetGroupResponse :: Int -> CreateReplicationSubnetGroupResponse
- data DescribeApplicableIndividualAssessments = DescribeApplicableIndividualAssessments' (Maybe MigrationTypeValue) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeApplicableIndividualAssessments :: DescribeApplicableIndividualAssessments
- data DescribeApplicableIndividualAssessmentsResponse = DescribeApplicableIndividualAssessmentsResponse' (Maybe Text) (Maybe [Text]) Int
- newDescribeApplicableIndividualAssessmentsResponse :: Int -> DescribeApplicableIndividualAssessmentsResponse
- data DeleteCertificate = DeleteCertificate' Text
- newDeleteCertificate :: Text -> DeleteCertificate
- data DeleteCertificateResponse = DeleteCertificateResponse' (Maybe Certificate) Int
- newDeleteCertificateResponse :: Int -> DeleteCertificateResponse
- data RefreshSchemas = RefreshSchemas' Text Text
- newRefreshSchemas :: Text -> Text -> RefreshSchemas
- data RefreshSchemasResponse = RefreshSchemasResponse' (Maybe RefreshSchemasStatus) Int
- newRefreshSchemasResponse :: Int -> RefreshSchemasResponse
- data DescribeReplicationTasks = DescribeReplicationTasks' (Maybe [Filter]) (Maybe Bool) (Maybe Text) (Maybe Int)
- newDescribeReplicationTasks :: DescribeReplicationTasks
- data DescribeReplicationTasksResponse = DescribeReplicationTasksResponse' (Maybe [ReplicationTask]) (Maybe Text) Int
- newDescribeReplicationTasksResponse :: Int -> DescribeReplicationTasksResponse
- data DescribeEventCategories = DescribeEventCategories' (Maybe Text) (Maybe [Filter])
- newDescribeEventCategories :: DescribeEventCategories
- data DescribeEventCategoriesResponse = DescribeEventCategoriesResponse' (Maybe [EventCategoryGroup]) Int
- newDescribeEventCategoriesResponse :: Int -> DescribeEventCategoriesResponse
- data DescribeOrderableReplicationInstances = DescribeOrderableReplicationInstances' (Maybe Text) (Maybe Int)
- newDescribeOrderableReplicationInstances :: DescribeOrderableReplicationInstances
- data DescribeOrderableReplicationInstancesResponse = DescribeOrderableReplicationInstancesResponse' (Maybe Text) (Maybe [OrderableReplicationInstance]) Int
- newDescribeOrderableReplicationInstancesResponse :: Int -> DescribeOrderableReplicationInstancesResponse
- data DescribePendingMaintenanceActions = DescribePendingMaintenanceActions' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions
- data DescribePendingMaintenanceActionsResponse = DescribePendingMaintenanceActionsResponse' (Maybe [ResourcePendingMaintenanceActions]) (Maybe Text) Int
- newDescribePendingMaintenanceActionsResponse :: Int -> DescribePendingMaintenanceActionsResponse
- data CreateReplicationTask = CreateReplicationTask' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe POSIX) Text Text Text Text MigrationTypeValue Text
- newCreateReplicationTask :: Text -> Text -> Text -> Text -> MigrationTypeValue -> Text -> CreateReplicationTask
- data CreateReplicationTaskResponse = CreateReplicationTaskResponse' (Maybe ReplicationTask) Int
- newCreateReplicationTaskResponse :: Int -> CreateReplicationTaskResponse
- data DescribeEndpoints = DescribeEndpoints' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeEndpoints :: DescribeEndpoints
- data DescribeEndpointsResponse = DescribeEndpointsResponse' (Maybe Text) (Maybe [Endpoint]) Int
- newDescribeEndpointsResponse :: Int -> DescribeEndpointsResponse
- data ModifyReplicationInstance = ModifyReplicationInstance' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) Text
- newModifyReplicationInstance :: Text -> ModifyReplicationInstance
- data ModifyReplicationInstanceResponse = ModifyReplicationInstanceResponse' (Maybe ReplicationInstance) Int
- newModifyReplicationInstanceResponse :: Int -> ModifyReplicationInstanceResponse
- data ImportCertificate = ImportCertificate' (Maybe (Sensitive Text)) (Maybe Base64) (Maybe [Tag]) Text
- newImportCertificate :: Text -> ImportCertificate
- data ImportCertificateResponse = ImportCertificateResponse' (Maybe Certificate) Int
- newImportCertificateResponse :: Int -> ImportCertificateResponse
- data CancelReplicationTaskAssessmentRun = CancelReplicationTaskAssessmentRun' Text
- newCancelReplicationTaskAssessmentRun :: Text -> CancelReplicationTaskAssessmentRun
- data CancelReplicationTaskAssessmentRunResponse = CancelReplicationTaskAssessmentRunResponse' (Maybe ReplicationTaskAssessmentRun) Int
- newCancelReplicationTaskAssessmentRunResponse :: Int -> CancelReplicationTaskAssessmentRunResponse
- data ModifyReplicationSubnetGroup = ModifyReplicationSubnetGroup' (Maybe Text) Text [Text]
- newModifyReplicationSubnetGroup :: Text -> ModifyReplicationSubnetGroup
- data ModifyReplicationSubnetGroupResponse = ModifyReplicationSubnetGroupResponse' (Maybe ReplicationSubnetGroup) Int
- newModifyReplicationSubnetGroupResponse :: Int -> ModifyReplicationSubnetGroupResponse
- data DescribeReplicationTaskIndividualAssessments = DescribeReplicationTaskIndividualAssessments' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeReplicationTaskIndividualAssessments :: DescribeReplicationTaskIndividualAssessments
- data DescribeReplicationTaskIndividualAssessmentsResponse = DescribeReplicationTaskIndividualAssessmentsResponse' (Maybe [ReplicationTaskIndividualAssessment]) (Maybe Text) Int
- newDescribeReplicationTaskIndividualAssessmentsResponse :: Int -> DescribeReplicationTaskIndividualAssessmentsResponse
- data ApplyPendingMaintenanceAction = ApplyPendingMaintenanceAction' Text Text Text
- newApplyPendingMaintenanceAction :: Text -> Text -> Text -> ApplyPendingMaintenanceAction
- data ApplyPendingMaintenanceActionResponse = ApplyPendingMaintenanceActionResponse' (Maybe ResourcePendingMaintenanceActions) Int
- newApplyPendingMaintenanceActionResponse :: Int -> ApplyPendingMaintenanceActionResponse
- data DescribeAccountAttributes = DescribeAccountAttributes' {
- newDescribeAccountAttributes :: DescribeAccountAttributes
- data DescribeAccountAttributesResponse = DescribeAccountAttributesResponse' (Maybe [AccountQuota]) (Maybe Text) Int
- newDescribeAccountAttributesResponse :: Int -> DescribeAccountAttributesResponse
- data DescribeReplicationInstances = DescribeReplicationInstances' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeReplicationInstances :: DescribeReplicationInstances
- data DescribeReplicationInstancesResponse = DescribeReplicationInstancesResponse' (Maybe Text) (Maybe [ReplicationInstance]) Int
- newDescribeReplicationInstancesResponse :: Int -> DescribeReplicationInstancesResponse
- data DescribeRefreshSchemasStatus = DescribeRefreshSchemasStatus' Text
- newDescribeRefreshSchemasStatus :: Text -> DescribeRefreshSchemasStatus
- data DescribeRefreshSchemasStatusResponse = DescribeRefreshSchemasStatusResponse' (Maybe RefreshSchemasStatus) Int
- newDescribeRefreshSchemasStatusResponse :: Int -> DescribeRefreshSchemasStatusResponse
- data StopReplicationTask = StopReplicationTask' Text
- newStopReplicationTask :: Text -> StopReplicationTask
- data StopReplicationTaskResponse = StopReplicationTaskResponse' (Maybe ReplicationTask) Int
- newStopReplicationTaskResponse :: Int -> StopReplicationTaskResponse
- data ModifyReplicationTask = ModifyReplicationTask' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MigrationTypeValue) (Maybe Text) (Maybe Text) (Maybe POSIX) Text
- newModifyReplicationTask :: Text -> ModifyReplicationTask
- data ModifyReplicationTaskResponse = ModifyReplicationTaskResponse' (Maybe ReplicationTask) Int
- newModifyReplicationTaskResponse :: Int -> ModifyReplicationTaskResponse
- data CreateReplicationInstance = CreateReplicationInstance' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text
- newCreateReplicationInstance :: Text -> Text -> CreateReplicationInstance
- data CreateReplicationInstanceResponse = CreateReplicationInstanceResponse' (Maybe ReplicationInstance) Int
- newCreateReplicationInstanceResponse :: Int -> CreateReplicationInstanceResponse
- data DeleteReplicationSubnetGroup = DeleteReplicationSubnetGroup' Text
- newDeleteReplicationSubnetGroup :: Text -> DeleteReplicationSubnetGroup
- data DeleteReplicationSubnetGroupResponse = DeleteReplicationSubnetGroupResponse' Int
- newDeleteReplicationSubnetGroupResponse :: Int -> DeleteReplicationSubnetGroupResponse
- newtype AuthMechanismValue where
- newtype AuthTypeValue where
- AuthTypeValue' { }
- pattern AuthTypeValue_No :: AuthTypeValue
- pattern AuthTypeValue_Password :: AuthTypeValue
- newtype CannedAclForObjectsValue where
- CannedAclForObjectsValue' { }
- pattern CannedAclForObjectsValue_Authenticated_read :: CannedAclForObjectsValue
- pattern CannedAclForObjectsValue_Aws_exec_read :: CannedAclForObjectsValue
- pattern CannedAclForObjectsValue_Bucket_owner_full_control :: CannedAclForObjectsValue
- pattern CannedAclForObjectsValue_Bucket_owner_read :: CannedAclForObjectsValue
- pattern CannedAclForObjectsValue_None :: CannedAclForObjectsValue
- pattern CannedAclForObjectsValue_Private :: CannedAclForObjectsValue
- pattern CannedAclForObjectsValue_Public_read :: CannedAclForObjectsValue
- pattern CannedAclForObjectsValue_Public_read_write :: CannedAclForObjectsValue
- newtype CharLengthSemantics where
- CharLengthSemantics' { }
- pattern CharLengthSemantics_Byte :: CharLengthSemantics
- pattern CharLengthSemantics_Char :: CharLengthSemantics
- pattern CharLengthSemantics_Default :: CharLengthSemantics
- newtype CompressionTypeValue where
- newtype DataFormatValue where
- DataFormatValue' { }
- pattern DataFormatValue_Csv :: DataFormatValue
- pattern DataFormatValue_Parquet :: DataFormatValue
- newtype DatePartitionDelimiterValue where
- DatePartitionDelimiterValue' { }
- pattern DatePartitionDelimiterValue_DASH :: DatePartitionDelimiterValue
- pattern DatePartitionDelimiterValue_NONE :: DatePartitionDelimiterValue
- pattern DatePartitionDelimiterValue_SLASH :: DatePartitionDelimiterValue
- pattern DatePartitionDelimiterValue_UNDERSCORE :: DatePartitionDelimiterValue
- newtype DatePartitionSequenceValue where
- DatePartitionSequenceValue' { }
- pattern DatePartitionSequenceValue_DDMMYYYY :: DatePartitionSequenceValue
- pattern DatePartitionSequenceValue_MMYYYYDD :: DatePartitionSequenceValue
- pattern DatePartitionSequenceValue_YYYYMM :: DatePartitionSequenceValue
- pattern DatePartitionSequenceValue_YYYYMMDD :: DatePartitionSequenceValue
- pattern DatePartitionSequenceValue_YYYYMMDDHH :: DatePartitionSequenceValue
- newtype DmsSslModeValue where
- DmsSslModeValue' { }
- pattern DmsSslModeValue_None :: DmsSslModeValue
- pattern DmsSslModeValue_Require :: DmsSslModeValue
- pattern DmsSslModeValue_Verify_ca :: DmsSslModeValue
- pattern DmsSslModeValue_Verify_full :: DmsSslModeValue
- newtype EncodingTypeValue where
- newtype EncryptionModeValue where
- newtype EndpointSettingTypeValue where
- newtype KafkaSecurityProtocol where
- newtype MessageFormatValue where
- newtype MigrationTypeValue where
- newtype NestingLevelValue where
- NestingLevelValue' { }
- pattern NestingLevelValue_None :: NestingLevelValue
- pattern NestingLevelValue_One :: NestingLevelValue
- newtype ParquetVersionValue where
- newtype PluginNameValue where
- PluginNameValue' { }
- pattern PluginNameValue_No_preference :: PluginNameValue
- pattern PluginNameValue_Pglogical :: PluginNameValue
- pattern PluginNameValue_Test_decoding :: PluginNameValue
- newtype RedisAuthTypeValue where
- RedisAuthTypeValue' { }
- pattern RedisAuthTypeValue_Auth_role :: RedisAuthTypeValue
- pattern RedisAuthTypeValue_Auth_token :: RedisAuthTypeValue
- pattern RedisAuthTypeValue_None :: RedisAuthTypeValue
- newtype RefreshSchemasStatusTypeValue where
- newtype ReleaseStatusValues where
- newtype ReloadOptionValue where
- newtype ReplicationEndpointTypeValue where
- newtype SafeguardPolicy where
- newtype SourceType where
- SourceType' { }
- pattern SourceType_Replication_instance :: SourceType
- newtype SslSecurityProtocolValue where
- newtype StartReplicationTaskTypeValue where
- newtype TargetDbType where
- TargetDbType' { }
- pattern TargetDbType_Multiple_databases :: TargetDbType
- pattern TargetDbType_Specific_database :: TargetDbType
- data AccountQuota = AccountQuota' (Maybe Integer) (Maybe Integer) (Maybe Text)
- newAccountQuota :: AccountQuota
- data AvailabilityZone = AvailabilityZone' (Maybe Text)
- newAvailabilityZone :: AvailabilityZone
- data Certificate = Certificate' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Base64) (Maybe Int) (Maybe POSIX)
- newCertificate :: Certificate
- data Connection = Connection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newConnection :: Connection
- data DmsTransferSettings = DmsTransferSettings' (Maybe Text) (Maybe Text)
- newDmsTransferSettings :: DmsTransferSettings
- data DocDbSettings = DocDbSettings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe NestingLevelValue) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int)
- newDocDbSettings :: DocDbSettings
- data DynamoDbSettings = DynamoDbSettings' Text
- newDynamoDbSettings :: Text -> DynamoDbSettings
- data ElasticsearchSettings = ElasticsearchSettings' (Maybe Int) (Maybe Int) Text Text
- newElasticsearchSettings :: Text -> Text -> ElasticsearchSettings
- data Endpoint = Endpoint' (Maybe Text) (Maybe DmsTransferSettings) (Maybe MySQLSettings) (Maybe Text) (Maybe MicrosoftSQLServerSettings) (Maybe Text) (Maybe Text) (Maybe DocDbSettings) (Maybe Text) (Maybe PostgreSQLSettings) (Maybe Text) (Maybe KafkaSettings) (Maybe OracleSettings) (Maybe ReplicationEndpointTypeValue) (Maybe RedshiftSettings) (Maybe ElasticsearchSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RedisSettings) (Maybe NeptuneSettings) (Maybe IBMDb2Settings) (Maybe Text) (Maybe MongoDbSettings) (Maybe DmsSslModeValue) (Maybe SybaseSettings) (Maybe Text) (Maybe S3Settings) (Maybe KinesisSettings) (Maybe Text) (Maybe Text) (Maybe DynamoDbSettings) (Maybe Text) (Maybe Int)
- newEndpoint :: Endpoint
- data EndpointSetting = EndpointSetting' (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe EndpointSettingTypeValue) (Maybe [Text])
- newEndpointSetting :: EndpointSetting
- data Event = Event' (Maybe SourceType) (Maybe Text) (Maybe POSIX) (Maybe [Text]) (Maybe Text)
- newEvent :: Event
- data EventCategoryGroup = EventCategoryGroup' (Maybe Text) (Maybe [Text])
- newEventCategoryGroup :: EventCategoryGroup
- data EventSubscription = EventSubscription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text])
- newEventSubscription :: EventSubscription
- data Filter = Filter' Text [Text]
- newFilter :: Text -> Filter
- data IBMDb2Settings = IBMDb2Settings' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int)
- newIBMDb2Settings :: IBMDb2Settings
- data KafkaSettings = KafkaSettings' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe MessageFormatValue) (Maybe KafkaSecurityProtocol) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool)
- newKafkaSettings :: KafkaSettings
- data KinesisSettings = KinesisSettings' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe MessageFormatValue) (Maybe Bool)
- newKinesisSettings :: KinesisSettings
- data MicrosoftSQLServerSettings = MicrosoftSQLServerSettings' (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe SafeguardPolicy) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int)
- newMicrosoftSQLServerSettings :: MicrosoftSQLServerSettings
- data MongoDbSettings = MongoDbSettings' (Maybe Text) (Maybe Text) (Maybe AuthMechanismValue) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe NestingLevelValue) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AuthTypeValue) (Maybe Int)
- newMongoDbSettings :: MongoDbSettings
- data MySQLSettings = MySQLSettings' (Maybe Int) (Maybe TargetDbType) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int)
- newMySQLSettings :: MySQLSettings
- data NeptuneSettings = NeptuneSettings' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) Text Text
- newNeptuneSettings :: Text -> Text -> NeptuneSettings
- data OracleSettings = OracleSettings' (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [Int]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe CharLengthSemantics) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int)
- newOracleSettings :: OracleSettings
- data OrderableReplicationInstance = OrderableReplicationInstance' (Maybe Text) (Maybe Int) (Maybe ReleaseStatusValues) (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text)
- newOrderableReplicationInstance :: OrderableReplicationInstance
- data PendingMaintenanceAction = PendingMaintenanceAction' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newPendingMaintenanceAction :: PendingMaintenanceAction
- data PostgreSQLSettings = PostgreSQLSettings' (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe PluginNameValue) (Maybe Int) (Maybe Text) (Maybe Bool)
- newPostgreSQLSettings :: PostgreSQLSettings
- data RedisSettings = RedisSettings' (Maybe SslSecurityProtocolValue) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe RedisAuthTypeValue) Text Int
- newRedisSettings :: Text -> Int -> RedisSettings
- data RedshiftSettings = RedshiftSettings' (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EncryptionModeValue) (Maybe Text) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int)
- newRedshiftSettings :: RedshiftSettings
- data RefreshSchemasStatus = RefreshSchemasStatus' (Maybe RefreshSchemasStatusTypeValue) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newRefreshSchemasStatus :: RefreshSchemasStatus
- data ReplicationInstance = ReplicationInstance' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe ReplicationSubnetGroup) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [VpcSecurityGroupMembership]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReplicationPendingModifiedValues)
- newReplicationInstance :: ReplicationInstance
- data ReplicationInstanceTaskLog = ReplicationInstanceTaskLog' (Maybe Text) (Maybe Text) (Maybe Integer)
- newReplicationInstanceTaskLog :: ReplicationInstanceTaskLog
- data ReplicationPendingModifiedValues = ReplicationPendingModifiedValues' (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text)
- newReplicationPendingModifiedValues :: ReplicationPendingModifiedValues
- data ReplicationSubnetGroup = ReplicationSubnetGroup' (Maybe Text) (Maybe [Subnet]) (Maybe Text) (Maybe Text) (Maybe Text)
- newReplicationSubnetGroup :: ReplicationSubnetGroup
- data ReplicationTask = ReplicationTask' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MigrationTypeValue) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReplicationTaskStats) (Maybe Text) (Maybe Text)
- newReplicationTask :: ReplicationTask
- data ReplicationTaskAssessmentResult = ReplicationTaskAssessmentResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newReplicationTaskAssessmentResult :: ReplicationTaskAssessmentResult
- data ReplicationTaskAssessmentRun = ReplicationTaskAssessmentRun' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ReplicationTaskAssessmentRunProgress) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newReplicationTaskAssessmentRun :: ReplicationTaskAssessmentRun
- data ReplicationTaskAssessmentRunProgress = ReplicationTaskAssessmentRunProgress' (Maybe Int) (Maybe Int)
- newReplicationTaskAssessmentRunProgress :: ReplicationTaskAssessmentRunProgress
- data ReplicationTaskIndividualAssessment = ReplicationTaskIndividualAssessment' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newReplicationTaskIndividualAssessment :: ReplicationTaskIndividualAssessment
- data ReplicationTaskStats = ReplicationTaskStats' (Maybe POSIX) (Maybe Int) (Maybe POSIX) (Maybe Integer) (Maybe POSIX) (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe POSIX)
- newReplicationTaskStats :: ReplicationTaskStats
- data ResourcePendingMaintenanceActions = ResourcePendingMaintenanceActions' (Maybe [PendingMaintenanceAction]) (Maybe Text)
- newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions
- data S3Settings = S3Settings' (Maybe ParquetVersionValue) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataFormatValue) (Maybe Bool) (Maybe EncodingTypeValue) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe EncryptionModeValue) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe DatePartitionDelimiterValue) (Maybe Bool) (Maybe CannedAclForObjectsValue) (Maybe CompressionTypeValue) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe DatePartitionSequenceValue) (Maybe Int) (Maybe Text)
- newS3Settings :: S3Settings
- data Subnet = Subnet' (Maybe Text) (Maybe Text) (Maybe AvailabilityZone)
- newSubnet :: Subnet
- data SupportedEndpointType = SupportedEndpointType' (Maybe Text) (Maybe ReplicationEndpointTypeValue) (Maybe Text) (Maybe Text) (Maybe Bool)
- newSupportedEndpointType :: SupportedEndpointType
- data SybaseSettings = SybaseSettings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Int)
- newSybaseSettings :: SybaseSettings
- data TableStatistics = TableStatistics' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe Integer) (Maybe Bool) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newTableStatistics :: TableStatistics
- data TableToReload = TableToReload' Text Text
- newTableToReload :: Text -> Text -> TableToReload
- data Tag = Tag' (Maybe Text) (Maybe Text) (Maybe Text)
- newTag :: Tag
- data VpcSecurityGroupMembership = VpcSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newVpcSecurityGroupMembership :: VpcSecurityGroupMembership
Service Configuration
defaultService :: Service Source #
API version 2016-01-01
of the Amazon Database Migration Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DMS
.
KMSAccessDeniedFault
_KMSAccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.
KMSDisabledFault
_KMSDisabledFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified master key (CMK) isn't enabled.
KMSFault
_KMSFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Key Management Service (KMS) error is preventing access to KMS.
InvalidSubnet
_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #
The subnet provided is invalid.
KMSKeyNotAccessibleFault
_KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DMS cannot access the KMS key.
ReplicationSubnetGroupDoesNotCoverEnoughAZs
_ReplicationSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError Source #
The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
S3ResourceNotFoundFault
_S3ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A specified Amazon S3 bucket, bucket folder, or other object can't be found.
InvalidResourceStateFault
_InvalidResourceStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is in a state that prevents it from being used for database migration.
InvalidCertificateFault
_InvalidCertificateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The certificate was not valid.
SNSNoAuthorizationFault
_SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized for the SNS subscription.
ResourceAlreadyExistsFault
_ResourceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you are attempting to create already exists.
InsufficientResourceCapacityFault
_InsufficientResourceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are not enough resources allocated to the database migration.
S3AccessDeniedFault
_S3AccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Insufficient privileges are preventing access to an Amazon S3 object.
SNSInvalidTopicFault
_SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The SNS topic is invalid.
KMSNotFoundFault
_KMSNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified KMS entity or resource can't be found.
KMSThrottlingFault
_KMSThrottlingFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
This request triggered KMS request throttling.
ResourceQuotaExceededFault
_ResourceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota for this resource quota has been exceeded.
UpgradeDependencyFailureFault
_UpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
An upgrade dependency is preventing the database migration.
ResourceNotFoundFault
_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource could not be found.
StorageQuotaExceededFault
_StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The storage quota has been exceeded.
AccessDeniedFault
_AccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DMS was denied access to the endpoint. Check that the role is correctly configured.
SubnetAlreadyInUse
_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified subnet is already in use.
KMSInvalidStateFault
_KMSInvalidStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the specified KMS resource isn't valid for this request.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
ReplicationInstanceAvailable
newReplicationInstanceAvailable :: Wait DescribeReplicationInstances Source #
Polls DescribeReplicationInstances
every 60 seconds until a successful state is reached. An error is returned after 60 failed checks.
ReplicationTaskDeleted
newReplicationTaskDeleted :: Wait DescribeReplicationTasks Source #
Polls DescribeReplicationTasks
every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
ReplicationTaskReady
newReplicationTaskReady :: Wait DescribeReplicationTasks Source #
Polls DescribeReplicationTasks
every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
ReplicationInstanceDeleted
newReplicationInstanceDeleted :: Wait DescribeReplicationInstances Source #
Polls DescribeReplicationInstances
every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
EndpointDeleted
newEndpointDeleted :: Wait DescribeEndpoints Source #
Polls DescribeEndpoints
every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.
ReplicationTaskStopped
newReplicationTaskStopped :: Wait DescribeReplicationTasks Source #
Polls DescribeReplicationTasks
every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
ReplicationTaskRunning
newReplicationTaskRunning :: Wait DescribeReplicationTasks Source #
Polls DescribeReplicationTasks
every 15 seconds until a successful state is reached. An error is returned after 60 failed checks.
TestConnectionSucceeds
newTestConnectionSucceeds :: Wait DescribeConnections Source #
Polls DescribeConnections
every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DeleteReplicationInstance
data DeleteReplicationInstance Source #
See: newDeleteReplicationInstance
smart constructor.
Constructors
DeleteReplicationInstance' Text |
Instances
newDeleteReplicationInstance Source #
Create a value of DeleteReplicationInstance
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:replicationInstanceArn:DeleteReplicationInstance'
, deleteReplicationInstance_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance to be
deleted.
data DeleteReplicationInstanceResponse Source #
See: newDeleteReplicationInstanceResponse
smart constructor.
Constructors
DeleteReplicationInstanceResponse' (Maybe ReplicationInstance) Int |
Instances
newDeleteReplicationInstanceResponse Source #
Arguments
:: Int | |
-> DeleteReplicationInstanceResponse |
Create a value of DeleteReplicationInstanceResponse
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:replicationInstance:DeleteReplicationInstanceResponse'
, deleteReplicationInstanceResponse_replicationInstance
- The replication instance that was deleted.
$sel:httpStatus:DeleteReplicationInstanceResponse'
, deleteReplicationInstanceResponse_httpStatus
- The response's http status code.
RebootReplicationInstance
data RebootReplicationInstance Source #
See: newRebootReplicationInstance
smart constructor.
Instances
newRebootReplicationInstance Source #
Create a value of RebootReplicationInstance
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:forcePlannedFailover:RebootReplicationInstance'
, rebootReplicationInstance_forcePlannedFailover
- If this parameter is true
, the reboot is conducted through a planned
Multi-AZ failover where resources are released and cleaned up prior to
conducting the failover. If the instance isn''t configured for
Multi-AZ, then you can't specify true
. ( --force-planned-failover
and --force-failover
can't both be set to true
.)
$sel:forceFailover:RebootReplicationInstance'
, rebootReplicationInstance_forceFailover
- If this parameter is true
, the reboot is conducted through a Multi-AZ
failover. If the instance isn't configured for Multi-AZ, then you
can't specify true
. ( --force-planned-failover
and
--force-failover
can't both be set to true
.)
$sel:replicationInstanceArn:RebootReplicationInstance'
, rebootReplicationInstance_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
data RebootReplicationInstanceResponse Source #
See: newRebootReplicationInstanceResponse
smart constructor.
Constructors
RebootReplicationInstanceResponse' (Maybe ReplicationInstance) Int |
Instances
newRebootReplicationInstanceResponse Source #
Arguments
:: Int | |
-> RebootReplicationInstanceResponse |
Create a value of RebootReplicationInstanceResponse
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:replicationInstance:RebootReplicationInstanceResponse'
, rebootReplicationInstanceResponse_replicationInstance
- The replication instance that is being rebooted.
$sel:httpStatus:RebootReplicationInstanceResponse'
, rebootReplicationInstanceResponse_httpStatus
- The response's http status code.
ReloadTables
data ReloadTables Source #
See: newReloadTables
smart constructor.
Constructors
ReloadTables' (Maybe ReloadOptionValue) Text [TableToReload] |
Instances
Arguments
:: Text | |
-> ReloadTables |
Create a value of ReloadTables
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:reloadOption:ReloadTables'
, reloadTables_reloadOption
- Options for reload. Specify data-reload
to reload the data and
re-validate it if validation is enabled. Specify validate-only
to
re-validate the table. This option applies only when validation is
enabled for the task.
Valid values: data-reload, validate-only
Default value is data-reload.
$sel:replicationTaskArn:ReloadTables'
, reloadTables_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
$sel:tablesToReload:ReloadTables'
, reloadTables_tablesToReload
- The name and schema of the table to be reloaded.
data ReloadTablesResponse Source #
See: newReloadTablesResponse
smart constructor.
Constructors
ReloadTablesResponse' (Maybe Text) Int |
Instances
newReloadTablesResponse Source #
Arguments
:: Int | |
-> ReloadTablesResponse |
Create a value of ReloadTablesResponse
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:replicationTaskArn:ReloadTables'
, reloadTablesResponse_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
$sel:httpStatus:ReloadTablesResponse'
, reloadTablesResponse_httpStatus
- The response's http status code.
StartReplicationTaskAssessment
data StartReplicationTaskAssessment Source #
See: newStartReplicationTaskAssessment
smart constructor.
Constructors
StartReplicationTaskAssessment' Text |
Instances
newStartReplicationTaskAssessment Source #
Arguments
:: Text | |
-> StartReplicationTaskAssessment |
Create a value of StartReplicationTaskAssessment
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:replicationTaskArn:StartReplicationTaskAssessment'
, startReplicationTaskAssessment_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
data StartReplicationTaskAssessmentResponse Source #
See: newStartReplicationTaskAssessmentResponse
smart constructor.
Constructors
StartReplicationTaskAssessmentResponse' (Maybe ReplicationTask) Int |
Instances
newStartReplicationTaskAssessmentResponse Source #
Arguments
:: Int | |
-> StartReplicationTaskAssessmentResponse |
Create a value of StartReplicationTaskAssessmentResponse
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:replicationTask:StartReplicationTaskAssessmentResponse'
, startReplicationTaskAssessmentResponse_replicationTask
- The assessed replication task.
$sel:httpStatus:StartReplicationTaskAssessmentResponse'
, startReplicationTaskAssessmentResponse_httpStatus
- The response's http status code.
DeleteReplicationTaskAssessmentRun
data DeleteReplicationTaskAssessmentRun Source #
See: newDeleteReplicationTaskAssessmentRun
smart constructor.
Constructors
DeleteReplicationTaskAssessmentRun' Text |
Instances
newDeleteReplicationTaskAssessmentRun Source #
Arguments
:: Text |
|
-> DeleteReplicationTaskAssessmentRun |
Create a value of DeleteReplicationTaskAssessmentRun
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:replicationTaskAssessmentRunArn:DeleteReplicationTaskAssessmentRun'
, deleteReplicationTaskAssessmentRun_replicationTaskAssessmentRunArn
- Amazon Resource Name (ARN) of the premigration assessment run to be
deleted.
data DeleteReplicationTaskAssessmentRunResponse Source #
See: newDeleteReplicationTaskAssessmentRunResponse
smart constructor.
Instances
newDeleteReplicationTaskAssessmentRunResponse Source #
Arguments
:: Int | |
-> DeleteReplicationTaskAssessmentRunResponse |
Create a value of DeleteReplicationTaskAssessmentRunResponse
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:replicationTaskAssessmentRun:DeleteReplicationTaskAssessmentRunResponse'
, deleteReplicationTaskAssessmentRunResponse_replicationTaskAssessmentRun
- The ReplicationTaskAssessmentRun
object for the deleted assessment
run.
$sel:httpStatus:DeleteReplicationTaskAssessmentRunResponse'
, deleteReplicationTaskAssessmentRunResponse_httpStatus
- The response's http status code.
CreateEndpoint
data CreateEndpoint Source #
See: newCreateEndpoint
smart constructor.
Constructors
Instances
Arguments
:: Text | |
-> ReplicationEndpointTypeValue | |
-> Text | |
-> CreateEndpoint |
Create a value of CreateEndpoint
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:dmsTransferSettings:CreateEndpoint'
, createEndpoint_dmsTransferSettings
- The settings in JSON format for the DMS transfer type of source
endpoint.
Possible settings include the following:
ServiceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam:PassRole
action.BucketName
- The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string,BucketName=string
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string", }
$sel:mySQLSettings:CreateEndpoint'
, createEndpoint_mySQLSettings
- Settings in JSON format for the source and target MySQL endpoint. For
information about other available settings, see
Extra connection attributes when using MySQL as a source for DMS
and
Extra connection attributes when using a MySQL-compatible database as a target for DMS
in the Database Migration Service User Guide.
$sel:serverName:CreateEndpoint'
, createEndpoint_serverName
- The name of the server where the endpoint database resides.
$sel:microsoftSQLServerSettings:CreateEndpoint'
, createEndpoint_microsoftSQLServerSettings
- Settings in JSON format for the source and target Microsoft SQL Server
endpoint. For information about other available settings, see
Extra connection attributes when using SQL Server as a source for DMS
and
Extra connection attributes when using SQL Server as a target for DMS
in the Database Migration Service User Guide.
$sel:certificateArn:CreateEndpoint'
, createEndpoint_certificateArn
- The Amazon Resource Name (ARN) for the certificate.
$sel:serviceAccessRoleArn:CreateEndpoint'
, createEndpoint_serviceAccessRoleArn
- The Amazon Resource Name (ARN) for the service access role that you want
to use to create the endpoint. The role must allow the iam:PassRole
action.
$sel:docDbSettings:CreateEndpoint'
, createEndpoint_docDbSettings
- Undocumented member.
$sel:postgreSQLSettings:CreateEndpoint'
, createEndpoint_postgreSQLSettings
- Settings in JSON format for the source and target PostgreSQL endpoint.
For information about other available settings, see
Extra connection attributes when using PostgreSQL as a source for DMS
and
Extra connection attributes when using PostgreSQL as a target for DMS
in the Database Migration Service User Guide.
$sel:extraConnectionAttributes:CreateEndpoint'
, createEndpoint_extraConnectionAttributes
- Additional attributes associated with the connection. Each attribute is
specified as a name-value pair associated by an equal sign (=). Multiple
attributes are separated by a semicolon (;) with no additional white
space. For information on the attributes available for connecting your
source or target endpoint, see
Working with DMS Endpoints
in the Database Migration Service User Guide.
$sel:kafkaSettings:CreateEndpoint'
, createEndpoint_kafkaSettings
- Settings in JSON format for the target Apache Kafka endpoint. For more
information about the available settings, see
Using object mapping to migrate data to a Kafka topic
in the Database Migration Service User Guide.
$sel:oracleSettings:CreateEndpoint'
, createEndpoint_oracleSettings
- Settings in JSON format for the source and target Oracle endpoint. For
information about other available settings, see
Extra connection attributes when using Oracle as a source for DMS
and
Extra connection attributes when using Oracle as a target for DMS
in the Database Migration Service User Guide.
$sel:redshiftSettings:CreateEndpoint'
, createEndpoint_redshiftSettings
- Undocumented member.
$sel:elasticsearchSettings:CreateEndpoint'
, createEndpoint_elasticsearchSettings
- Settings in JSON format for the target Elasticsearch endpoint. For more
information about the available settings, see
Extra Connection Attributes When Using Elasticsearch as a Target for DMS
in the Database Migration Service User Guide.
$sel:username:CreateEndpoint'
, createEndpoint_username
- The user name to be used to log in to the endpoint database.
$sel:externalTableDefinition:CreateEndpoint'
, createEndpoint_externalTableDefinition
- The external table definition.
$sel:redisSettings:CreateEndpoint'
, createEndpoint_redisSettings
- Settings in JSON format for the target Redis endpoint.
$sel:neptuneSettings:CreateEndpoint'
, createEndpoint_neptuneSettings
- Settings in JSON format for the target Amazon Neptune endpoint. For more
information about the available settings, see
Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target
in the Database Migration Service User Guide.
$sel:iBMDb2Settings:CreateEndpoint'
, createEndpoint_iBMDb2Settings
- Settings in JSON format for the source IBM Db2 LUW endpoint. For
information about other available settings, see
Extra connection attributes when using Db2 LUW as a source for DMS
in the Database Migration Service User Guide.
$sel:kmsKeyId:CreateEndpoint'
, createEndpoint_kmsKeyId
- An KMS key identifier that is used to encrypt the connection parameters
for the endpoint.
If you don't specify a value for the KmsKeyId
parameter, then DMS
uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
$sel:mongoDbSettings:CreateEndpoint'
, createEndpoint_mongoDbSettings
- Settings in JSON format for the source MongoDB endpoint. For more
information about the available settings, see
Endpoint configuration settings when using MongoDB as a source for Database Migration Service
in the Database Migration Service User Guide.
$sel:sslMode:CreateEndpoint'
, createEndpoint_sslMode
- The Secure Sockets Layer (SSL) mode to use for the SSL connection. The
default is none
$sel:password:CreateEndpoint'
, createEndpoint_password
- The password to be used to log in to the endpoint database.
$sel:sybaseSettings:CreateEndpoint'
, createEndpoint_sybaseSettings
- Settings in JSON format for the source and target SAP ASE endpoint. For
information about other available settings, see
Extra connection attributes when using SAP ASE as a source for DMS
and
Extra connection attributes when using SAP ASE as a target for DMS
in the Database Migration Service User Guide.
$sel:databaseName:CreateEndpoint'
, createEndpoint_databaseName
- The name of the endpoint database. For a MySQL source or target
endpoint, do not specify DatabaseName.
$sel:s3Settings:CreateEndpoint'
, createEndpoint_s3Settings
- Settings in JSON format for the target Amazon S3 endpoint. For more
information about the available settings, see
Extra Connection Attributes When Using Amazon S3 as a Target for DMS
in the Database Migration Service User Guide.
$sel:kinesisSettings:CreateEndpoint'
, createEndpoint_kinesisSettings
- Settings in JSON format for the target endpoint for Amazon Kinesis Data
Streams. For more information about the available settings, see
Using object mapping to migrate data to a Kinesis data stream
in the Database Migration Service User Guide.
$sel:dynamoDbSettings:CreateEndpoint'
, createEndpoint_dynamoDbSettings
- Settings in JSON format for the target Amazon DynamoDB endpoint. For
information about other available settings, see
Using Object Mapping to Migrate Data to DynamoDB
in the Database Migration Service User Guide.
$sel:resourceIdentifier:CreateEndpoint'
, createEndpoint_resourceIdentifier
- A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the created
Endpoint
object. The value for this parameter can have up to 31
characters. It can contain only ASCII letters, digits, and hyphen
('-'). Also, it can't end with a hyphen or contain two consecutive
hyphens, and can only begin with a letter, such as Example-App-ARN1
.
For example, this value might result in the EndpointArn
value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't
specify a ResourceIdentifier
value, DMS generates a default identifier
value for the end of EndpointArn
.
$sel:tags:CreateEndpoint'
, createEndpoint_tags
- One or more tags to be assigned to the endpoint.
$sel:port:CreateEndpoint'
, createEndpoint_port
- The port used by the endpoint database.
$sel:endpointIdentifier:CreateEndpoint'
, createEndpoint_endpointIdentifier
- The database endpoint identifier. Identifiers must begin with a letter
and must contain only ASCII letters, digits, and hyphens. They can't
end with a hyphen, or contain two consecutive hyphens.
$sel:endpointType:CreateEndpoint'
, createEndpoint_endpointType
- The type of endpoint. Valid values are source
and target
.
$sel:engineName:CreateEndpoint'
, createEndpoint_engineName
- The type of engine for the endpoint. Valid values, depending on the
EndpointType
value, include "mysql"
, "oracle"
, "postgres"
,
"mariadb"
, "aurora"
, "aurora-postgresql"
, "redshift"
,
"s3"
, "db2"
, "azuredb"
, "sybase"
, "dynamodb"
,
"mongodb"
, "kinesis"
, "kafka"
, "elasticsearch"
,
"docdb"
, "sqlserver"
, and "neptune"
.
data CreateEndpointResponse Source #
See: newCreateEndpointResponse
smart constructor.
Constructors
CreateEndpointResponse' (Maybe Endpoint) Int |
Instances
newCreateEndpointResponse Source #
Create a value of CreateEndpointResponse
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:endpoint:CreateEndpointResponse'
, createEndpointResponse_endpoint
- The endpoint that was created.
$sel:httpStatus:CreateEndpointResponse'
, createEndpointResponse_httpStatus
- The response's http status code.
DescribeSchemas (Paginated)
data DescribeSchemas Source #
See: newDescribeSchemas
smart constructor.
Instances
Arguments
:: Text | |
-> DescribeSchemas |
Create a value of DescribeSchemas
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:marker:DescribeSchemas'
, describeSchemas_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeSchemas'
, describeSchemas_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:endpointArn:DescribeSchemas'
, describeSchemas_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
data DescribeSchemasResponse Source #
See: newDescribeSchemasResponse
smart constructor.
Instances
newDescribeSchemasResponse Source #
Create a value of DescribeSchemasResponse
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:schemas:DescribeSchemasResponse'
, describeSchemasResponse_schemas
- The described schema.
$sel:marker:DescribeSchemas'
, describeSchemasResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeSchemasResponse'
, describeSchemasResponse_httpStatus
- The response's http status code.
DeleteConnection
data DeleteConnection Source #
See: newDeleteConnection
smart constructor.
Constructors
DeleteConnection' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> DeleteConnection |
Create a value of DeleteConnection
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:endpointArn:DeleteConnection'
, deleteConnection_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
$sel:replicationInstanceArn:DeleteConnection'
, deleteConnection_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
data DeleteConnectionResponse Source #
See: newDeleteConnectionResponse
smart constructor.
Constructors
DeleteConnectionResponse' (Maybe Connection) Int |
Instances
newDeleteConnectionResponse Source #
Create a value of DeleteConnectionResponse
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:connection:DeleteConnectionResponse'
, deleteConnectionResponse_connection
- The connection that is being deleted.
$sel:httpStatus:DeleteConnectionResponse'
, deleteConnectionResponse_httpStatus
- The response's http status code.
ModifyEventSubscription
data ModifyEventSubscription Source #
See: newModifyEventSubscription
smart constructor.
Instances
newModifyEventSubscription Source #
Create a value of ModifyEventSubscription
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:snsTopicArn:ModifyEventSubscription'
, modifyEventSubscription_snsTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic
and subscribe to it.
$sel:enabled:ModifyEventSubscription'
, modifyEventSubscription_enabled
- A Boolean value; set to true to activate the subscription.
$sel:sourceType:ModifyEventSubscription'
, modifyEventSubscription_sourceType
- The type of DMS resource that generates the events you want to subscribe
to.
Valid values: replication-instance | replication-task
$sel:eventCategories:ModifyEventSubscription'
, modifyEventSubscription_eventCategories
- A list of event categories for a source type that you want to subscribe
to. Use the DescribeEventCategories
action to see a list of event
categories.
$sel:subscriptionName:ModifyEventSubscription'
, modifyEventSubscription_subscriptionName
- The name of the DMS event notification subscription to be modified.
data ModifyEventSubscriptionResponse Source #
See: newModifyEventSubscriptionResponse
smart constructor.
Constructors
ModifyEventSubscriptionResponse' (Maybe EventSubscription) Int |
Instances
newModifyEventSubscriptionResponse Source #
Create a value of ModifyEventSubscriptionResponse
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:eventSubscription:ModifyEventSubscriptionResponse'
, modifyEventSubscriptionResponse_eventSubscription
- The modified event subscription.
$sel:httpStatus:ModifyEventSubscriptionResponse'
, modifyEventSubscriptionResponse_httpStatus
- The response's http status code.
DescribeReplicationInstanceTaskLogs
data DescribeReplicationInstanceTaskLogs Source #
See: newDescribeReplicationInstanceTaskLogs
smart constructor.
Instances
newDescribeReplicationInstanceTaskLogs Source #
Arguments
:: Text |
|
-> DescribeReplicationInstanceTaskLogs |
Create a value of DescribeReplicationInstanceTaskLogs
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:marker:DescribeReplicationInstanceTaskLogs'
, describeReplicationInstanceTaskLogs_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeReplicationInstanceTaskLogs'
, describeReplicationInstanceTaskLogs_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:replicationInstanceArn:DescribeReplicationInstanceTaskLogs'
, describeReplicationInstanceTaskLogs_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
data DescribeReplicationInstanceTaskLogsResponse Source #
See: newDescribeReplicationInstanceTaskLogsResponse
smart constructor.
Constructors
DescribeReplicationInstanceTaskLogsResponse' (Maybe [ReplicationInstanceTaskLog]) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeReplicationInstanceTaskLogsResponse Source #
Arguments
:: Int |
|
-> DescribeReplicationInstanceTaskLogsResponse |
Create a value of DescribeReplicationInstanceTaskLogsResponse
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:replicationInstanceTaskLogs:DescribeReplicationInstanceTaskLogsResponse'
, describeReplicationInstanceTaskLogsResponse_replicationInstanceTaskLogs
- An array of replication task log metadata. Each member of the array
contains the replication task name, ARN, and task log size (in bytes).
$sel:marker:DescribeReplicationInstanceTaskLogs'
, describeReplicationInstanceTaskLogsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:replicationInstanceArn:DescribeReplicationInstanceTaskLogs'
, describeReplicationInstanceTaskLogsResponse_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
$sel:httpStatus:DescribeReplicationInstanceTaskLogsResponse'
, describeReplicationInstanceTaskLogsResponse_httpStatus
- The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents
smart constructor.
Constructors
DescribeEvents' (Maybe POSIX) (Maybe SourceType) (Maybe [Filter]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe POSIX) (Maybe Int) |
Instances
newDescribeEvents :: DescribeEvents Source #
Create a value of DescribeEvents
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:startTime:DescribeEvents'
, describeEvents_startTime
- The start time for the events to be listed.
$sel:sourceType:DescribeEvents'
, describeEvents_sourceType
- The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
$sel:filters:DescribeEvents'
, describeEvents_filters
- Filters applied to events.
$sel:sourceIdentifier:DescribeEvents'
, describeEvents_sourceIdentifier
- The identifier of an event source.
$sel:eventCategories:DescribeEvents'
, describeEvents_eventCategories
- A list of event categories for the source type that you've chosen.
$sel:marker:DescribeEvents'
, describeEvents_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeEvents'
, describeEvents_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:endTime:DescribeEvents'
, describeEvents_endTime
- The end time for the events to be listed.
$sel:duration:DescribeEvents'
, describeEvents_duration
- The duration of the events to be listed.
data DescribeEventsResponse Source #
See: newDescribeEventsResponse
smart constructor.
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse
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:events:DescribeEventsResponse'
, describeEventsResponse_events
- The events described.
$sel:marker:DescribeEvents'
, describeEventsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeEventsResponse'
, describeEventsResponse_httpStatus
- The response's http status code.
DeleteEndpoint
data DeleteEndpoint Source #
See: newDeleteEndpoint
smart constructor.
Constructors
DeleteEndpoint' Text |
Instances
Arguments
:: Text | |
-> DeleteEndpoint |
Create a value of DeleteEndpoint
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:endpointArn:DeleteEndpoint'
, deleteEndpoint_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
data DeleteEndpointResponse Source #
See: newDeleteEndpointResponse
smart constructor.
Constructors
DeleteEndpointResponse' (Maybe Endpoint) Int |
Instances
newDeleteEndpointResponse Source #
Create a value of DeleteEndpointResponse
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:endpoint:DeleteEndpointResponse'
, deleteEndpointResponse_endpoint
- The endpoint that was deleted.
$sel:httpStatus:DeleteEndpointResponse'
, deleteEndpointResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Constructors
ListTagsForResource' (Maybe Text) (Maybe [Text]) |
Instances
newListTagsForResource :: ListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) string that uniquely identifies the DMS
resource to list tags for. This returns a list of keys (names of tags)
created for the resource and their associated tag values.
$sel:resourceArnList:ListTagsForResource'
, listTagsForResource_resourceArnList
- List of ARNs that identify multiple DMS resources that you want to list
tags for. This returns a list of keys (tag names) and their associated
tag values. It also returns each tag's associated ResourceArn
value,
which is the ARN of the resource for which each listed tag is created.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Constructors
ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tagList:ListTagsForResourceResponse'
, listTagsForResourceResponse_tagList
- A list of tags for the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
DescribeEndpointTypes (Paginated)
data DescribeEndpointTypes Source #
See: newDescribeEndpointTypes
smart constructor.
Instances
newDescribeEndpointTypes :: DescribeEndpointTypes Source #
Create a value of DescribeEndpointTypes
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:filters:DescribeEndpointTypes'
, describeEndpointTypes_filters
- Filters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
$sel:marker:DescribeEndpointTypes'
, describeEndpointTypes_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeEndpointTypes'
, describeEndpointTypes_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeEndpointTypesResponse Source #
See: newDescribeEndpointTypesResponse
smart constructor.
Constructors
DescribeEndpointTypesResponse' (Maybe [SupportedEndpointType]) (Maybe Text) Int |
Instances
newDescribeEndpointTypesResponse Source #
Create a value of DescribeEndpointTypesResponse
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:supportedEndpointTypes:DescribeEndpointTypesResponse'
, describeEndpointTypesResponse_supportedEndpointTypes
- The types of endpoints that are supported.
$sel:marker:DescribeEndpointTypes'
, describeEndpointTypesResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeEndpointTypesResponse'
, describeEndpointTypesResponse_httpStatus
- The response's http status code.
DeleteReplicationTask
data DeleteReplicationTask Source #
See: newDeleteReplicationTask
smart constructor.
Constructors
DeleteReplicationTask' Text |
Instances
newDeleteReplicationTask Source #
Create a value of DeleteReplicationTask
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:replicationTaskArn:DeleteReplicationTask'
, deleteReplicationTask_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task to be deleted.
data DeleteReplicationTaskResponse Source #
See: newDeleteReplicationTaskResponse
smart constructor.
Constructors
DeleteReplicationTaskResponse' (Maybe ReplicationTask) Int |
Instances
newDeleteReplicationTaskResponse Source #
Create a value of DeleteReplicationTaskResponse
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:replicationTask:DeleteReplicationTaskResponse'
, deleteReplicationTaskResponse_replicationTask
- The deleted replication task.
$sel:httpStatus:DeleteReplicationTaskResponse'
, deleteReplicationTaskResponse_httpStatus
- The response's http status code.
DescribeReplicationTaskAssessmentRuns
data DescribeReplicationTaskAssessmentRuns Source #
See: newDescribeReplicationTaskAssessmentRuns
smart constructor.
Instances
newDescribeReplicationTaskAssessmentRuns :: DescribeReplicationTaskAssessmentRuns Source #
Create a value of DescribeReplicationTaskAssessmentRuns
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:filters:DescribeReplicationTaskAssessmentRuns'
, describeReplicationTaskAssessmentRuns_filters
- Filters applied to the premigration assessment runs described in the
form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn
,
replication-task-arn
, replication-instance-arn
, status
$sel:marker:DescribeReplicationTaskAssessmentRuns'
, describeReplicationTaskAssessmentRuns_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeReplicationTaskAssessmentRuns'
, describeReplicationTaskAssessmentRuns_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
data DescribeReplicationTaskAssessmentRunsResponse Source #
See: newDescribeReplicationTaskAssessmentRunsResponse
smart constructor.
Constructors
DescribeReplicationTaskAssessmentRunsResponse' (Maybe [ReplicationTaskAssessmentRun]) (Maybe Text) Int |
Instances
newDescribeReplicationTaskAssessmentRunsResponse Source #
Arguments
:: Int |
|
-> DescribeReplicationTaskAssessmentRunsResponse |
Create a value of DescribeReplicationTaskAssessmentRunsResponse
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:replicationTaskAssessmentRuns:DescribeReplicationTaskAssessmentRunsResponse'
, describeReplicationTaskAssessmentRunsResponse_replicationTaskAssessmentRuns
- One or more premigration assessment runs as specified by Filters
.
$sel:marker:DescribeReplicationTaskAssessmentRuns'
, describeReplicationTaskAssessmentRunsResponse_marker
- A pagination token returned for you to pass to a subsequent request. If
you pass this token as the Marker
value in a subsequent request, the
response includes only records beyond the marker, up to the value
specified in the request by MaxRecords
.
$sel:httpStatus:DescribeReplicationTaskAssessmentRunsResponse'
, describeReplicationTaskAssessmentRunsResponse_httpStatus
- The response's http status code.
DescribeReplicationTaskAssessmentResults (Paginated)
data DescribeReplicationTaskAssessmentResults Source #
See: newDescribeReplicationTaskAssessmentResults
smart constructor.
Instances
newDescribeReplicationTaskAssessmentResults :: DescribeReplicationTaskAssessmentResults Source #
Create a value of DescribeReplicationTaskAssessmentResults
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:replicationTaskArn:DescribeReplicationTaskAssessmentResults'
, describeReplicationTaskAssessmentResults_replicationTaskArn
- The Amazon Resource Name (ARN) string that uniquely identifies the task.
When this input parameter is specified, the API returns only one result
and ignore the values of the MaxRecords
and Marker
parameters.
$sel:marker:DescribeReplicationTaskAssessmentResults'
, describeReplicationTaskAssessmentResults_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeReplicationTaskAssessmentResults'
, describeReplicationTaskAssessmentResults_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeReplicationTaskAssessmentResultsResponse Source #
See: newDescribeReplicationTaskAssessmentResultsResponse
smart constructor.
Constructors
DescribeReplicationTaskAssessmentResultsResponse' (Maybe Text) (Maybe Text) (Maybe [ReplicationTaskAssessmentResult]) Int |
Instances
newDescribeReplicationTaskAssessmentResultsResponse Source #
Arguments
:: Int |
|
-> DescribeReplicationTaskAssessmentResultsResponse |
Create a value of DescribeReplicationTaskAssessmentResultsResponse
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:bucketName:DescribeReplicationTaskAssessmentResultsResponse'
, describeReplicationTaskAssessmentResultsResponse_bucketName
- - The Amazon S3 bucket where the task assessment report is located.
$sel:marker:DescribeReplicationTaskAssessmentResults'
, describeReplicationTaskAssessmentResultsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:replicationTaskAssessmentResults:DescribeReplicationTaskAssessmentResultsResponse'
, describeReplicationTaskAssessmentResultsResponse_replicationTaskAssessmentResults
- The task assessment report.
$sel:httpStatus:DescribeReplicationTaskAssessmentResultsResponse'
, describeReplicationTaskAssessmentResultsResponse_httpStatus
- The response's http status code.
TestConnection
data TestConnection Source #
See: newTestConnection
smart constructor.
Constructors
TestConnection' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> TestConnection |
Create a value of TestConnection
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:replicationInstanceArn:TestConnection'
, testConnection_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
$sel:endpointArn:TestConnection'
, testConnection_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
data TestConnectionResponse Source #
See: newTestConnectionResponse
smart constructor.
Constructors
TestConnectionResponse' (Maybe Connection) Int |
Instances
newTestConnectionResponse Source #
Create a value of TestConnectionResponse
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:connection:TestConnectionResponse'
, testConnectionResponse_connection
- The connection tested.
$sel:httpStatus:TestConnectionResponse'
, testConnectionResponse_httpStatus
- The response's http status code.
DescribeConnections (Paginated)
data DescribeConnections Source #
See: newDescribeConnections
smart constructor.
Instances
newDescribeConnections :: DescribeConnections Source #
Create a value of DescribeConnections
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:filters:DescribeConnections'
, describeConnections_filters
- The filters applied to the connection.
Valid filter names: endpoint-arn | replication-instance-arn
$sel:marker:DescribeConnections'
, describeConnections_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeConnections'
, describeConnections_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeConnectionsResponse Source #
See: newDescribeConnectionsResponse
smart constructor.
Constructors
DescribeConnectionsResponse' (Maybe [Connection]) (Maybe Text) Int |
Instances
newDescribeConnectionsResponse Source #
Create a value of DescribeConnectionsResponse
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:connections:DescribeConnectionsResponse'
, describeConnectionsResponse_connections
- A description of the connections.
$sel:marker:DescribeConnections'
, describeConnectionsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeConnectionsResponse'
, describeConnectionsResponse_httpStatus
- The response's http status code.
MoveReplicationTask
data MoveReplicationTask Source #
See: newMoveReplicationTask
smart constructor.
Constructors
MoveReplicationTask' Text Text |
Instances
newMoveReplicationTask Source #
Arguments
:: Text | |
-> Text | |
-> MoveReplicationTask |
Create a value of MoveReplicationTask
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:replicationTaskArn:MoveReplicationTask'
, moveReplicationTask_replicationTaskArn
- The Amazon Resource Name (ARN) of the task that you want to move.
$sel:targetReplicationInstanceArn:MoveReplicationTask'
, moveReplicationTask_targetReplicationInstanceArn
- The ARN of the replication instance where you want to move the task to.
data MoveReplicationTaskResponse Source #
See: newMoveReplicationTaskResponse
smart constructor.
Constructors
MoveReplicationTaskResponse' (Maybe ReplicationTask) Int |
Instances
newMoveReplicationTaskResponse Source #
Create a value of MoveReplicationTaskResponse
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:replicationTask:MoveReplicationTaskResponse'
, moveReplicationTaskResponse_replicationTask
- The replication task that was moved.
$sel:httpStatus:MoveReplicationTaskResponse'
, moveReplicationTaskResponse_httpStatus
- The response's http status code.
RemoveTagsFromResource
data RemoveTagsFromResource Source #
Removes one or more tags from an DMS resource.
See: newRemoveTagsFromResource
smart constructor.
Constructors
RemoveTagsFromResource' Text [Text] |
Instances
newRemoveTagsFromResource Source #
Create a value of RemoveTagsFromResource
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:resourceArn:RemoveTagsFromResource'
, removeTagsFromResource_resourceArn
- An DMS resource from which you want to remove tag(s). The value for this
parameter is an Amazon Resource Name (ARN).
$sel:tagKeys:RemoveTagsFromResource'
, removeTagsFromResource_tagKeys
- The tag key (name) of the tag to be removed.
data RemoveTagsFromResourceResponse Source #
See: newRemoveTagsFromResourceResponse
smart constructor.
Constructors
RemoveTagsFromResourceResponse' Int |
Instances
newRemoveTagsFromResourceResponse Source #
Create a value of RemoveTagsFromResourceResponse
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:httpStatus:RemoveTagsFromResourceResponse'
, removeTagsFromResourceResponse_httpStatus
- The response's http status code.
ModifyEndpoint
data ModifyEndpoint Source #
See: newModifyEndpoint
smart constructor.
Constructors
Instances
Arguments
:: Text | |
-> ModifyEndpoint |
Create a value of ModifyEndpoint
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:dmsTransferSettings:ModifyEndpoint'
, modifyEndpoint_dmsTransferSettings
- The settings in JSON format for the DMS transfer type of source
endpoint.
Attributes include the following:
- serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the
service access IAM role. The role must allow the
iam:PassRole
action. - BucketName - The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string ,BucketName=string
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string"}
$sel:mySQLSettings:ModifyEndpoint'
, modifyEndpoint_mySQLSettings
- Settings in JSON format for the source and target MySQL endpoint. For
information about other available settings, see
Extra connection attributes when using MySQL as a source for DMS
and
Extra connection attributes when using a MySQL-compatible database as a target for DMS
in the Database Migration Service User Guide.
$sel:serverName:ModifyEndpoint'
, modifyEndpoint_serverName
- The name of the server where the endpoint database resides.
$sel:microsoftSQLServerSettings:ModifyEndpoint'
, modifyEndpoint_microsoftSQLServerSettings
- Settings in JSON format for the source and target Microsoft SQL Server
endpoint. For information about other available settings, see
Extra connection attributes when using SQL Server as a source for DMS
and
Extra connection attributes when using SQL Server as a target for DMS
in the Database Migration Service User Guide.
$sel:certificateArn:ModifyEndpoint'
, modifyEndpoint_certificateArn
- The Amazon Resource Name (ARN) of the certificate used for SSL
connection.
$sel:serviceAccessRoleArn:ModifyEndpoint'
, modifyEndpoint_serviceAccessRoleArn
- The Amazon Resource Name (ARN) for the IAM role you want to use to
modify the endpoint. The role must allow the iam:PassRole
action.
$sel:docDbSettings:ModifyEndpoint'
, modifyEndpoint_docDbSettings
- Settings in JSON format for the source DocumentDB endpoint. For more
information about the available settings, see the configuration
properties section in
Using DocumentDB as a Target for Database Migration Service
in the Database Migration Service User Guide.
$sel:postgreSQLSettings:ModifyEndpoint'
, modifyEndpoint_postgreSQLSettings
- Settings in JSON format for the source and target PostgreSQL endpoint.
For information about other available settings, see
Extra connection attributes when using PostgreSQL as a source for DMS
and
Extra connection attributes when using PostgreSQL as a target for DMS
in the Database Migration Service User Guide.
$sel:extraConnectionAttributes:ModifyEndpoint'
, modifyEndpoint_extraConnectionAttributes
- Additional attributes associated with the connection. To reset this
parameter, pass the empty string ("") as an argument.
$sel:kafkaSettings:ModifyEndpoint'
, modifyEndpoint_kafkaSettings
- Settings in JSON format for the target Apache Kafka endpoint. For more
information about the available settings, see
Using object mapping to migrate data to a Kafka topic
in the Database Migration Service User Guide.
$sel:oracleSettings:ModifyEndpoint'
, modifyEndpoint_oracleSettings
- Settings in JSON format for the source and target Oracle endpoint. For
information about other available settings, see
Extra connection attributes when using Oracle as a source for DMS
and
Extra connection attributes when using Oracle as a target for DMS
in the Database Migration Service User Guide.
$sel:endpointType:ModifyEndpoint'
, modifyEndpoint_endpointType
- The type of endpoint. Valid values are source
and target
.
$sel:redshiftSettings:ModifyEndpoint'
, modifyEndpoint_redshiftSettings
- Undocumented member.
$sel:elasticsearchSettings:ModifyEndpoint'
, modifyEndpoint_elasticsearchSettings
- Settings in JSON format for the target Elasticsearch endpoint. For more
information about the available settings, see
Extra Connection Attributes When Using Elasticsearch as a Target for DMS
in the Database Migration Service User Guide.
$sel:exactSettings:ModifyEndpoint'
, modifyEndpoint_exactSettings
- If this attribute is Y, the current call to ModifyEndpoint
replaces
all existing endpoint settings with the exact settings that you specify
in this call. If this attribute is N, the current call to
ModifyEndpoint
does two things:
- It replaces any endpoint settings that already exist with new values, for settings with the same names.
- It creates new endpoint settings that you specify in the call, for settings with different names.
For example, if you call
create-endpoint ... --endpoint-settings '{"a":1}' ...
, the
endpoint has the following endpoint settings: '{"a":1}'
. If you
then call modify-endpoint ... --endpoint-settings '{"b":2}' ...
for the same endpoint, the endpoint has the following settings:
'{"a":1,"b":2}'
.
However, suppose that you follow this with a call to
modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ...
for that same endpoint again. Then the endpoint has the following
settings: '{"b":2}'
. All existing settings are replaced with the
exact settings that you specify.
$sel:username:ModifyEndpoint'
, modifyEndpoint_username
- The user name to be used to login to the endpoint database.
$sel:externalTableDefinition:ModifyEndpoint'
, modifyEndpoint_externalTableDefinition
- The external table definition.
$sel:engineName:ModifyEndpoint'
, modifyEndpoint_engineName
- The type of engine for the endpoint. Valid values, depending on the
EndpointType, include "mysql"
, "oracle"
, "postgres"
,
"mariadb"
, "aurora"
, "aurora-postgresql"
, "redshift"
,
"s3"
, "db2"
, "azuredb"
, "sybase"
, "dynamodb"
,
"mongodb"
, "kinesis"
, "kafka"
, "elasticsearch"
,
"documentdb"
, "sqlserver"
, and "neptune"
.
$sel:redisSettings:ModifyEndpoint'
, modifyEndpoint_redisSettings
- Settings in JSON format for the Redis target endpoint.
$sel:neptuneSettings:ModifyEndpoint'
, modifyEndpoint_neptuneSettings
- Settings in JSON format for the target Amazon Neptune endpoint. For more
information about the available settings, see
Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target
in the Database Migration Service User Guide.
$sel:iBMDb2Settings:ModifyEndpoint'
, modifyEndpoint_iBMDb2Settings
- Settings in JSON format for the source IBM Db2 LUW endpoint. For
information about other available settings, see
Extra connection attributes when using Db2 LUW as a source for DMS
in the Database Migration Service User Guide.
$sel:mongoDbSettings:ModifyEndpoint'
, modifyEndpoint_mongoDbSettings
- Settings in JSON format for the source MongoDB endpoint. For more
information about the available settings, see the configuration
properties section in
Endpoint configuration settings when using MongoDB as a source for Database Migration Service
in the Database Migration Service User Guide.
$sel:sslMode:ModifyEndpoint'
, modifyEndpoint_sslMode
- The SSL mode used to connect to the endpoint. The default value is
none
.
$sel:password:ModifyEndpoint'
, modifyEndpoint_password
- The password to be used to login to the endpoint database.
$sel:sybaseSettings:ModifyEndpoint'
, modifyEndpoint_sybaseSettings
- Settings in JSON format for the source and target SAP ASE endpoint. For
information about other available settings, see
Extra connection attributes when using SAP ASE as a source for DMS
and
Extra connection attributes when using SAP ASE as a target for DMS
in the Database Migration Service User Guide.
$sel:databaseName:ModifyEndpoint'
, modifyEndpoint_databaseName
- The name of the endpoint database. For a MySQL source or target
endpoint, do not specify DatabaseName.
$sel:s3Settings:ModifyEndpoint'
, modifyEndpoint_s3Settings
- Settings in JSON format for the target Amazon S3 endpoint. For more
information about the available settings, see
Extra Connection Attributes When Using Amazon S3 as a Target for DMS
in the Database Migration Service User Guide.
$sel:kinesisSettings:ModifyEndpoint'
, modifyEndpoint_kinesisSettings
- Settings in JSON format for the target endpoint for Amazon Kinesis Data
Streams. For more information about the available settings, see
Using object mapping to migrate data to a Kinesis data stream
in the Database Migration Service User Guide.
$sel:endpointIdentifier:ModifyEndpoint'
, modifyEndpoint_endpointIdentifier
- The database endpoint identifier. Identifiers must begin with a letter
and must contain only ASCII letters, digits, and hyphens. They can't
end with a hyphen or contain two consecutive hyphens.
$sel:dynamoDbSettings:ModifyEndpoint'
, modifyEndpoint_dynamoDbSettings
- Settings in JSON format for the target Amazon DynamoDB endpoint. For
information about other available settings, see
Using Object Mapping to Migrate Data to DynamoDB
in the Database Migration Service User Guide.
$sel:port:ModifyEndpoint'
, modifyEndpoint_port
- The port used by the endpoint database.
$sel:endpointArn:ModifyEndpoint'
, modifyEndpoint_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
data ModifyEndpointResponse Source #
See: newModifyEndpointResponse
smart constructor.
Constructors
ModifyEndpointResponse' (Maybe Endpoint) Int |
Instances
newModifyEndpointResponse Source #
Create a value of ModifyEndpointResponse
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:endpoint:ModifyEndpointResponse'
, modifyEndpointResponse_endpoint
- The modified endpoint.
$sel:httpStatus:ModifyEndpointResponse'
, modifyEndpointResponse_httpStatus
- The response's http status code.
CreateEventSubscription
data CreateEventSubscription Source #
See: newCreateEventSubscription
smart constructor.
Constructors
CreateEventSubscription' (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe [Tag]) Text Text |
Instances
newCreateEventSubscription Source #
Arguments
:: Text | |
-> Text | |
-> CreateEventSubscription |
Create a value of CreateEventSubscription
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:enabled:CreateEventSubscription'
, createEventSubscription_enabled
- A Boolean value; set to true
to activate the subscription, or set to
false
to create the subscription but not activate it.
$sel:sourceType:CreateEventSubscription'
, createEventSubscription_sourceType
- The type of DMS resource that generates the events. For example, if you
want to be notified of events generated by a replication instance, you
set this parameter to replication-instance
. If this value isn't
specified, all events are returned.
Valid values: replication-instance
| replication-task
$sel:eventCategories:CreateEventSubscription'
, createEventSubscription_eventCategories
- A list of event categories for a source type that you want to subscribe
to. For more information, see
Working with Events and Notifications
in the Database Migration Service User Guide.
$sel:sourceIds:CreateEventSubscription'
, createEventSubscription_sourceIds
- A list of identifiers for which DMS provides notification events.
If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
$sel:tags:CreateEventSubscription'
, createEventSubscription_tags
- One or more tags to be assigned to the event subscription.
$sel:subscriptionName:CreateEventSubscription'
, createEventSubscription_subscriptionName
- The name of the DMS event notification subscription. This name must be
less than 255 characters.
$sel:snsTopicArn:CreateEventSubscription'
, createEventSubscription_snsTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic
and subscribe to it.
data CreateEventSubscriptionResponse Source #
See: newCreateEventSubscriptionResponse
smart constructor.
Constructors
CreateEventSubscriptionResponse' (Maybe EventSubscription) Int |
Instances
newCreateEventSubscriptionResponse Source #
Create a value of CreateEventSubscriptionResponse
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:eventSubscription:CreateEventSubscriptionResponse'
, createEventSubscriptionResponse_eventSubscription
- The event subscription that was created.
$sel:httpStatus:CreateEventSubscriptionResponse'
, createEventSubscriptionResponse_httpStatus
- The response's http status code.
DescribeEndpointSettings
data DescribeEndpointSettings Source #
See: newDescribeEndpointSettings
smart constructor.
Instances
newDescribeEndpointSettings Source #
Create a value of DescribeEndpointSettings
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:marker:DescribeEndpointSettings'
, describeEndpointSettings_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeEndpointSettings'
, describeEndpointSettings_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
$sel:engineName:DescribeEndpointSettings'
, describeEndpointSettings_engineName
- The databse engine used for your source or target endpoint.
data DescribeEndpointSettingsResponse Source #
See: newDescribeEndpointSettingsResponse
smart constructor.
Constructors
DescribeEndpointSettingsResponse' (Maybe [EndpointSetting]) (Maybe Text) Int |
Instances
newDescribeEndpointSettingsResponse Source #
Create a value of DescribeEndpointSettingsResponse
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:endpointSettings:DescribeEndpointSettingsResponse'
, describeEndpointSettingsResponse_endpointSettings
- Descriptions of the endpoint settings available for your source or
target database engine.
$sel:marker:DescribeEndpointSettings'
, describeEndpointSettingsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeEndpointSettingsResponse'
, describeEndpointSettingsResponse_httpStatus
- The response's http status code.
DescribeCertificates (Paginated)
data DescribeCertificates Source #
See: newDescribeCertificates
smart constructor.
Instances
newDescribeCertificates :: DescribeCertificates Source #
Create a value of DescribeCertificates
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:filters:DescribeCertificates'
, describeCertificates_filters
- Filters applied to the certificates described in the form of key-value
pairs.
$sel:marker:DescribeCertificates'
, describeCertificates_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeCertificates'
, describeCertificates_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 10
data DescribeCertificatesResponse Source #
See: newDescribeCertificatesResponse
smart constructor.
Constructors
DescribeCertificatesResponse' (Maybe [Certificate]) (Maybe Text) Int |
Instances
newDescribeCertificatesResponse Source #
Create a value of DescribeCertificatesResponse
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:certificates:DescribeCertificatesResponse'
, describeCertificatesResponse_certificates
- The Secure Sockets Layer (SSL) certificates associated with the
replication instance.
$sel:marker:DescribeCertificates'
, describeCertificatesResponse_marker
- The pagination token.
$sel:httpStatus:DescribeCertificatesResponse'
, describeCertificatesResponse_httpStatus
- The response's http status code.
StartReplicationTaskAssessmentRun
data StartReplicationTaskAssessmentRun Source #
See: newStartReplicationTaskAssessmentRun
smart constructor.
Constructors
StartReplicationTaskAssessmentRun' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Text Text Text Text |
Instances
newStartReplicationTaskAssessmentRun Source #
Arguments
:: Text | |
-> Text |
|
-> Text |
|
-> Text | |
-> StartReplicationTaskAssessmentRun |
Create a value of StartReplicationTaskAssessmentRun
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:includeOnly:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_includeOnly
- Space-separated list of names for specific individual assessments that
you want to include. These names come from the default list of
individual assessments that DMS supports for the associated migration
task. This task is specified by ReplicationTaskArn
.
You can't set a value for IncludeOnly
if you also set a value for
Exclude
in the API operation.
To identify the names of the default individual assessments that DMS
supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its own
ReplicationTaskArn
request parameter.
$sel:resultKmsKeyArn:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_resultKmsKeyArn
- ARN of a custom KMS encryption key that you specify when you set
ResultEncryptionMode
to "SSE_KMS
".
$sel:resultLocationFolder:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_resultLocationFolder
- Folder within an Amazon S3 bucket where you want DMS to store the
results of this assessment run.
$sel:resultEncryptionMode:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_resultEncryptionMode
- Encryption mode that you can specify to encrypt the results of this
assessment run. If you don't specify this request parameter, DMS stores
the assessment run results without encryption. You can specify one of
the options following:
"SSE_S3"
– The server-side encryption provided as a default by Amazon S3."SSE_KMS"
– Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
$sel:exclude:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_exclude
- Space-separated list of names for specific individual assessments that
you want to exclude. These names come from the default list of
individual assessments that DMS supports for the associated migration
task. This task is specified by ReplicationTaskArn
.
You can't set a value for Exclude
if you also set a value for
IncludeOnly
in the API operation.
To identify the names of the default individual assessments that DMS
supports for the associated migration task, run the
DescribeApplicableIndividualAssessments
operation using its own
ReplicationTaskArn
request parameter.
$sel:replicationTaskArn:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_replicationTaskArn
- Amazon Resource Name (ARN) of the migration task associated with the
premigration assessment run that you want to start.
$sel:serviceAccessRoleArn:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_serviceAccessRoleArn
- ARN of the service role needed to start the assessment run. The role
must allow the iam:PassRole
action.
$sel:resultLocationBucket:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_resultLocationBucket
- Amazon S3 bucket where you want DMS to store the results of this
assessment run.
$sel:assessmentRunName:StartReplicationTaskAssessmentRun'
, startReplicationTaskAssessmentRun_assessmentRunName
- Unique name to identify the assessment run.
data StartReplicationTaskAssessmentRunResponse Source #
See: newStartReplicationTaskAssessmentRunResponse
smart constructor.
Instances
newStartReplicationTaskAssessmentRunResponse Source #
Arguments
:: Int | |
-> StartReplicationTaskAssessmentRunResponse |
Create a value of StartReplicationTaskAssessmentRunResponse
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:replicationTaskAssessmentRun:StartReplicationTaskAssessmentRunResponse'
, startReplicationTaskAssessmentRunResponse_replicationTaskAssessmentRun
- The premigration assessment run that was started.
$sel:httpStatus:StartReplicationTaskAssessmentRunResponse'
, startReplicationTaskAssessmentRunResponse_httpStatus
- The response's http status code.
DeleteEventSubscription
data DeleteEventSubscription Source #
See: newDeleteEventSubscription
smart constructor.
Constructors
DeleteEventSubscription' Text |
Instances
newDeleteEventSubscription Source #
Create a value of DeleteEventSubscription
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:subscriptionName:DeleteEventSubscription'
, deleteEventSubscription_subscriptionName
- The name of the DMS event notification subscription to be deleted.
data DeleteEventSubscriptionResponse Source #
See: newDeleteEventSubscriptionResponse
smart constructor.
Constructors
DeleteEventSubscriptionResponse' (Maybe EventSubscription) Int |
Instances
newDeleteEventSubscriptionResponse Source #
Create a value of DeleteEventSubscriptionResponse
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:eventSubscription:DeleteEventSubscriptionResponse'
, deleteEventSubscriptionResponse_eventSubscription
- The event subscription that was deleted.
$sel:httpStatus:DeleteEventSubscriptionResponse'
, deleteEventSubscriptionResponse_httpStatus
- The response's http status code.
DescribeTableStatistics (Paginated)
data DescribeTableStatistics Source #
See: newDescribeTableStatistics
smart constructor.
Instances
newDescribeTableStatistics Source #
Create a value of DescribeTableStatistics
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:filters:DescribeTableStatistics'
, describeTableStatistics_filters
- Filters applied to table statistics.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
$sel:marker:DescribeTableStatistics'
, describeTableStatistics_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeTableStatistics'
, describeTableStatistics_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 500.
$sel:replicationTaskArn:DescribeTableStatistics'
, describeTableStatistics_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
data DescribeTableStatisticsResponse Source #
See: newDescribeTableStatisticsResponse
smart constructor.
Constructors
DescribeTableStatisticsResponse' (Maybe Text) (Maybe Text) (Maybe [TableStatistics]) Int |
Instances
newDescribeTableStatisticsResponse Source #
Create a value of DescribeTableStatisticsResponse
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:replicationTaskArn:DescribeTableStatistics'
, describeTableStatisticsResponse_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
$sel:marker:DescribeTableStatistics'
, describeTableStatisticsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:tableStatistics:DescribeTableStatisticsResponse'
, describeTableStatisticsResponse_tableStatistics
- The table statistics.
$sel:httpStatus:DescribeTableStatisticsResponse'
, describeTableStatisticsResponse_httpStatus
- The response's http status code.
DescribeReplicationSubnetGroups (Paginated)
data DescribeReplicationSubnetGroups Source #
See: newDescribeReplicationSubnetGroups
smart constructor.
Instances
newDescribeReplicationSubnetGroups :: DescribeReplicationSubnetGroups Source #
Create a value of DescribeReplicationSubnetGroups
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:filters:DescribeReplicationSubnetGroups'
, describeReplicationSubnetGroups_filters
- Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
$sel:marker:DescribeReplicationSubnetGroups'
, describeReplicationSubnetGroups_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeReplicationSubnetGroups'
, describeReplicationSubnetGroups_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeReplicationSubnetGroupsResponse Source #
See: newDescribeReplicationSubnetGroupsResponse
smart constructor.
Constructors
DescribeReplicationSubnetGroupsResponse' (Maybe Text) (Maybe [ReplicationSubnetGroup]) Int |
Instances
newDescribeReplicationSubnetGroupsResponse Source #
Arguments
:: Int | |
-> DescribeReplicationSubnetGroupsResponse |
Create a value of DescribeReplicationSubnetGroupsResponse
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:marker:DescribeReplicationSubnetGroups'
, describeReplicationSubnetGroupsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:replicationSubnetGroups:DescribeReplicationSubnetGroupsResponse'
, describeReplicationSubnetGroupsResponse_replicationSubnetGroups
- A description of the replication subnet groups.
$sel:httpStatus:DescribeReplicationSubnetGroupsResponse'
, describeReplicationSubnetGroupsResponse_httpStatus
- The response's http status code.
StartReplicationTask
data StartReplicationTask Source #
See: newStartReplicationTask
smart constructor.
Constructors
StartReplicationTask' (Maybe Text) (Maybe Text) (Maybe POSIX) Text StartReplicationTaskTypeValue |
Instances
newStartReplicationTask Source #
Arguments
:: Text | |
-> StartReplicationTaskTypeValue | |
-> StartReplicationTask |
Create a value of StartReplicationTask
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:cdcStartPosition:StartReplicationTask'
, startReplicationTask_cdcStartPosition
- Indicates when you want a change data capture (CDC) operation to start.
Use either CdcStartPosition or CdcStartTime to specify when you want a
CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:187600#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a
logical replication slot should already be created and associated with
the source endpoint. You can verify this by setting the slotName
extra
connection attribute to the name of this logical replication slot. For
more information, see
Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
$sel:cdcStopPosition:StartReplicationTask'
, startReplicationTask_cdcStopPosition
- Indicates when you want a change data capture (CDC) operation to stop.
The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
$sel:cdcStartTime:StartReplicationTask'
, startReplicationTask_cdcStartTime
- Indicates the start time for a change data capture (CDC) operation. Use
either CdcStartTime or CdcStartPosition to specify when you want a CDC
operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
$sel:replicationTaskArn:StartReplicationTask'
, startReplicationTask_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task to be started.
$sel:startReplicationTaskType:StartReplicationTask'
, startReplicationTask_startReplicationTaskType
- A type of replication task.
data StartReplicationTaskResponse Source #
See: newStartReplicationTaskResponse
smart constructor.
Constructors
StartReplicationTaskResponse' (Maybe ReplicationTask) Int |
Instances
newStartReplicationTaskResponse Source #
Create a value of StartReplicationTaskResponse
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:replicationTask:StartReplicationTaskResponse'
, startReplicationTaskResponse_replicationTask
- The replication task started.
$sel:httpStatus:StartReplicationTaskResponse'
, startReplicationTaskResponse_httpStatus
- The response's http status code.
DescribeEventSubscriptions (Paginated)
data DescribeEventSubscriptions Source #
See: newDescribeEventSubscriptions
smart constructor.
Instances
newDescribeEventSubscriptions :: DescribeEventSubscriptions Source #
Create a value of DescribeEventSubscriptions
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:subscriptionName:DescribeEventSubscriptions'
, describeEventSubscriptions_subscriptionName
- The name of the DMS event subscription to be described.
$sel:filters:DescribeEventSubscriptions'
, describeEventSubscriptions_filters
- Filters applied to event subscriptions.
$sel:marker:DescribeEventSubscriptions'
, describeEventSubscriptions_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeEventSubscriptions'
, describeEventSubscriptions_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeEventSubscriptionsResponse Source #
See: newDescribeEventSubscriptionsResponse
smart constructor.
Constructors
DescribeEventSubscriptionsResponse' (Maybe [EventSubscription]) (Maybe Text) Int |
Instances
newDescribeEventSubscriptionsResponse Source #
Arguments
:: Int | |
-> DescribeEventSubscriptionsResponse |
Create a value of DescribeEventSubscriptionsResponse
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:eventSubscriptionsList:DescribeEventSubscriptionsResponse'
, describeEventSubscriptionsResponse_eventSubscriptionsList
- A list of event subscriptions.
$sel:marker:DescribeEventSubscriptions'
, describeEventSubscriptionsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeEventSubscriptionsResponse'
, describeEventSubscriptionsResponse_httpStatus
- The response's http status code.
AddTagsToResource
data AddTagsToResource Source #
Associates a set of tags with an DMS resource.
See: newAddTagsToResource
smart constructor.
Constructors
AddTagsToResource' Text [Tag] |
Instances
Arguments
:: Text | |
-> AddTagsToResource |
Create a value of AddTagsToResource
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:resourceArn:AddTagsToResource'
, addTagsToResource_resourceArn
- Identifies the DMS resource to which tags should be added. The value for
this parameter is an Amazon Resource Name (ARN).
For DMS, you can tag a replication instance, an endpoint, or a replication task.
$sel:tags:AddTagsToResource'
, addTagsToResource_tags
- One or more tags to be assigned to the resource.
data AddTagsToResourceResponse Source #
See: newAddTagsToResourceResponse
smart constructor.
Constructors
AddTagsToResourceResponse' Int |
Instances
newAddTagsToResourceResponse Source #
Create a value of AddTagsToResourceResponse
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:httpStatus:AddTagsToResourceResponse'
, addTagsToResourceResponse_httpStatus
- The response's http status code.
CreateReplicationSubnetGroup
data CreateReplicationSubnetGroup Source #
See: newCreateReplicationSubnetGroup
smart constructor.
Instances
newCreateReplicationSubnetGroup Source #
Arguments
:: Text |
|
-> Text |
|
-> CreateReplicationSubnetGroup |
Create a value of CreateReplicationSubnetGroup
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:tags:CreateReplicationSubnetGroup'
, createReplicationSubnetGroup_tags
- One or more tags to be assigned to the subnet group.
$sel:replicationSubnetGroupIdentifier:CreateReplicationSubnetGroup'
, createReplicationSubnetGroup_replicationSubnetGroupIdentifier
- The name for the replication subnet group. This value is stored as a
lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".
Example: mySubnetgroup
$sel:replicationSubnetGroupDescription:CreateReplicationSubnetGroup'
, createReplicationSubnetGroup_replicationSubnetGroupDescription
- The description for the subnet group.
$sel:subnetIds:CreateReplicationSubnetGroup'
, createReplicationSubnetGroup_subnetIds
- One or more subnet IDs to be assigned to the subnet group.
data CreateReplicationSubnetGroupResponse Source #
See: newCreateReplicationSubnetGroupResponse
smart constructor.
Constructors
CreateReplicationSubnetGroupResponse' (Maybe ReplicationSubnetGroup) Int |
Instances
newCreateReplicationSubnetGroupResponse Source #
Arguments
:: Int | |
-> CreateReplicationSubnetGroupResponse |
Create a value of CreateReplicationSubnetGroupResponse
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:replicationSubnetGroup:CreateReplicationSubnetGroupResponse'
, createReplicationSubnetGroupResponse_replicationSubnetGroup
- The replication subnet group that was created.
$sel:httpStatus:CreateReplicationSubnetGroupResponse'
, createReplicationSubnetGroupResponse_httpStatus
- The response's http status code.
DescribeApplicableIndividualAssessments
data DescribeApplicableIndividualAssessments Source #
See: newDescribeApplicableIndividualAssessments
smart constructor.
Constructors
DescribeApplicableIndividualAssessments' (Maybe MigrationTypeValue) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newDescribeApplicableIndividualAssessments :: DescribeApplicableIndividualAssessments Source #
Create a value of DescribeApplicableIndividualAssessments
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:migrationType:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessments_migrationType
- Name of the migration type that each provided individual assessment must
support.
$sel:sourceEngineName:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessments_sourceEngineName
- Name of a database engine that the specified replication instance
supports as a source.
$sel:replicationTaskArn:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessments_replicationTaskArn
- Amazon Resource Name (ARN) of a migration task on which you want to base
the default list of individual assessments.
$sel:marker:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessments_marker
- Optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessments_maxRecords
- Maximum number of records to include in the response. If more records
exist than the specified MaxRecords
value, a pagination token called a
marker is included in the response so that the remaining results can be
retrieved.
$sel:targetEngineName:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessments_targetEngineName
- Name of a database engine that the specified replication instance
supports as a target.
$sel:replicationInstanceArn:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessments_replicationInstanceArn
- ARN of a replication instance on which you want to base the default list
of individual assessments.
data DescribeApplicableIndividualAssessmentsResponse Source #
See: newDescribeApplicableIndividualAssessmentsResponse
smart constructor.
Instances
newDescribeApplicableIndividualAssessmentsResponse Source #
Arguments
:: Int |
|
-> DescribeApplicableIndividualAssessmentsResponse |
Create a value of DescribeApplicableIndividualAssessmentsResponse
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:marker:DescribeApplicableIndividualAssessments'
, describeApplicableIndividualAssessmentsResponse_marker
- Pagination token returned for you to pass to a subsequent request. If
you pass this token as the Marker
value in a subsequent request, the
response includes only records beyond the marker, up to the value
specified in the request by MaxRecords
.
$sel:individualAssessmentNames:DescribeApplicableIndividualAssessmentsResponse'
, describeApplicableIndividualAssessmentsResponse_individualAssessmentNames
- List of names for the individual assessments supported by the
premigration assessment run that you start based on the specified
request parameters. For more information on the available individual
assessments, including compatibility with different migration task
configurations, see
Working with premigration assessment runs
in the Database Migration Service User Guide.
$sel:httpStatus:DescribeApplicableIndividualAssessmentsResponse'
, describeApplicableIndividualAssessmentsResponse_httpStatus
- The response's http status code.
DeleteCertificate
data DeleteCertificate Source #
See: newDeleteCertificate
smart constructor.
Constructors
DeleteCertificate' Text |
Instances
Arguments
:: Text | |
-> DeleteCertificate |
Create a value of DeleteCertificate
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:certificateArn:DeleteCertificate'
, deleteCertificate_certificateArn
- The Amazon Resource Name (ARN) of the deleted certificate.
data DeleteCertificateResponse Source #
See: newDeleteCertificateResponse
smart constructor.
Constructors
DeleteCertificateResponse' (Maybe Certificate) Int |
Instances
newDeleteCertificateResponse Source #
Create a value of DeleteCertificateResponse
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:certificate:DeleteCertificateResponse'
, deleteCertificateResponse_certificate
- The Secure Sockets Layer (SSL) certificate.
$sel:httpStatus:DeleteCertificateResponse'
, deleteCertificateResponse_httpStatus
- The response's http status code.
RefreshSchemas
data RefreshSchemas Source #
See: newRefreshSchemas
smart constructor.
Constructors
RefreshSchemas' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> RefreshSchemas |
Create a value of RefreshSchemas
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:endpointArn:RefreshSchemas'
, refreshSchemas_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
$sel:replicationInstanceArn:RefreshSchemas'
, refreshSchemas_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
data RefreshSchemasResponse Source #
See: newRefreshSchemasResponse
smart constructor.
Constructors
RefreshSchemasResponse' (Maybe RefreshSchemasStatus) Int |
Instances
newRefreshSchemasResponse Source #
Create a value of RefreshSchemasResponse
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:refreshSchemasStatus:RefreshSchemasResponse'
, refreshSchemasResponse_refreshSchemasStatus
- The status of the refreshed schema.
$sel:httpStatus:RefreshSchemasResponse'
, refreshSchemasResponse_httpStatus
- The response's http status code.
DescribeReplicationTasks (Paginated)
data DescribeReplicationTasks Source #
See: newDescribeReplicationTasks
smart constructor.
Instances
newDescribeReplicationTasks :: DescribeReplicationTasks Source #
Create a value of DescribeReplicationTasks
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:filters:DescribeReplicationTasks'
, describeReplicationTasks_filters
- Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
$sel:withoutSettings:DescribeReplicationTasks'
, describeReplicationTasks_withoutSettings
- An option to set to avoid returning information about settings. Use this
to reduce overhead when setting information is too large. To use this
option, choose true
; otherwise, choose false
(the default).
$sel:marker:DescribeReplicationTasks'
, describeReplicationTasks_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeReplicationTasks'
, describeReplicationTasks_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeReplicationTasksResponse Source #
See: newDescribeReplicationTasksResponse
smart constructor.
Constructors
DescribeReplicationTasksResponse' (Maybe [ReplicationTask]) (Maybe Text) Int |
Instances
newDescribeReplicationTasksResponse Source #
Create a value of DescribeReplicationTasksResponse
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:replicationTasks:DescribeReplicationTasksResponse'
, describeReplicationTasksResponse_replicationTasks
- A description of the replication tasks.
$sel:marker:DescribeReplicationTasks'
, describeReplicationTasksResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribeReplicationTasksResponse'
, describeReplicationTasksResponse_httpStatus
- The response's http status code.
DescribeEventCategories
data DescribeEventCategories Source #
See: newDescribeEventCategories
smart constructor.
Constructors
DescribeEventCategories' (Maybe Text) (Maybe [Filter]) |
Instances
newDescribeEventCategories :: DescribeEventCategories Source #
Create a value of DescribeEventCategories
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:sourceType:DescribeEventCategories'
, describeEventCategories_sourceType
- The type of DMS resource that generates events.
Valid values: replication-instance | replication-task
$sel:filters:DescribeEventCategories'
, describeEventCategories_filters
- Filters applied to the event categories.
data DescribeEventCategoriesResponse Source #
See: newDescribeEventCategoriesResponse
smart constructor.
Constructors
DescribeEventCategoriesResponse' (Maybe [EventCategoryGroup]) Int |
Instances
newDescribeEventCategoriesResponse Source #
Create a value of DescribeEventCategoriesResponse
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:eventCategoryGroupList:DescribeEventCategoriesResponse'
, describeEventCategoriesResponse_eventCategoryGroupList
- A list of event categories.
$sel:httpStatus:DescribeEventCategoriesResponse'
, describeEventCategoriesResponse_httpStatus
- The response's http status code.
DescribeOrderableReplicationInstances (Paginated)
data DescribeOrderableReplicationInstances Source #
See: newDescribeOrderableReplicationInstances
smart constructor.
Constructors
DescribeOrderableReplicationInstances' (Maybe Text) (Maybe Int) |
Instances
newDescribeOrderableReplicationInstances :: DescribeOrderableReplicationInstances Source #
Create a value of DescribeOrderableReplicationInstances
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:marker:DescribeOrderableReplicationInstances'
, describeOrderableReplicationInstances_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeOrderableReplicationInstances'
, describeOrderableReplicationInstances_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeOrderableReplicationInstancesResponse Source #
See: newDescribeOrderableReplicationInstancesResponse
smart constructor.
Constructors
DescribeOrderableReplicationInstancesResponse' (Maybe Text) (Maybe [OrderableReplicationInstance]) Int |
Instances
newDescribeOrderableReplicationInstancesResponse Source #
Arguments
:: Int |
|
-> DescribeOrderableReplicationInstancesResponse |
Create a value of DescribeOrderableReplicationInstancesResponse
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:marker:DescribeOrderableReplicationInstances'
, describeOrderableReplicationInstancesResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:orderableReplicationInstances:DescribeOrderableReplicationInstancesResponse'
, describeOrderableReplicationInstancesResponse_orderableReplicationInstances
- The order-able replication instances available.
$sel:httpStatus:DescribeOrderableReplicationInstancesResponse'
, describeOrderableReplicationInstancesResponse_httpStatus
- The response's http status code.
DescribePendingMaintenanceActions
data DescribePendingMaintenanceActions Source #
See: newDescribePendingMaintenanceActions
smart constructor.
Constructors
DescribePendingMaintenanceActions' (Maybe [Filter]) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newDescribePendingMaintenanceActions :: DescribePendingMaintenanceActions Source #
Create a value of DescribePendingMaintenanceActions
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:filters:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_filters
-
$sel:marker:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
$sel:replicationInstanceArn:DescribePendingMaintenanceActions'
, describePendingMaintenanceActions_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
data DescribePendingMaintenanceActionsResponse Source #
See: newDescribePendingMaintenanceActionsResponse
smart constructor.
Constructors
DescribePendingMaintenanceActionsResponse' (Maybe [ResourcePendingMaintenanceActions]) (Maybe Text) Int |
Instances
newDescribePendingMaintenanceActionsResponse Source #
Arguments
:: Int | |
-> DescribePendingMaintenanceActionsResponse |
Create a value of DescribePendingMaintenanceActionsResponse
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:pendingMaintenanceActions:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_pendingMaintenanceActions
- The pending maintenance action.
$sel:marker:DescribePendingMaintenanceActions'
, describePendingMaintenanceActionsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:httpStatus:DescribePendingMaintenanceActionsResponse'
, describePendingMaintenanceActionsResponse_httpStatus
- The response's http status code.
CreateReplicationTask
data CreateReplicationTask Source #
See: newCreateReplicationTask
smart constructor.
Constructors
CreateReplicationTask' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe POSIX) Text Text Text Text MigrationTypeValue Text |
Instances
newCreateReplicationTask Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> MigrationTypeValue | |
-> Text | |
-> CreateReplicationTask |
Create a value of CreateReplicationTask
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:replicationTaskSettings:CreateReplicationTask'
, createReplicationTask_replicationTaskSettings
- Overall settings for the task, in JSON format. For more information, see
Specifying Task Settings for Database Migration Service Tasks
in the Database Migration Service User Guide.
$sel:cdcStartPosition:CreateReplicationTask'
, createReplicationTask_cdcStartPosition
- Indicates when you want a change data capture (CDC) operation to start.
Use either CdcStartPosition or CdcStartTime to specify when you want a
CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:187600#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a
logical replication slot should already be created and associated with
the source endpoint. You can verify this by setting the slotName
extra
connection attribute to the name of this logical replication slot. For
more information, see
Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
$sel:taskData:CreateReplicationTask'
, createReplicationTask_taskData
- Supplemental information that the task requires to migrate the data for
certain source and target endpoints. For more information, see
Specifying Supplemental Data for Task Settings
in the Database Migration Service User Guide.
$sel:cdcStopPosition:CreateReplicationTask'
, createReplicationTask_cdcStopPosition
- Indicates when you want a change data capture (CDC) operation to stop.
The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
$sel:resourceIdentifier:CreateReplicationTask'
, createReplicationTask_resourceIdentifier
- A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the created
Endpoint
object. The value for this parameter can have up to 31
characters. It can contain only ASCII letters, digits, and hyphen
('-'). Also, it can't end with a hyphen or contain two consecutive
hyphens, and can only begin with a letter, such as Example-App-ARN1
.
For example, this value might result in the EndpointArn
value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't
specify a ResourceIdentifier
value, DMS generates a default identifier
value for the end of EndpointArn
.
$sel:tags:CreateReplicationTask'
, createReplicationTask_tags
- One or more tags to be assigned to the replication task.
$sel:cdcStartTime:CreateReplicationTask'
, createReplicationTask_cdcStartTime
- Indicates the start time for a change data capture (CDC) operation. Use
either CdcStartTime or CdcStartPosition to specify when you want a CDC
operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
$sel:replicationTaskIdentifier:CreateReplicationTask'
, createReplicationTask_replicationTaskIdentifier
- An identifier for the replication task.
Constraints:
- Must contain 1-255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
$sel:sourceEndpointArn:CreateReplicationTask'
, createReplicationTask_sourceEndpointArn
- An Amazon Resource Name (ARN) that uniquely identifies the source
endpoint.
$sel:targetEndpointArn:CreateReplicationTask'
, createReplicationTask_targetEndpointArn
- An Amazon Resource Name (ARN) that uniquely identifies the target
endpoint.
$sel:replicationInstanceArn:CreateReplicationTask'
, createReplicationTask_replicationInstanceArn
- The Amazon Resource Name (ARN) of a replication instance.
$sel:migrationType:CreateReplicationTask'
, createReplicationTask_migrationType
- The migration type. Valid values: full-load
| cdc
|
full-load-and-cdc
$sel:tableMappings:CreateReplicationTask'
, createReplicationTask_tableMappings
- The table mappings for the task, in JSON format. For more information,
see
Using Table Mapping to Specify Task Settings
in the Database Migration Service User Guide.
data CreateReplicationTaskResponse Source #
See: newCreateReplicationTaskResponse
smart constructor.
Constructors
CreateReplicationTaskResponse' (Maybe ReplicationTask) Int |
Instances
newCreateReplicationTaskResponse Source #
Create a value of CreateReplicationTaskResponse
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:replicationTask:CreateReplicationTaskResponse'
, createReplicationTaskResponse_replicationTask
- The replication task that was created.
$sel:httpStatus:CreateReplicationTaskResponse'
, createReplicationTaskResponse_httpStatus
- The response's http status code.
DescribeEndpoints (Paginated)
data DescribeEndpoints Source #
See: newDescribeEndpoints
smart constructor.
Instances
newDescribeEndpoints :: DescribeEndpoints Source #
Create a value of DescribeEndpoints
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:filters:DescribeEndpoints'
, describeEndpoints_filters
- Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
$sel:marker:DescribeEndpoints'
, describeEndpoints_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeEndpoints'
, describeEndpoints_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeEndpointsResponse Source #
See: newDescribeEndpointsResponse
smart constructor.
Instances
newDescribeEndpointsResponse Source #
Create a value of DescribeEndpointsResponse
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:marker:DescribeEndpoints'
, describeEndpointsResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:endpoints:DescribeEndpointsResponse'
, describeEndpointsResponse_endpoints
- Endpoint description.
$sel:httpStatus:DescribeEndpointsResponse'
, describeEndpointsResponse_httpStatus
- The response's http status code.
ModifyReplicationInstance
data ModifyReplicationInstance Source #
See: newModifyReplicationInstance
smart constructor.
Constructors
ModifyReplicationInstance' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) Text |
Instances
newModifyReplicationInstance Source #
Create a value of ModifyReplicationInstance
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:engineVersion:ModifyReplicationInstance'
, modifyReplicationInstance_engineVersion
- The engine version number of the replication instance.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgrade
to true
.
$sel:autoMinorVersionUpgrade:ModifyReplicationInstance'
, modifyReplicationInstance_autoMinorVersionUpgrade
- A value that indicates that minor version upgrades are applied
automatically to the replication instance during the maintenance window.
Changing this parameter doesn't result in an outage, except in the case
described following. The change is asynchronously applied as soon as
possible.
An outage does result if these factors apply:
- This parameter is set to
true
during the maintenance window. - A newer minor version is available.
- DMS has enabled automatic patching for the given engine version.
$sel:allowMajorVersionUpgrade:ModifyReplicationInstance'
, modifyReplicationInstance_allowMajorVersionUpgrade
- Indicates that major version upgrades are allowed. Changing this
parameter does not result in an outage, and the change is asynchronously
applied as soon as possible.
This parameter must be set to true
when specifying a value for the
EngineVersion
parameter that is a different major version than the
replication instance's current version.
$sel:preferredMaintenanceWindow:ModifyReplicationInstance'
, modifyReplicationInstance_preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur, which might result in an outage. Changing this parameter does not
result in an outage, except in the following situation, and the change
is asynchronously applied as soon as possible. If moving this window to
the current time, there must be at least 30 minutes between the current
time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
$sel:vpcSecurityGroupIds:ModifyReplicationInstance'
, modifyReplicationInstance_vpcSecurityGroupIds
- Specifies the VPC security group to be used with the replication
instance. The VPC security group must work with the VPC containing the
replication instance.
$sel:multiAZ:ModifyReplicationInstance'
, modifyReplicationInstance_multiAZ
- Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone
parameter if the Multi-AZ parameter is
set to true
.
$sel:allocatedStorage:ModifyReplicationInstance'
, modifyReplicationInstance_allocatedStorage
- The amount of storage (in gigabytes) to be allocated for the replication
instance.
$sel:applyImmediately:ModifyReplicationInstance'
, modifyReplicationInstance_applyImmediately
- Indicates whether the changes should be applied immediately or during
the next maintenance window.
$sel:replicationInstanceClass:ModifyReplicationInstance'
, modifyReplicationInstance_replicationInstanceClass
- The compute and memory capacity of the replication instance as defined
for the specified replication instance class. For example to specify the
instance class dms.c4.large, set this parameter to "dms.c4.large"
.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
$sel:replicationInstanceIdentifier:ModifyReplicationInstance'
, modifyReplicationInstance_replicationInstanceIdentifier
- The replication instance identifier. This parameter is stored as a
lowercase string.
$sel:replicationInstanceArn:ModifyReplicationInstance'
, modifyReplicationInstance_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
data ModifyReplicationInstanceResponse Source #
See: newModifyReplicationInstanceResponse
smart constructor.
Constructors
ModifyReplicationInstanceResponse' (Maybe ReplicationInstance) Int |
Instances
newModifyReplicationInstanceResponse Source #
Arguments
:: Int | |
-> ModifyReplicationInstanceResponse |
Create a value of ModifyReplicationInstanceResponse
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:replicationInstance:ModifyReplicationInstanceResponse'
, modifyReplicationInstanceResponse_replicationInstance
- The modified replication instance.
$sel:httpStatus:ModifyReplicationInstanceResponse'
, modifyReplicationInstanceResponse_httpStatus
- The response's http status code.
ImportCertificate
data ImportCertificate Source #
See: newImportCertificate
smart constructor.
Instances
Create a value of ImportCertificate
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:certificatePem:ImportCertificate'
, importCertificate_certificatePem
- The contents of a .pem
file, which contains an X.509 certificate.
$sel:certificateWallet:ImportCertificate'
, importCertificate_certificateWallet
- The location of an imported Oracle Wallet certificate for use with SSL.
Provide the name of a .sso
file using the fileb://
prefix. You
can't provide the certificate inline.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:tags:ImportCertificate'
, importCertificate_tags
- The tags associated with the certificate.
$sel:certificateIdentifier:ImportCertificate'
, importCertificate_certificateIdentifier
- A customer-assigned name for the certificate. Identifiers must begin
with a letter and must contain only ASCII letters, digits, and hyphens.
They can't end with a hyphen or contain two consecutive hyphens.
data ImportCertificateResponse Source #
See: newImportCertificateResponse
smart constructor.
Constructors
ImportCertificateResponse' (Maybe Certificate) Int |
Instances
newImportCertificateResponse Source #
Create a value of ImportCertificateResponse
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:certificate:ImportCertificateResponse'
, importCertificateResponse_certificate
- The certificate to be uploaded.
$sel:httpStatus:ImportCertificateResponse'
, importCertificateResponse_httpStatus
- The response's http status code.
CancelReplicationTaskAssessmentRun
data CancelReplicationTaskAssessmentRun Source #
See: newCancelReplicationTaskAssessmentRun
smart constructor.
Constructors
CancelReplicationTaskAssessmentRun' Text |
Instances
newCancelReplicationTaskAssessmentRun Source #
Arguments
:: Text |
|
-> CancelReplicationTaskAssessmentRun |
Create a value of CancelReplicationTaskAssessmentRun
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:replicationTaskAssessmentRunArn:CancelReplicationTaskAssessmentRun'
, cancelReplicationTaskAssessmentRun_replicationTaskAssessmentRunArn
- Amazon Resource Name (ARN) of the premigration assessment run to be
canceled.
data CancelReplicationTaskAssessmentRunResponse Source #
See: newCancelReplicationTaskAssessmentRunResponse
smart constructor.
Instances
newCancelReplicationTaskAssessmentRunResponse Source #
Arguments
:: Int | |
-> CancelReplicationTaskAssessmentRunResponse |
Create a value of CancelReplicationTaskAssessmentRunResponse
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:replicationTaskAssessmentRun:CancelReplicationTaskAssessmentRunResponse'
, cancelReplicationTaskAssessmentRunResponse_replicationTaskAssessmentRun
- The ReplicationTaskAssessmentRun
object for the canceled assessment
run.
$sel:httpStatus:CancelReplicationTaskAssessmentRunResponse'
, cancelReplicationTaskAssessmentRunResponse_httpStatus
- The response's http status code.
ModifyReplicationSubnetGroup
data ModifyReplicationSubnetGroup Source #
See: newModifyReplicationSubnetGroup
smart constructor.
Constructors
ModifyReplicationSubnetGroup' (Maybe Text) Text [Text] |
Instances
newModifyReplicationSubnetGroup Source #
Arguments
:: Text |
|
-> ModifyReplicationSubnetGroup |
Create a value of ModifyReplicationSubnetGroup
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:replicationSubnetGroupDescription:ModifyReplicationSubnetGroup'
, modifyReplicationSubnetGroup_replicationSubnetGroupDescription
- A description for the replication instance subnet group.
$sel:replicationSubnetGroupIdentifier:ModifyReplicationSubnetGroup'
, modifyReplicationSubnetGroup_replicationSubnetGroupIdentifier
- The name of the replication instance subnet group.
$sel:subnetIds:ModifyReplicationSubnetGroup'
, modifyReplicationSubnetGroup_subnetIds
- A list of subnet IDs.
data ModifyReplicationSubnetGroupResponse Source #
See: newModifyReplicationSubnetGroupResponse
smart constructor.
Constructors
ModifyReplicationSubnetGroupResponse' (Maybe ReplicationSubnetGroup) Int |
Instances
newModifyReplicationSubnetGroupResponse Source #
Arguments
:: Int | |
-> ModifyReplicationSubnetGroupResponse |
Create a value of ModifyReplicationSubnetGroupResponse
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:replicationSubnetGroup:ModifyReplicationSubnetGroupResponse'
, modifyReplicationSubnetGroupResponse_replicationSubnetGroup
- The modified replication subnet group.
$sel:httpStatus:ModifyReplicationSubnetGroupResponse'
, modifyReplicationSubnetGroupResponse_httpStatus
- The response's http status code.
DescribeReplicationTaskIndividualAssessments
data DescribeReplicationTaskIndividualAssessments Source #
See: newDescribeReplicationTaskIndividualAssessments
smart constructor.
Instances
newDescribeReplicationTaskIndividualAssessments :: DescribeReplicationTaskIndividualAssessments Source #
Create a value of DescribeReplicationTaskIndividualAssessments
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:filters:DescribeReplicationTaskIndividualAssessments'
, describeReplicationTaskIndividualAssessments_filters
- Filters applied to the individual assessments described in the form of
key-value pairs.
Valid filter names: replication-task-assessment-run-arn
,
replication-task-arn
, status
$sel:marker:DescribeReplicationTaskIndividualAssessments'
, describeReplicationTaskIndividualAssessments_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeReplicationTaskIndividualAssessments'
, describeReplicationTaskIndividualAssessments_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
data DescribeReplicationTaskIndividualAssessmentsResponse Source #
See: newDescribeReplicationTaskIndividualAssessmentsResponse
smart constructor.
Constructors
DescribeReplicationTaskIndividualAssessmentsResponse' (Maybe [ReplicationTaskIndividualAssessment]) (Maybe Text) Int |
Instances
newDescribeReplicationTaskIndividualAssessmentsResponse Source #
Arguments
:: Int |
|
-> DescribeReplicationTaskIndividualAssessmentsResponse |
Create a value of DescribeReplicationTaskIndividualAssessmentsResponse
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:replicationTaskIndividualAssessments:DescribeReplicationTaskIndividualAssessmentsResponse'
, describeReplicationTaskIndividualAssessmentsResponse_replicationTaskIndividualAssessments
- One or more individual assessments as specified by Filters
.
$sel:marker:DescribeReplicationTaskIndividualAssessments'
, describeReplicationTaskIndividualAssessmentsResponse_marker
- A pagination token returned for you to pass to a subsequent request. If
you pass this token as the Marker
value in a subsequent request, the
response includes only records beyond the marker, up to the value
specified in the request by MaxRecords
.
$sel:httpStatus:DescribeReplicationTaskIndividualAssessmentsResponse'
, describeReplicationTaskIndividualAssessmentsResponse_httpStatus
- The response's http status code.
ApplyPendingMaintenanceAction
data ApplyPendingMaintenanceAction Source #
See: newApplyPendingMaintenanceAction
smart constructor.
Constructors
ApplyPendingMaintenanceAction' Text Text Text |
Instances
newApplyPendingMaintenanceAction Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> ApplyPendingMaintenanceAction |
Create a value of ApplyPendingMaintenanceAction
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:replicationInstanceArn:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_replicationInstanceArn
- The Amazon Resource Name (ARN) of the DMS resource that the pending
maintenance action applies to.
$sel:applyAction:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_applyAction
- The pending maintenance action to apply to this resource.
Valid values: os-upgrade
, system-update
, db-upgrade
$sel:optInType:ApplyPendingMaintenanceAction'
, applyPendingMaintenanceAction_optInType
- A value that specifies the type of opt-in request, or undoes an opt-in
request. You can't undo an opt-in request of type immediate
.
Valid values:
immediate
- Apply the maintenance action immediately.next-maintenance
- Apply the maintenance action during the next maintenance window for the resource.undo-opt-in
- Cancel any existingnext-maintenance
opt-in requests.
data ApplyPendingMaintenanceActionResponse Source #
See: newApplyPendingMaintenanceActionResponse
smart constructor.
Instances
newApplyPendingMaintenanceActionResponse Source #
Arguments
:: Int | |
-> ApplyPendingMaintenanceActionResponse |
Create a value of ApplyPendingMaintenanceActionResponse
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:resourcePendingMaintenanceActions:ApplyPendingMaintenanceActionResponse'
, applyPendingMaintenanceActionResponse_resourcePendingMaintenanceActions
- The DMS resource that the pending maintenance action will be applied to.
$sel:httpStatus:ApplyPendingMaintenanceActionResponse'
, applyPendingMaintenanceActionResponse_httpStatus
- The response's http status code.
DescribeAccountAttributes
data DescribeAccountAttributes Source #
See: newDescribeAccountAttributes
smart constructor.
Constructors
DescribeAccountAttributes' | |
Instances
newDescribeAccountAttributes :: DescribeAccountAttributes Source #
Create a value of DescribeAccountAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeAccountAttributesResponse Source #
See: newDescribeAccountAttributesResponse
smart constructor.
Constructors
DescribeAccountAttributesResponse' (Maybe [AccountQuota]) (Maybe Text) Int |
Instances
newDescribeAccountAttributesResponse Source #
Arguments
:: Int | |
-> DescribeAccountAttributesResponse |
Create a value of DescribeAccountAttributesResponse
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:accountQuotas:DescribeAccountAttributesResponse'
, describeAccountAttributesResponse_accountQuotas
- Account quota information.
$sel:uniqueAccountIdentifier:DescribeAccountAttributesResponse'
, describeAccountAttributesResponse_uniqueAccountIdentifier
- A unique DMS identifier for an account in a particular Amazon Web
Services Region. The value of this identifier has the following format:
c99999999999
. DMS uses this identifier to name artifacts. For example,
DMS uses this identifier to name the default Amazon S3 bucket for
storing task assessment reports in a given Amazon Web Services Region.
The format of this S3 bucket name is the following:
dms-AccountNumber-UniqueAccountIdentifier.
Here is an example name for
this default S3 bucket: dms-111122223333-c44445555666
.
DMS supports the UniqueAccountIdentifier
parameter in versions 3.1.4
and later.
$sel:httpStatus:DescribeAccountAttributesResponse'
, describeAccountAttributesResponse_httpStatus
- The response's http status code.
DescribeReplicationInstances (Paginated)
data DescribeReplicationInstances Source #
See: newDescribeReplicationInstances
smart constructor.
Instances
newDescribeReplicationInstances :: DescribeReplicationInstances Source #
Create a value of DescribeReplicationInstances
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:filters:DescribeReplicationInstances'
, describeReplicationInstances_filters
- Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
$sel:marker:DescribeReplicationInstances'
, describeReplicationInstances_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:maxRecords:DescribeReplicationInstances'
, describeReplicationInstances_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
data DescribeReplicationInstancesResponse Source #
See: newDescribeReplicationInstancesResponse
smart constructor.
Constructors
DescribeReplicationInstancesResponse' (Maybe Text) (Maybe [ReplicationInstance]) Int |
Instances
newDescribeReplicationInstancesResponse Source #
Arguments
:: Int | |
-> DescribeReplicationInstancesResponse |
Create a value of DescribeReplicationInstancesResponse
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:marker:DescribeReplicationInstances'
, describeReplicationInstancesResponse_marker
- An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords
.
$sel:replicationInstances:DescribeReplicationInstancesResponse'
, describeReplicationInstancesResponse_replicationInstances
- The replication instances described.
$sel:httpStatus:DescribeReplicationInstancesResponse'
, describeReplicationInstancesResponse_httpStatus
- The response's http status code.
DescribeRefreshSchemasStatus
data DescribeRefreshSchemasStatus Source #
See: newDescribeRefreshSchemasStatus
smart constructor.
Constructors
DescribeRefreshSchemasStatus' Text |
Instances
newDescribeRefreshSchemasStatus Source #
Create a value of DescribeRefreshSchemasStatus
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:endpointArn:DescribeRefreshSchemasStatus'
, describeRefreshSchemasStatus_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
data DescribeRefreshSchemasStatusResponse Source #
See: newDescribeRefreshSchemasStatusResponse
smart constructor.
Constructors
DescribeRefreshSchemasStatusResponse' (Maybe RefreshSchemasStatus) Int |
Instances
newDescribeRefreshSchemasStatusResponse Source #
Arguments
:: Int | |
-> DescribeRefreshSchemasStatusResponse |
Create a value of DescribeRefreshSchemasStatusResponse
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:refreshSchemasStatus:DescribeRefreshSchemasStatusResponse'
, describeRefreshSchemasStatusResponse_refreshSchemasStatus
- The status of the schema.
$sel:httpStatus:DescribeRefreshSchemasStatusResponse'
, describeRefreshSchemasStatusResponse_httpStatus
- The response's http status code.
StopReplicationTask
data StopReplicationTask Source #
See: newStopReplicationTask
smart constructor.
Constructors
StopReplicationTask' Text |
Instances
newStopReplicationTask Source #
Create a value of StopReplicationTask
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:replicationTaskArn:StopReplicationTask'
, stopReplicationTask_replicationTaskArn
- The Amazon Resource Name(ARN) of the replication task to be stopped.
data StopReplicationTaskResponse Source #
See: newStopReplicationTaskResponse
smart constructor.
Constructors
StopReplicationTaskResponse' (Maybe ReplicationTask) Int |
Instances
newStopReplicationTaskResponse Source #
Create a value of StopReplicationTaskResponse
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:replicationTask:StopReplicationTaskResponse'
, stopReplicationTaskResponse_replicationTask
- The replication task stopped.
$sel:httpStatus:StopReplicationTaskResponse'
, stopReplicationTaskResponse_httpStatus
- The response's http status code.
ModifyReplicationTask
data ModifyReplicationTask Source #
See: newModifyReplicationTask
smart constructor.
Constructors
ModifyReplicationTask' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe MigrationTypeValue) (Maybe Text) (Maybe Text) (Maybe POSIX) Text |
Instances
newModifyReplicationTask Source #
Create a value of ModifyReplicationTask
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:replicationTaskSettings:ModifyReplicationTask'
, modifyReplicationTask_replicationTaskSettings
- JSON file that contains settings for the task, such as task metadata
settings.
$sel:replicationTaskIdentifier:ModifyReplicationTask'
, modifyReplicationTask_replicationTaskIdentifier
- The replication task identifier.
Constraints:
- Must contain 1-255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
$sel:cdcStartPosition:ModifyReplicationTask'
, modifyReplicationTask_cdcStartPosition
- Indicates when you want a change data capture (CDC) operation to start.
Use either CdcStartPosition or CdcStartTime to specify when you want a
CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:187600#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a
logical replication slot should already be created and associated with
the source endpoint. You can verify this by setting the slotName
extra
connection attribute to the name of this logical replication slot. For
more information, see
Extra Connection Attributes When Using PostgreSQL as a Source for DMS.
$sel:tableMappings:ModifyReplicationTask'
, modifyReplicationTask_tableMappings
- When using the CLI or boto3, provide the path of the JSON file that
contains the table mappings. Precede the path with file://
. For
example, --table-mappings file://mappingfile.json
. When working with
the DMS API, provide the JSON as the parameter value.
$sel:migrationType:ModifyReplicationTask'
, modifyReplicationTask_migrationType
- The migration type. Valid values: full-load
| cdc
|
full-load-and-cdc
$sel:taskData:ModifyReplicationTask'
, modifyReplicationTask_taskData
- Supplemental information that the task requires to migrate the data for
certain source and target endpoints. For more information, see
Specifying Supplemental Data for Task Settings
in the Database Migration Service User Guide.
$sel:cdcStopPosition:ModifyReplicationTask'
, modifyReplicationTask_cdcStopPosition
- Indicates when you want a change data capture (CDC) operation to stop.
The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
$sel:cdcStartTime:ModifyReplicationTask'
, modifyReplicationTask_cdcStartTime
- Indicates the start time for a change data capture (CDC) operation. Use
either CdcStartTime or CdcStartPosition to specify when you want a CDC
operation to start. Specifying both values results in an error.
Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
$sel:replicationTaskArn:ModifyReplicationTask'
, modifyReplicationTask_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
data ModifyReplicationTaskResponse Source #
See: newModifyReplicationTaskResponse
smart constructor.
Constructors
ModifyReplicationTaskResponse' (Maybe ReplicationTask) Int |
Instances
newModifyReplicationTaskResponse Source #
Create a value of ModifyReplicationTaskResponse
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:replicationTask:ModifyReplicationTaskResponse'
, modifyReplicationTaskResponse_replicationTask
- The replication task that was modified.
$sel:httpStatus:ModifyReplicationTaskResponse'
, modifyReplicationTaskResponse_httpStatus
- The response's http status code.
CreateReplicationInstance
data CreateReplicationInstance Source #
See: newCreateReplicationInstance
smart constructor.
Constructors
CreateReplicationInstance' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text |
Instances
newCreateReplicationInstance Source #
Arguments
:: Text |
|
-> Text | |
-> CreateReplicationInstance |
Create a value of CreateReplicationInstance
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:engineVersion:CreateReplicationInstance'
, createReplicationInstance_engineVersion
- The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
$sel:publiclyAccessible:CreateReplicationInstance'
, createReplicationInstance_publiclyAccessible
- Specifies the accessibility options for the replication instance. A
value of true
represents an instance with a public IP address. A value
of false
represents an instance with a private IP address. The default
value is true
.
$sel:autoMinorVersionUpgrade:CreateReplicationInstance'
, createReplicationInstance_autoMinorVersionUpgrade
- A value that indicates whether minor engine upgrades are applied
automatically to the replication instance during the maintenance window.
This parameter defaults to true
.
Default: true
$sel:replicationSubnetGroupIdentifier:CreateReplicationInstance'
, createReplicationInstance_replicationSubnetGroupIdentifier
- A subnet group to associate with the replication instance.
$sel:preferredMaintenanceWindow:CreateReplicationInstance'
, createReplicationInstance_preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
$sel:kmsKeyId:CreateReplicationInstance'
, createReplicationInstance_kmsKeyId
- An KMS key identifier that is used to encrypt the data on the
replication instance.
If you don't specify a value for the KmsKeyId
parameter, then DMS
uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
$sel:availabilityZone:CreateReplicationInstance'
, createReplicationInstance_availabilityZone
- The Availability Zone where the replication instance will be created.
The default value is a random, system-chosen Availability Zone in the
endpoint's Amazon Web Services Region, for example: us-east-1d
$sel:vpcSecurityGroupIds:CreateReplicationInstance'
, createReplicationInstance_vpcSecurityGroupIds
- Specifies the VPC security group to be used with the replication
instance. The VPC security group must work with the VPC containing the
replication instance.
$sel:multiAZ:CreateReplicationInstance'
, createReplicationInstance_multiAZ
- Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone
parameter if the Multi-AZ parameter is
set to true
.
$sel:allocatedStorage:CreateReplicationInstance'
, createReplicationInstance_allocatedStorage
- The amount of storage (in gigabytes) to be initially allocated for the
replication instance.
$sel:dnsNameServers:CreateReplicationInstance'
, createReplicationInstance_dnsNameServers
- A list of custom DNS name servers supported for the replication instance
to access your on-premise source or target database. This list overrides
the default name servers supported by the replication instance. You can
specify a comma-separated list of internet addresses for up to four
on-premise DNS name servers. For example:
"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"
$sel:resourceIdentifier:CreateReplicationInstance'
, createReplicationInstance_resourceIdentifier
- A friendly name for the resource identifier at the end of the
EndpointArn
response parameter that is returned in the created
Endpoint
object. The value for this parameter can have up to 31
characters. It can contain only ASCII letters, digits, and hyphen
('-'). Also, it can't end with a hyphen or contain two consecutive
hyphens, and can only begin with a letter, such as Example-App-ARN1
.
For example, this value might result in the EndpointArn
value
arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't
specify a ResourceIdentifier
value, DMS generates a default identifier
value for the end of EndpointArn
.
$sel:tags:CreateReplicationInstance'
, createReplicationInstance_tags
- One or more tags to be assigned to the replication instance.
$sel:replicationInstanceIdentifier:CreateReplicationInstance'
, createReplicationInstance_replicationInstanceIdentifier
- The replication instance identifier. This parameter is stored as a
lowercase string.
Constraints:
- Must contain 1-63 alphanumeric characters or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
$sel:replicationInstanceClass:CreateReplicationInstance'
, createReplicationInstance_replicationInstanceClass
- The compute and memory capacity of the replication instance as defined
for the specified replication instance class. For example to specify the
instance class dms.c4.large, set this parameter to "dms.c4.large"
.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
data CreateReplicationInstanceResponse Source #
See: newCreateReplicationInstanceResponse
smart constructor.
Constructors
CreateReplicationInstanceResponse' (Maybe ReplicationInstance) Int |
Instances
newCreateReplicationInstanceResponse Source #
Arguments
:: Int | |
-> CreateReplicationInstanceResponse |
Create a value of CreateReplicationInstanceResponse
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:replicationInstance:CreateReplicationInstanceResponse'
, createReplicationInstanceResponse_replicationInstance
- The replication instance that was created.
$sel:httpStatus:CreateReplicationInstanceResponse'
, createReplicationInstanceResponse_httpStatus
- The response's http status code.
DeleteReplicationSubnetGroup
data DeleteReplicationSubnetGroup Source #
See: newDeleteReplicationSubnetGroup
smart constructor.
Constructors
DeleteReplicationSubnetGroup' Text |
Instances
newDeleteReplicationSubnetGroup Source #
Arguments
:: Text |
|
-> DeleteReplicationSubnetGroup |
Create a value of DeleteReplicationSubnetGroup
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:replicationSubnetGroupIdentifier:DeleteReplicationSubnetGroup'
, deleteReplicationSubnetGroup_replicationSubnetGroupIdentifier
- The subnet group name of the replication instance.
data DeleteReplicationSubnetGroupResponse Source #
See: newDeleteReplicationSubnetGroupResponse
smart constructor.
Constructors
DeleteReplicationSubnetGroupResponse' Int |
Instances
newDeleteReplicationSubnetGroupResponse Source #
Arguments
:: Int | |
-> DeleteReplicationSubnetGroupResponse |
Create a value of DeleteReplicationSubnetGroupResponse
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:httpStatus:DeleteReplicationSubnetGroupResponse'
, deleteReplicationSubnetGroupResponse_httpStatus
- The response's http status code.
Types
AuthMechanismValue
newtype AuthMechanismValue Source #
Constructors
AuthMechanismValue' | |
Fields |
Bundled Patterns
pattern AuthMechanismValue_Default :: AuthMechanismValue | |
pattern AuthMechanismValue_Mongodb_cr :: AuthMechanismValue | |
pattern AuthMechanismValue_Scram_sha_1 :: AuthMechanismValue |
Instances
AuthTypeValue
newtype AuthTypeValue Source #
Constructors
AuthTypeValue' | |
Fields |
Bundled Patterns
pattern AuthTypeValue_No :: AuthTypeValue | |
pattern AuthTypeValue_Password :: AuthTypeValue |
Instances
CannedAclForObjectsValue
newtype CannedAclForObjectsValue Source #
Constructors
CannedAclForObjectsValue' | |
Fields |
Bundled Patterns
Instances
CharLengthSemantics
newtype CharLengthSemantics Source #
Constructors
CharLengthSemantics' | |
Fields |
Bundled Patterns
pattern CharLengthSemantics_Byte :: CharLengthSemantics | |
pattern CharLengthSemantics_Char :: CharLengthSemantics | |
pattern CharLengthSemantics_Default :: CharLengthSemantics |
Instances
CompressionTypeValue
newtype CompressionTypeValue Source #
Constructors
CompressionTypeValue' | |
Fields |
Bundled Patterns
pattern CompressionTypeValue_Gzip :: CompressionTypeValue | |
pattern CompressionTypeValue_None :: CompressionTypeValue |
Instances
DataFormatValue
newtype DataFormatValue Source #
Constructors
DataFormatValue' | |
Fields |
Bundled Patterns
pattern DataFormatValue_Csv :: DataFormatValue | |
pattern DataFormatValue_Parquet :: DataFormatValue |
Instances
DatePartitionDelimiterValue
newtype DatePartitionDelimiterValue Source #
Constructors
DatePartitionDelimiterValue' | |
Fields |
Bundled Patterns
Instances
DatePartitionSequenceValue
newtype DatePartitionSequenceValue Source #
Constructors
DatePartitionSequenceValue' | |
Fields |
Bundled Patterns
Instances
DmsSslModeValue
newtype DmsSslModeValue Source #
Constructors
DmsSslModeValue' | |
Fields |
Bundled Patterns
pattern DmsSslModeValue_None :: DmsSslModeValue | |
pattern DmsSslModeValue_Require :: DmsSslModeValue | |
pattern DmsSslModeValue_Verify_ca :: DmsSslModeValue | |
pattern DmsSslModeValue_Verify_full :: DmsSslModeValue |
Instances
EncodingTypeValue
newtype EncodingTypeValue Source #
Constructors
EncodingTypeValue' | |
Fields |
Bundled Patterns
pattern EncodingTypeValue_Plain :: EncodingTypeValue | |
pattern EncodingTypeValue_Plain_dictionary :: EncodingTypeValue | |
pattern EncodingTypeValue_Rle_dictionary :: EncodingTypeValue |
Instances
EncryptionModeValue
newtype EncryptionModeValue Source #
Constructors
EncryptionModeValue' | |
Fields |
Bundled Patterns
pattern EncryptionModeValue_Sse_kms :: EncryptionModeValue | |
pattern EncryptionModeValue_Sse_s3 :: EncryptionModeValue |
Instances
EndpointSettingTypeValue
newtype EndpointSettingTypeValue Source #
Constructors
EndpointSettingTypeValue' | |
Fields |
Bundled Patterns
Instances
KafkaSecurityProtocol
newtype KafkaSecurityProtocol Source #
Constructors
KafkaSecurityProtocol' | |
Fields |
Bundled Patterns
Instances
MessageFormatValue
newtype MessageFormatValue Source #
Constructors
MessageFormatValue' | |
Fields |
Bundled Patterns
pattern MessageFormatValue_Json :: MessageFormatValue | |
pattern MessageFormatValue_Json_unformatted :: MessageFormatValue |
Instances
MigrationTypeValue
newtype MigrationTypeValue Source #
Constructors
MigrationTypeValue' | |
Fields |
Bundled Patterns
pattern MigrationTypeValue_Cdc :: MigrationTypeValue | |
pattern MigrationTypeValue_Full_load :: MigrationTypeValue | |
pattern MigrationTypeValue_Full_load_and_cdc :: MigrationTypeValue |
Instances
NestingLevelValue
newtype NestingLevelValue Source #
Constructors
NestingLevelValue' | |
Fields |
Bundled Patterns
pattern NestingLevelValue_None :: NestingLevelValue | |
pattern NestingLevelValue_One :: NestingLevelValue |
Instances
ParquetVersionValue
newtype ParquetVersionValue Source #
Constructors
ParquetVersionValue' | |
Fields |
Bundled Patterns
pattern ParquetVersionValue_Parquet_1_0 :: ParquetVersionValue | |
pattern ParquetVersionValue_Parquet_2_0 :: ParquetVersionValue |
Instances
PluginNameValue
newtype PluginNameValue Source #
Constructors
PluginNameValue' | |
Fields |
Bundled Patterns
pattern PluginNameValue_No_preference :: PluginNameValue | |
pattern PluginNameValue_Pglogical :: PluginNameValue | |
pattern PluginNameValue_Test_decoding :: PluginNameValue |
Instances
RedisAuthTypeValue
newtype RedisAuthTypeValue Source #
Constructors
RedisAuthTypeValue' | |
Fields |
Bundled Patterns
pattern RedisAuthTypeValue_Auth_role :: RedisAuthTypeValue | |
pattern RedisAuthTypeValue_Auth_token :: RedisAuthTypeValue | |
pattern RedisAuthTypeValue_None :: RedisAuthTypeValue |
Instances
RefreshSchemasStatusTypeValue
newtype RefreshSchemasStatusTypeValue Source #
Constructors
RefreshSchemasStatusTypeValue' | |
Fields |
Bundled Patterns
Instances
ReleaseStatusValues
newtype ReleaseStatusValues Source #
Constructors
ReleaseStatusValues' | |
Fields |
Bundled Patterns
pattern ReleaseStatusValues_Beta :: ReleaseStatusValues |
Instances
ReloadOptionValue
newtype ReloadOptionValue Source #
Constructors
ReloadOptionValue' | |
Fields |
Bundled Patterns
pattern ReloadOptionValue_Data_reload :: ReloadOptionValue | |
pattern ReloadOptionValue_Validate_only :: ReloadOptionValue |
Instances
ReplicationEndpointTypeValue
newtype ReplicationEndpointTypeValue Source #
Constructors
ReplicationEndpointTypeValue' | |
Fields |
Bundled Patterns
pattern ReplicationEndpointTypeValue_Source :: ReplicationEndpointTypeValue | |
pattern ReplicationEndpointTypeValue_Target :: ReplicationEndpointTypeValue |
Instances
SafeguardPolicy
newtype SafeguardPolicy Source #
Constructors
SafeguardPolicy' | |
Fields |
Bundled Patterns
Instances
SourceType
newtype SourceType Source #
Constructors
SourceType' | |
Fields |
Bundled Patterns
pattern SourceType_Replication_instance :: SourceType |
Instances
SslSecurityProtocolValue
newtype SslSecurityProtocolValue Source #
Constructors
SslSecurityProtocolValue' | |
Fields |
Bundled Patterns
pattern SslSecurityProtocolValue_Plaintext :: SslSecurityProtocolValue | |
pattern SslSecurityProtocolValue_Ssl_encryption :: SslSecurityProtocolValue |
Instances
StartReplicationTaskTypeValue
newtype StartReplicationTaskTypeValue Source #
Constructors
StartReplicationTaskTypeValue' | |
Fields |
Bundled Patterns
Instances
TargetDbType
newtype TargetDbType Source #
Constructors
TargetDbType' | |
Fields |
Bundled Patterns
pattern TargetDbType_Multiple_databases :: TargetDbType | |
pattern TargetDbType_Specific_database :: TargetDbType |
Instances
AccountQuota
data AccountQuota Source #
Describes a quota for an Amazon Web Services account, for example the number of replication instances allowed.
See: newAccountQuota
smart constructor.
Instances
newAccountQuota :: AccountQuota Source #
Create a value of AccountQuota
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:max:AccountQuota'
, accountQuota_max
- The maximum allowed value for the quota.
$sel:used:AccountQuota'
, accountQuota_used
- The amount currently used toward the quota maximum.
$sel:accountQuotaName:AccountQuota'
, accountQuota_accountQuotaName
- The name of the DMS quota for this Amazon Web Services account.
AvailabilityZone
data AvailabilityZone Source #
The name of an Availability Zone for use during database migration.
AvailabilityZone
is an optional parameter to the
CreateReplicationInstance
operation, and it’s value relates to the Amazon Web Services Region of
an endpoint. For example, the availability zone of an endpoint in the
us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or
us-east-1d.
See: newAvailabilityZone
smart constructor.
Constructors
AvailabilityZone' (Maybe Text) |
Instances
newAvailabilityZone :: AvailabilityZone Source #
Create a value of AvailabilityZone
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:AvailabilityZone'
, availabilityZone_name
- The name of the Availability Zone.
Certificate
data Certificate Source #
The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.
See: newCertificate
smart constructor.
Constructors
Certificate' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Base64) (Maybe Int) (Maybe POSIX) |
Instances
newCertificate :: Certificate Source #
Create a value of Certificate
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:certificateOwner:Certificate'
, certificate_certificateOwner
- The owner of the certificate.
$sel:signingAlgorithm:Certificate'
, certificate_signingAlgorithm
- The signing algorithm for the certificate.
$sel:validFromDate:Certificate'
, certificate_validFromDate
- The beginning date that the certificate is valid.
$sel:certificatePem:Certificate'
, certificate_certificatePem
- The contents of a .pem
file, which contains an X.509 certificate.
$sel:certificateArn:Certificate'
, certificate_certificateArn
- The Amazon Resource Name (ARN) for the certificate.
$sel:certificateCreationDate:Certificate'
, certificate_certificateCreationDate
- The date that the certificate was created.
$sel:certificateIdentifier:Certificate'
, certificate_certificateIdentifier
- A customer-assigned name for the certificate. Identifiers must begin
with a letter and must contain only ASCII letters, digits, and hyphens.
They can't end with a hyphen or contain two consecutive hyphens.
$sel:certificateWallet:Certificate'
, certificate_certificateWallet
- The location of an imported Oracle Wallet certificate for use with SSL.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:keyLength:Certificate'
, certificate_keyLength
- The key length of the cryptographic algorithm being used.
$sel:validToDate:Certificate'
, certificate_validToDate
- The final date that the certificate is valid.
Connection
data Connection Source #
Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.
See: newConnection
smart constructor.
Constructors
Connection' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newConnection :: Connection Source #
Create a value of Connection
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:Connection'
, connection_status
- The connection status. This parameter can return one of the following
values:
"successful"
"testing"
"failed"
"deleting"
$sel:replicationInstanceArn:Connection'
, connection_replicationInstanceArn
- The ARN of the replication instance.
$sel:endpointIdentifier:Connection'
, connection_endpointIdentifier
- The identifier of the endpoint. Identifiers must begin with a letter and
must contain only ASCII letters, digits, and hyphens. They can't end
with a hyphen or contain two consecutive hyphens.
$sel:replicationInstanceIdentifier:Connection'
, connection_replicationInstanceIdentifier
- The replication instance identifier. This parameter is stored as a
lowercase string.
$sel:endpointArn:Connection'
, connection_endpointArn
- The ARN string that uniquely identifies the endpoint.
$sel:lastFailureMessage:Connection'
, connection_lastFailureMessage
- The error message when the connection last failed.
DmsTransferSettings
data DmsTransferSettings Source #
The settings in JSON format for the DMS Transfer type source endpoint.
See: newDmsTransferSettings
smart constructor.
Constructors
DmsTransferSettings' (Maybe Text) (Maybe Text) |
Instances
newDmsTransferSettings :: DmsTransferSettings Source #
Create a value of DmsTransferSettings
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:serviceAccessRoleArn:DmsTransferSettings'
, dmsTransferSettings_serviceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service access IAM role. The
role must allow the iam:PassRole
action.
$sel:bucketName:DmsTransferSettings'
, dmsTransferSettings_bucketName
- The name of the S3 bucket to use.
DocDbSettings
data DocDbSettings Source #
Provides information that defines a DocumentDB endpoint.
See: newDocDbSettings
smart constructor.
Constructors
DocDbSettings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe NestingLevelValue) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) |
Instances
newDocDbSettings :: DocDbSettings Source #
Create a value of DocDbSettings
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:serverName:DocDbSettings'
, docDbSettings_serverName
- The name of the server on the DocumentDB source endpoint.
$sel:secretsManagerAccessRoleArn:DocDbSettings'
, docDbSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the DocumentDB endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:username:DocDbSettings'
, docDbSettings_username
- The user name you use to access the DocumentDB source endpoint.
$sel:kmsKeyId:DocDbSettings'
, docDbSettings_kmsKeyId
- The KMS key identifier that is used to encrypt the content on the
replication instance. If you don't specify a value for the KmsKeyId
parameter, then DMS uses your default encryption key. KMS creates the
default encryption key for your Amazon Web Services account. Your Amazon
Web Services account has a different default encryption key for each
Amazon Web Services Region.
$sel:password:DocDbSettings'
, docDbSettings_password
- The password for the user account you use to access the DocumentDB
source endpoint.
$sel:nestingLevel:DocDbSettings'
, docDbSettings_nestingLevel
- Specifies either document or table mode.
Default value is "none"
. Specify "none"
to use document mode.
Specify "one"
to use table mode.
$sel:databaseName:DocDbSettings'
, docDbSettings_databaseName
- The database name on the DocumentDB source endpoint.
$sel:docsToInvestigate:DocDbSettings'
, docDbSettings_docsToInvestigate
- Indicates the number of documents to preview to determine the document
organization. Use this setting when NestingLevel
is set to "one"
.
Must be a positive value greater than 0
. Default value is 1000
.
$sel:secretsManagerSecretId:DocDbSettings'
, docDbSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the DocumentDB endpoint connection
details.
$sel:extractDocId:DocDbSettings'
, docDbSettings_extractDocId
- Specifies the document ID. Use this setting when NestingLevel
is set
to "none"
.
Default value is "false"
.
$sel:port:DocDbSettings'
, docDbSettings_port
- The port value for the DocumentDB source endpoint.
DynamoDbSettings
data DynamoDbSettings Source #
Provides the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.
See: newDynamoDbSettings
smart constructor.
Constructors
DynamoDbSettings' Text |
Instances
Create a value of DynamoDbSettings
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:serviceAccessRoleArn:DynamoDbSettings'
, dynamoDbSettings_serviceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole
action.
ElasticsearchSettings
data ElasticsearchSettings Source #
Provides information that defines an Elasticsearch endpoint.
See: newElasticsearchSettings
smart constructor.
Instances
newElasticsearchSettings Source #
Arguments
:: Text | |
-> Text | |
-> ElasticsearchSettings |
Create a value of ElasticsearchSettings
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:fullLoadErrorPercentage:ElasticsearchSettings'
, elasticsearchSettings_fullLoadErrorPercentage
- The maximum percentage of records that can fail to be written before a
full load operation stops.
To avoid early failure, this counter is only effective after 1000 records are transferred. Elasticsearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.
$sel:errorRetryDuration:ElasticsearchSettings'
, elasticsearchSettings_errorRetryDuration
- The maximum number of seconds for which DMS retries failed API requests
to the Elasticsearch cluster.
$sel:serviceAccessRoleArn:ElasticsearchSettings'
, elasticsearchSettings_serviceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole
action.
$sel:endpointUri:ElasticsearchSettings'
, elasticsearchSettings_endpointUri
- The endpoint for the Elasticsearch cluster. DMS uses HTTPS if a
transport protocol (http/https) is not specified.
Endpoint
Describes an endpoint of a database instance in response to operations such as the following:
CreateEndpoint
DescribeEndpoint
ModifyEndpoint
See: newEndpoint
smart constructor.
Constructors
Instances
newEndpoint :: Endpoint Source #
Create a value of Endpoint
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:Endpoint'
, endpoint_status
- The status of the endpoint.
$sel:dmsTransferSettings:Endpoint'
, endpoint_dmsTransferSettings
- The settings in JSON format for the DMS transfer type of source
endpoint.
Possible settings include the following:
ServiceAccessRoleArn
- - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow theiam:PassRole
action.BucketName
- The name of the S3 bucket to use.
Shorthand syntax for these settings is as follows:
ServiceAccessRoleArn=string,BucketName=string,
JSON syntax for these settings is as follows:
{ "ServiceAccessRoleArn": "string", "BucketName": "string"}
$sel:mySQLSettings:Endpoint'
, endpoint_mySQLSettings
- The settings for the MySQL source and target endpoint. For more
information, see the MySQLSettings
structure.
$sel:serverName:Endpoint'
, endpoint_serverName
- The name of the server at the endpoint.
$sel:microsoftSQLServerSettings:Endpoint'
, endpoint_microsoftSQLServerSettings
- The settings for the Microsoft SQL Server source and target endpoint.
For more information, see the MicrosoftSQLServerSettings
structure.
$sel:certificateArn:Endpoint'
, endpoint_certificateArn
- The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
$sel:serviceAccessRoleArn:Endpoint'
, endpoint_serviceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole
action.
$sel:docDbSettings:Endpoint'
, endpoint_docDbSettings
- Undocumented member.
$sel:engineDisplayName:Endpoint'
, endpoint_engineDisplayName
- The expanded name for the engine name. For example, if the EngineName
parameter is "aurora," this value would be "Amazon Aurora MySQL."
$sel:postgreSQLSettings:Endpoint'
, endpoint_postgreSQLSettings
- The settings for the PostgreSQL source and target endpoint. For more
information, see the PostgreSQLSettings
structure.
$sel:extraConnectionAttributes:Endpoint'
, endpoint_extraConnectionAttributes
- Additional connection attributes used to connect to the endpoint.
$sel:kafkaSettings:Endpoint'
, endpoint_kafkaSettings
- The settings for the Apache Kafka target endpoint. For more information,
see the KafkaSettings
structure.
$sel:oracleSettings:Endpoint'
, endpoint_oracleSettings
- The settings for the Oracle source and target endpoint. For more
information, see the OracleSettings
structure.
$sel:endpointType:Endpoint'
, endpoint_endpointType
- The type of endpoint. Valid values are source
and target
.
$sel:redshiftSettings:Endpoint'
, endpoint_redshiftSettings
- Settings for the Amazon Redshift endpoint.
$sel:elasticsearchSettings:Endpoint'
, endpoint_elasticsearchSettings
- The settings for the Elasticsearch source endpoint. For more
information, see the ElasticsearchSettings
structure.
$sel:username:Endpoint'
, endpoint_username
- The user name used to connect to the endpoint.
$sel:externalTableDefinition:Endpoint'
, endpoint_externalTableDefinition
- The external table definition.
$sel:engineName:Endpoint'
, endpoint_engineName
- The database engine name. Valid values, depending on the EndpointType,
include "mysql"
, "oracle"
, "postgres"
, "mariadb"
,
"aurora"
, "aurora-postgresql"
, "redshift"
, "s3"
,
"db2"
, "azuredb"
, "sybase"
, "dynamodb"
, "mongodb"
,
"kinesis"
, "kafka"
, "elasticsearch"
, "documentdb"
,
"sqlserver"
, and "neptune"
.
$sel:redisSettings:Endpoint'
, endpoint_redisSettings
- The settings for the Redis target endpoint. For more information, see
the RedisSettings
structure.
$sel:neptuneSettings:Endpoint'
, endpoint_neptuneSettings
- The settings for the Amazon Neptune target endpoint. For more
information, see the NeptuneSettings
structure.
$sel:iBMDb2Settings:Endpoint'
, endpoint_iBMDb2Settings
- The settings for the IBM Db2 LUW source endpoint. For more information,
see the IBMDb2Settings
structure.
$sel:kmsKeyId:Endpoint'
, endpoint_kmsKeyId
- An KMS key identifier that is used to encrypt the connection parameters
for the endpoint.
If you don't specify a value for the KmsKeyId
parameter, then DMS
uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
$sel:mongoDbSettings:Endpoint'
, endpoint_mongoDbSettings
- The settings for the MongoDB source endpoint. For more information, see
the MongoDbSettings
structure.
$sel:sslMode:Endpoint'
, endpoint_sslMode
- The SSL mode used to connect to the endpoint. The default value is
none
.
$sel:sybaseSettings:Endpoint'
, endpoint_sybaseSettings
- The settings for the SAP ASE source and target endpoint. For more
information, see the SybaseSettings
structure.
$sel:databaseName:Endpoint'
, endpoint_databaseName
- The name of the database at the endpoint.
$sel:s3Settings:Endpoint'
, endpoint_s3Settings
- The settings for the S3 target endpoint. For more information, see the
S3Settings
structure.
$sel:kinesisSettings:Endpoint'
, endpoint_kinesisSettings
- The settings for the Amazon Kinesis target endpoint. For more
information, see the KinesisSettings
structure.
$sel:endpointIdentifier:Endpoint'
, endpoint_endpointIdentifier
- The database endpoint identifier. Identifiers must begin with a letter
and must contain only ASCII letters, digits, and hyphens. They can't
end with a hyphen or contain two consecutive hyphens.
$sel:externalId:Endpoint'
, endpoint_externalId
- Value returned by a call to CreateEndpoint that can be used for
cross-account validation. Use it on a subsequent call to CreateEndpoint
to create the endpoint with a cross-account.
$sel:dynamoDbSettings:Endpoint'
, endpoint_dynamoDbSettings
- The settings for the DynamoDB target endpoint. For more information, see
the DynamoDBSettings
structure.
$sel:endpointArn:Endpoint'
, endpoint_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
$sel:port:Endpoint'
, endpoint_port
- The port value used to access the endpoint.
EndpointSetting
data EndpointSetting Source #
Endpoint settings.
See: newEndpointSetting
smart constructor.
Constructors
EndpointSetting' (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe EndpointSettingTypeValue) (Maybe [Text]) |
Instances
newEndpointSetting :: EndpointSetting Source #
Create a value of EndpointSetting
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:sensitive:EndpointSetting'
, endpointSetting_sensitive
- A value that marks this endpoint setting as sensitive.
$sel:intValueMax:EndpointSetting'
, endpointSetting_intValueMax
- The maximum value of an endpoint setting that is of type int
.
$sel:applicability:EndpointSetting'
, endpointSetting_applicability
- The relevance or validity of an endpoint setting for an engine name and
its endpoint type.
$sel:name:EndpointSetting'
, endpointSetting_name
- The name that you want to give the endpoint settings.
$sel:intValueMin:EndpointSetting'
, endpointSetting_intValueMin
- The minimum value of an endpoint setting that is of type int
.
$sel:units:EndpointSetting'
, endpointSetting_units
- The unit of measure for this endpoint setting.
$sel:defaultValue:EndpointSetting'
, endpointSetting_defaultValue
- The default value of the endpoint setting if no value is specified using
CreateEndpoint
or ModifyEndpoint
.
$sel:type':EndpointSetting'
, endpointSetting_type
- The type of endpoint. Valid values are source
and target
.
$sel:enumValues:EndpointSetting'
, endpointSetting_enumValues
- Enumerated values to use for this endpoint.
Event
Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the DMS resource type.
See: newEvent
smart constructor.
Instances
Create a value of Event
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:sourceType:Event'
, event_sourceType
- The type of DMS resource that generates events.
Valid values: replication-instance | endpoint | replication-task
$sel:sourceIdentifier:Event'
, event_sourceIdentifier
- The identifier of an event source.
$sel:date:Event'
, event_date
- The date of the event.
$sel:eventCategories:Event'
, event_eventCategories
- The event categories available for the specified source type.
$sel:message:Event'
, event_message
- The event message.
EventCategoryGroup
data EventCategoryGroup Source #
Lists categories of events subscribed to, and generated by, the applicable DMS resource type. This data type appears in response to the DescribeEventCategories action.
See: newEventCategoryGroup
smart constructor.
Constructors
EventCategoryGroup' (Maybe Text) (Maybe [Text]) |
Instances
newEventCategoryGroup :: EventCategoryGroup Source #
Create a value of EventCategoryGroup
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:sourceType:EventCategoryGroup'
, eventCategoryGroup_sourceType
- The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
$sel:eventCategories:EventCategoryGroup'
, eventCategoryGroup_eventCategories
- A list of event categories from a source type that you've chosen.
EventSubscription
data EventSubscription Source #
Describes an event notification subscription created by the
CreateEventSubscription
operation.
See: newEventSubscription
smart constructor.
Constructors
EventSubscription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) |
Instances
newEventSubscription :: EventSubscription Source #
Create a value of EventSubscription
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:EventSubscription'
, eventSubscription_status
- The status of the DMS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that DMS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
$sel:customerAwsId:EventSubscription'
, eventSubscription_customerAwsId
- The Amazon Web Services customer account associated with the DMS event
notification subscription.
$sel:custSubscriptionId:EventSubscription'
, eventSubscription_custSubscriptionId
- The DMS event notification subscription Id.
$sel:snsTopicArn:EventSubscription'
, eventSubscription_snsTopicArn
- The topic ARN of the DMS event notification subscription.
$sel:enabled:EventSubscription'
, eventSubscription_enabled
- Boolean value that indicates if the event subscription is enabled.
$sel:sourceType:EventSubscription'
, eventSubscription_sourceType
- The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
$sel:subscriptionCreationTime:EventSubscription'
, eventSubscription_subscriptionCreationTime
- The time the DMS event notification subscription was created.
$sel:eventCategoriesList:EventSubscription'
, eventSubscription_eventCategoriesList
- A lists of event categories.
$sel:sourceIdsList:EventSubscription'
, eventSubscription_sourceIdsList
- A list of source Ids for the event subscription.
Filter
Identifies the name and value of a filter object. This filter is used to
limit the number and type of DMS objects that are returned for a
particular Describe*
call or similar operation. Filters are used as an
optional parameter for certain API operations.
See: newFilter
smart constructor.
Instances
Eq Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
Generic Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.DMS.Types.Filter | |
Hashable Filter Source # | |
Defined in Amazonka.DMS.Types.Filter | |
ToJSON Filter Source # | |
Defined in Amazonka.DMS.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.DMS.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.DMS.Types.Filter" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) |
Create a value of Filter
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:Filter'
, filter_name
- The name of the filter as specified for a Describe*
or similar
operation.
$sel:values:Filter'
, filter_values
- The filter value, which can specify one or more values used to narrow
the returned results.
IBMDb2Settings
data IBMDb2Settings Source #
Provides information that defines an IBM Db2 LUW endpoint.
See: newIBMDb2Settings
smart constructor.
Constructors
IBMDb2Settings' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) |
Instances
newIBMDb2Settings :: IBMDb2Settings Source #
Create a value of IBMDb2Settings
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:serverName:IBMDb2Settings'
, iBMDb2Settings_serverName
- Fully qualified domain name of the endpoint.
$sel:currentLsn:IBMDb2Settings'
, iBMDb2Settings_currentLsn
- For ongoing replication (CDC), use CurrentLSN to specify a log sequence
number (LSN) where you want the replication to start.
$sel:setDataCaptureChanges:IBMDb2Settings'
, iBMDb2Settings_setDataCaptureChanges
- Enables ongoing replication (CDC) as a BOOLEAN value. The default is
true.
$sel:secretsManagerAccessRoleArn:IBMDb2Settings'
, iBMDb2Settings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the Db2 LUW endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:username:IBMDb2Settings'
, iBMDb2Settings_username
- Endpoint connection user name.
$sel:password:IBMDb2Settings'
, iBMDb2Settings_password
- Endpoint connection password.
$sel:databaseName:IBMDb2Settings'
, iBMDb2Settings_databaseName
- Database name for the endpoint.
$sel:secretsManagerSecretId:IBMDb2Settings'
, iBMDb2Settings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the Db2 LUW endpoint connection
details.
$sel:maxKBytesPerRead:IBMDb2Settings'
, iBMDb2Settings_maxKBytesPerRead
- Maximum number of bytes per read, as a NUMBER value. The default is 64
KB.
$sel:port:IBMDb2Settings'
, iBMDb2Settings_port
- Endpoint TCP port. The default value is 50000.
KafkaSettings
data KafkaSettings Source #
Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.
See: newKafkaSettings
smart constructor.
Constructors
KafkaSettings' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe MessageFormatValue) (Maybe KafkaSecurityProtocol) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) |
Instances
newKafkaSettings :: KafkaSettings Source #
Create a value of KafkaSettings
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:sslClientKeyArn:KafkaSettings'
, kafkaSettings_sslClientKeyArn
- The Amazon Resource Name (ARN) for the client private key used to
securely connect to a Kafka target endpoint.
$sel:includeTransactionDetails:KafkaSettings'
, kafkaSettings_includeTransactionDetails
- Provides detailed transaction information from the source database. This
information includes a commit timestamp, a log position, and values for
transaction_id
, previous transaction_id
, and transaction_record_id
(the record offset within a transaction). The default is false
.
$sel:includeTableAlterOperations:KafkaSettings'
, kafkaSettings_includeTableAlterOperations
- Includes any data definition language (DDL) operations that change the
table in the control data, such as rename-table
, drop-table
,
add-column
, drop-column
, and rename-column
. The default is
false
.
$sel:sslClientCertificateArn:KafkaSettings'
, kafkaSettings_sslClientCertificateArn
- The Amazon Resource Name (ARN) of the client certificate used to
securely connect to a Kafka target endpoint.
$sel:sslCaCertificateArn:KafkaSettings'
, kafkaSettings_sslCaCertificateArn
- The Amazon Resource Name (ARN) for the private certificate authority
(CA) cert that DMS uses to securely connect to your Kafka target
endpoint.
$sel:partitionIncludeSchemaTable:KafkaSettings'
, kafkaSettings_partitionIncludeSchemaTable
- Prefixes schema and table names to partition values, when the partition
type is primary-key-type
. Doing this increases data distribution among
Kafka partitions. For example, suppose that a SysBench schema has
thousands of tables and each table has only limited range for a primary
key. In this case, the same primary key is sent from thousands of tables
to the same partition, which causes throttling. The default is false
.
$sel:topic:KafkaSettings'
, kafkaSettings_topic
- The topic to which you migrate the data. If you don't specify a topic,
DMS specifies "kafka-default-topic"
as the migration topic.
$sel:includeControlDetails:KafkaSettings'
, kafkaSettings_includeControlDetails
- Shows detailed control information for table definition, column
definition, and table and column changes in the Kafka message output.
The default is false
.
$sel:noHexPrefix:KafkaSettings'
, kafkaSettings_noHexPrefix
- Set this optional parameter to true
to avoid adding a '0x' prefix to
raw data in hexadecimal format. For example, by default, DMS adds a
'0x' prefix to the LOB column type in hexadecimal format moving from
an Oracle source to a Kafka target. Use the NoHexPrefix
endpoint
setting to enable migration of RAW data type columns without adding the
'0x' prefix.
$sel:saslPassword:KafkaSettings'
, kafkaSettings_saslPassword
- The secure password you created when you first set up your MSK cluster
to validate a client identity and make an encrypted connection between
server and client using SASL-SSL authentication.
$sel:sslClientKeyPassword:KafkaSettings'
, kafkaSettings_sslClientKeyPassword
- The password for the client private key used to securely connect to a
Kafka target endpoint.
$sel:includePartitionValue:KafkaSettings'
, kafkaSettings_includePartitionValue
- Shows the partition value within the Kafka message output unless the
partition type is schema-table-type
. The default is false
.
$sel:messageFormat:KafkaSettings'
, kafkaSettings_messageFormat
- The output format for the records created on the endpoint. The message
format is JSON
(default) or JSON_UNFORMATTED
(a single line with no
tab).
$sel:securityProtocol:KafkaSettings'
, kafkaSettings_securityProtocol
- Set secure connection to a Kafka target endpoint using Transport Layer
Security (TLS). Options include ssl-encryption
, ssl-authentication
,
and sasl-ssl
. sasl-ssl
requires SaslUsername
and SaslPassword
.
$sel:saslUsername:KafkaSettings'
, kafkaSettings_saslUsername
- The secure user name you created when you first set up your MSK cluster
to validate a client identity and make an encrypted connection between
server and client using SASL-SSL authentication.
$sel:broker:KafkaSettings'
, kafkaSettings_broker
- A comma-separated list of one or more broker locations in your Kafka
cluster that host your Kafka instance. Specify each broker location in
the form broker-hostname-or-ip:port
. For example,
"ec2-12-345-678-901.compute-1.amazonaws.com:2345"
. For more
information and examples of specifying a list of broker locations, see
Using Apache Kafka as a target for Database Migration Service
in the Database Migration Service User Guide.
$sel:messageMaxBytes:KafkaSettings'
, kafkaSettings_messageMaxBytes
- The maximum size in bytes for records created on the endpoint The
default is 1,000,000.
$sel:includeNullAndEmpty:KafkaSettings'
, kafkaSettings_includeNullAndEmpty
- Include NULL and empty columns for records migrated to the endpoint. The
default is false
.
KinesisSettings
data KinesisSettings Source #
Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.
See: newKinesisSettings
smart constructor.
Constructors
KinesisSettings' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe MessageFormatValue) (Maybe Bool) |
Instances
newKinesisSettings :: KinesisSettings Source #
Create a value of KinesisSettings
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:includeTransactionDetails:KinesisSettings'
, kinesisSettings_includeTransactionDetails
- Provides detailed transaction information from the source database. This
information includes a commit timestamp, a log position, and values for
transaction_id
, previous transaction_id
, and transaction_record_id
(the record offset within a transaction). The default is false
.
$sel:includeTableAlterOperations:KinesisSettings'
, kinesisSettings_includeTableAlterOperations
- Includes any data definition language (DDL) operations that change the
table in the control data, such as rename-table
, drop-table
,
add-column
, drop-column
, and rename-column
. The default is
false
.
$sel:serviceAccessRoleArn:KinesisSettings'
, kinesisSettings_serviceAccessRoleArn
- The Amazon Resource Name (ARN) for the IAM role that DMS uses to write
to the Kinesis data stream. The role must allow the iam:PassRole
action.
$sel:partitionIncludeSchemaTable:KinesisSettings'
, kinesisSettings_partitionIncludeSchemaTable
- Prefixes schema and table names to partition values, when the partition
type is primary-key-type
. Doing this increases data distribution among
Kinesis shards. For example, suppose that a SysBench schema has
thousands of tables and each table has only limited range for a primary
key. In this case, the same primary key is sent from thousands of tables
to the same shard, which causes throttling. The default is false
.
$sel:streamArn:KinesisSettings'
, kinesisSettings_streamArn
- The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams
endpoint.
$sel:includeControlDetails:KinesisSettings'
, kinesisSettings_includeControlDetails
- Shows detailed control information for table definition, column
definition, and table and column changes in the Kinesis message output.
The default is false
.
$sel:noHexPrefix:KinesisSettings'
, kinesisSettings_noHexPrefix
- Set this optional parameter to true
to avoid adding a '0x' prefix to
raw data in hexadecimal format. For example, by default, DMS adds a
'0x' prefix to the LOB column type in hexadecimal format moving from
an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix
endpoint setting to enable migration of RAW data type columns without
adding the '0x' prefix.
$sel:includePartitionValue:KinesisSettings'
, kinesisSettings_includePartitionValue
- Shows the partition value within the Kinesis message output, unless the
partition type is schema-table-type
. The default is false
.
$sel:messageFormat:KinesisSettings'
, kinesisSettings_messageFormat
- The output format for the records created on the endpoint. The message
format is JSON
(default) or JSON_UNFORMATTED
(a single line with no
tab).
$sel:includeNullAndEmpty:KinesisSettings'
, kinesisSettings_includeNullAndEmpty
- Include NULL and empty columns for records migrated to the endpoint. The
default is false
.
MicrosoftSQLServerSettings
data MicrosoftSQLServerSettings Source #
Provides information that defines a Microsoft SQL Server endpoint.
See: newMicrosoftSQLServerSettings
smart constructor.
Constructors
MicrosoftSQLServerSettings' (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe SafeguardPolicy) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) |
Instances
newMicrosoftSQLServerSettings :: MicrosoftSQLServerSettings Source #
Create a value of MicrosoftSQLServerSettings
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:bcpPacketSize:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_bcpPacketSize
- The maximum size of the packets (in bytes) used to transfer data using
BCP.
$sel:useBcpFullLoad:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_useBcpFullLoad
- Use this to attribute to transfer data for full-load operations using
BCP. When the target table contains an identity column that does not
exist in the source table, you must disable the use BCP for loading
table option.
$sel:serverName:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_serverName
- Fully qualified domain name of the endpoint.
$sel:querySingleAlwaysOnNode:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_querySingleAlwaysOnNode
- Cleans and recreates table metadata information on the replication
instance when a mismatch occurs. An example is a situation where running
an alter DDL statement on a table might result in different information
about the table cached in the replication instance.
$sel:secretsManagerAccessRoleArn:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the SQL Server endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:username:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_username
- Endpoint connection user name.
$sel:safeguardPolicy:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_safeguardPolicy
- Use this attribute to minimize the need to access the backup log and
enable DMS to prevent truncation using one of the following two methods.
Start transactions in the database: This is the default method. When this method is used, DMS prevents TLOG truncation by mimicking a transaction in the database. As long as such a transaction is open, changes that appear after the transaction started aren't truncated. If you need Microsoft Replication to be enabled in your database, then you must choose this method.
Exclusively use sp_repldone within a single task: When this method is used, DMS reads the changes and then uses sp_repldone to mark the TLOG transactions as ready for truncation. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running. Also, when using this method, only one DMS task can access the database at any given time. Therefore, if you need to run parallel DMS tasks against the same database, use the default method.
$sel:password:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_password
- Endpoint connection password.
$sel:databaseName:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_databaseName
- Database name for the endpoint.
$sel:secretsManagerSecretId:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the SQL Server endpoint connection
details.
$sel:readBackupOnly:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_readBackupOnly
- When this attribute is set to Y
, DMS only reads changes from
transaction log backups and doesn't read from the active transaction
log file during ongoing replication. Setting this parameter to Y
enables you to control active transaction log file growth during full
load and ongoing replication tasks. However, it can add some source
latency to ongoing replication.
$sel:useThirdPartyBackupDevice:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_useThirdPartyBackupDevice
- When this attribute is set to Y
, DMS processes third-party transaction
log backups if they are created in native format.
$sel:controlTablesFileGroup:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_controlTablesFileGroup
- Specifies a file group for the DMS internal tables. When the replication
task starts, all the internal DMS control tables (awsdms_
apply_exception, awsdms_apply, awsdms_changes) are created for the
specified file group.
$sel:port:MicrosoftSQLServerSettings'
, microsoftSQLServerSettings_port
- Endpoint TCP port.
MongoDbSettings
data MongoDbSettings Source #
Provides information that defines a MongoDB endpoint.
See: newMongoDbSettings
smart constructor.
Constructors
MongoDbSettings' (Maybe Text) (Maybe Text) (Maybe AuthMechanismValue) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe NestingLevelValue) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AuthTypeValue) (Maybe Int) |
Instances
newMongoDbSettings :: MongoDbSettings Source #
Create a value of MongoDbSettings
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:serverName:MongoDbSettings'
, mongoDbSettings_serverName
- The name of the server on the MongoDB source endpoint.
$sel:secretsManagerAccessRoleArn:MongoDbSettings'
, mongoDbSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the MongoDB endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:authMechanism:MongoDbSettings'
, mongoDbSettings_authMechanism
- The authentication mechanism you use to access the MongoDB source
endpoint.
For the default value, in MongoDB version 2.x, "default"
is
"mongodb_cr"
. For MongoDB version 3.x or later, "default"
is
"scram_sha_1"
. This setting isn't used when AuthType
is set to
"no"
.
$sel:username:MongoDbSettings'
, mongoDbSettings_username
- The user name you use to access the MongoDB source endpoint.
$sel:kmsKeyId:MongoDbSettings'
, mongoDbSettings_kmsKeyId
- The KMS key identifier that is used to encrypt the content on the
replication instance. If you don't specify a value for the KmsKeyId
parameter, then DMS uses your default encryption key. KMS creates the
default encryption key for your Amazon Web Services account. Your Amazon
Web Services account has a different default encryption key for each
Amazon Web Services Region.
$sel:password:MongoDbSettings'
, mongoDbSettings_password
- The password for the user account you use to access the MongoDB source
endpoint.
$sel:nestingLevel:MongoDbSettings'
, mongoDbSettings_nestingLevel
- Specifies either document or table mode.
Default value is "none"
. Specify "none"
to use document mode.
Specify "one"
to use table mode.
$sel:databaseName:MongoDbSettings'
, mongoDbSettings_databaseName
- The database name on the MongoDB source endpoint.
$sel:docsToInvestigate:MongoDbSettings'
, mongoDbSettings_docsToInvestigate
- Indicates the number of documents to preview to determine the document
organization. Use this setting when NestingLevel
is set to "one"
.
Must be a positive value greater than 0
. Default value is 1000
.
$sel:authSource:MongoDbSettings'
, mongoDbSettings_authSource
- The MongoDB database name. This setting isn't used when AuthType
is
set to "no"
.
The default is "admin"
.
$sel:secretsManagerSecretId:MongoDbSettings'
, mongoDbSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the MongoDB endpoint connection
details.
$sel:extractDocId:MongoDbSettings'
, mongoDbSettings_extractDocId
- Specifies the document ID. Use this setting when NestingLevel
is set
to "none"
.
Default value is "false"
.
$sel:authType:MongoDbSettings'
, mongoDbSettings_authType
- The authentication type you use to access the MongoDB source endpoint.
When when set to "no"
, user name and password parameters are not
used and can be empty.
$sel:port:MongoDbSettings'
, mongoDbSettings_port
- The port value for the MongoDB source endpoint.
MySQLSettings
data MySQLSettings Source #
Provides information that defines a MySQL endpoint.
See: newMySQLSettings
smart constructor.
Constructors
MySQLSettings' (Maybe Int) (Maybe TargetDbType) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) |
Instances
newMySQLSettings :: MySQLSettings Source #
Create a value of MySQLSettings
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:maxFileSize:MySQLSettings'
, mySQLSettings_maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer
data to a MySQL-compatible database.
Example: maxFileSize=512
$sel:targetDbType:MySQLSettings'
, mySQLSettings_targetDbType
- Specifies where to migrate source tables on the target, either to a
single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
$sel:serverName:MySQLSettings'
, mySQLSettings_serverName
- Fully qualified domain name of the endpoint.
$sel:cleanSourceMetadataOnMismatch:MySQLSettings'
, mySQLSettings_cleanSourceMetadataOnMismatch
- Adjusts the behavior of DMS when migrating from an SQL Server source
database that is hosted as part of an Always On availability group
cluster. If you need DMS to poll all the nodes in the Always On cluster
for transaction backups, set this attribute to false
.
$sel:parallelLoadThreads:MySQLSettings'
, mySQLSettings_parallelLoadThreads
- Improves performance when loading data into the MySQL-compatible target
database. Specifies how many threads to use to load the data into the
MySQL-compatible target database. Setting a large number of threads can
have an adverse effect on database performance, because a separate
connection is required for each thread.
Example: parallelLoadThreads=1
$sel:secretsManagerAccessRoleArn:MySQLSettings'
, mySQLSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the MySQL endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:username:MySQLSettings'
, mySQLSettings_username
- Endpoint connection user name.
$sel:password:MySQLSettings'
, mySQLSettings_password
- Endpoint connection password.
$sel:eventsPollInterval:MySQLSettings'
, mySQLSettings_eventsPollInterval
- Specifies how often to check the binary log for new changes/events when
the database is idle.
Example: eventsPollInterval=5;
In the example, DMS checks for changes in the binary logs every five seconds.
$sel:databaseName:MySQLSettings'
, mySQLSettings_databaseName
- Database name for the endpoint. For a MySQL source or target endpoint,
don't explicitly specify the database using the DatabaseName
request
parameter on either the CreateEndpoint
or ModifyEndpoint
API call.
Specifying DatabaseName
when you create or modify a MySQL endpoint
replicates all the task tables to this single database. For MySQL
endpoints, you specify the database only when you specify the schema in
the table-mapping rules of the DMS task.
$sel:afterConnectScript:MySQLSettings'
, mySQLSettings_afterConnectScript
- Specifies a script to run immediately after DMS connects to the
endpoint. The migration task continues running regardless if the SQL
statement succeeds or fails.
For this parameter, provide the code of the script itself, not the name of a file containing the script.
$sel:secretsManagerSecretId:MySQLSettings'
, mySQLSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the MySQL endpoint connection
details.
$sel:serverTimezone:MySQLSettings'
, mySQLSettings_serverTimezone
- Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
$sel:port:MySQLSettings'
, mySQLSettings_port
- Endpoint TCP port.
NeptuneSettings
data NeptuneSettings Source #
Provides information that defines an Amazon Neptune endpoint.
See: newNeptuneSettings
smart constructor.
Constructors
NeptuneSettings' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Int) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> NeptuneSettings |
Create a value of NeptuneSettings
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:maxFileSize:NeptuneSettings'
, neptuneSettings_maxFileSize
- The maximum size in kilobytes of migrated graph data stored in a .csv
file before DMS bulk-loads the data to the Neptune target database. The
default is 1,048,576 KB. If the bulk load is successful, DMS clears the
bucket, ready to store the next batch of migrated graph data.
$sel:maxRetryCount:NeptuneSettings'
, neptuneSettings_maxRetryCount
- The number of times for DMS to retry a bulk load of migrated graph data
to the Neptune target database before raising an error. The default is
5.
$sel:serviceAccessRoleArn:NeptuneSettings'
, neptuneSettings_serviceAccessRoleArn
- The Amazon Resource Name (ARN) of the service role that you created for
the Neptune target endpoint. The role must allow the iam:PassRole
action. For more information, see
Creating an IAM Service Role for Accessing Amazon Neptune as a Target
in the Database Migration Service User Guide.
$sel:iamAuthEnabled:NeptuneSettings'
, neptuneSettings_iamAuthEnabled
- If you want Identity and Access Management (IAM) authorization enabled
for this endpoint, set this parameter to true
. Then attach the
appropriate IAM policy document to your service role specified by
ServiceAccessRoleArn
. The default is false
.
$sel:errorRetryDuration:NeptuneSettings'
, neptuneSettings_errorRetryDuration
- The number of milliseconds for DMS to wait to retry a bulk-load of
migrated graph data to the Neptune target database before raising an
error. The default is 250.
$sel:s3BucketName:NeptuneSettings'
, neptuneSettings_s3BucketName
- The name of the Amazon S3 bucket where DMS can temporarily store
migrated graph data in .csv files before bulk-loading it to the Neptune
target database. DMS maps the SQL source data to graph data before
storing it in these .csv files.
$sel:s3BucketFolder:NeptuneSettings'
, neptuneSettings_s3BucketFolder
- A folder path where you want DMS to store migrated graph data in the S3
bucket specified by S3BucketName
OracleSettings
data OracleSettings Source #
Provides information that defines an Oracle endpoint.
See: newOracleSettings
smart constructor.
Constructors
OracleSettings' (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [Int]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe CharLengthSemantics) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Int) |
Instances
newOracleSettings :: OracleSettings Source #
Create a value of OracleSettings
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:useBFile:OracleSettings'
, oracleSettings_useBFile
- Set this attribute to Y to capture change data using the Binary Reader
utility. Set UseLogminerReader
to N to set this attribute to Y. To use
Binary Reader with Amazon RDS for Oracle as the source, you set
additional attributes. For more information about using this setting
with Oracle Automatic Storage Management (ASM), see
Using Oracle LogMiner or DMS Binary Reader for CDC.
$sel:standbyDelayTime:OracleSettings'
, oracleSettings_standbyDelayTime
- Use this attribute to specify a time in minutes for the delay in standby
sync. If the source is an Oracle Active Data Guard standby database, use
this attribute to specify the time lag between primary and standby
databases.
In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.
$sel:failTasksOnLobTruncation:OracleSettings'
, oracleSettings_failTasksOnLobTruncation
- When set to true
, this attribute causes a task to fail if the actual
size of an LOB column is greater than the specified LobMaxSize
.
If a task is set to limited LOB mode and this option is set to true
,
the task fails instead of truncating the LOB data.
$sel:serverName:OracleSettings'
, oracleSettings_serverName
- Fully qualified domain name of the endpoint.
$sel:directPathNoLog:OracleSettings'
, oracleSettings_directPathNoLog
- When set to true
, this attribute helps to increase the commit rate on
the Oracle target database by writing directly to tables and not writing
a trail to database logs.
$sel:extraArchivedLogDestIds:OracleSettings'
, oracleSettings_extraArchivedLogDestIds
- Specifies the IDs of one more destinations for one or more archived redo
logs. These IDs are the values of the dest_id
column in the
v$archived_log
view. Use this setting with the archivedLogDestId
extra connection attribute in a primary-to-single setup or a
primary-to-multiple-standby setup.
This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.
archivedLogDestId=1; ExtraArchivedLogDestIds=[2]
In a primary-to-multiple-standby setup, you might apply the following settings.
archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]
Although DMS supports the use of the Oracle RESETLOGS
option to open
the database, never use RESETLOGS
unless it's necessary. For more
information about RESETLOGS
, see
RMAN Data Repair Concepts
in the Oracle Database Backup and Recovery User's Guide.
$sel:securityDbEncryptionName:OracleSettings'
, oracleSettings_securityDbEncryptionName
- For an Oracle source endpoint, the name of a key used for the
transparent data encryption (TDE) of the columns and tablespaces in an
Oracle source database that is encrypted using TDE. The key value is the
value of the SecurityDbEncryption
setting. For more information on
setting the key name value of SecurityDbEncryptionName
, see the
information and example for setting the securityDbEncryptionName
extra
connection attribute in
Supported encryption methods for using Oracle as a source for DMS
in the Database Migration Service User Guide.
$sel:oraclePathPrefix:OracleSettings'
, oracleSettings_oraclePathPrefix
- Set this string attribute to the required value in order to use the
Binary Reader to capture change data for an Amazon RDS for Oracle as the
source. This value specifies the default Oracle root used to access the
redo logs.
$sel:secretsManagerAccessRoleArn:OracleSettings'
, oracleSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the Oracle endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:useDirectPathFullLoad:OracleSettings'
, oracleSettings_useDirectPathFullLoad
- Set this attribute to Y to have DMS use a direct path full load. Specify
this value to use the direct path protocol in the Oracle Call Interface
(OCI). By using this OCI protocol, you can bulk-load Oracle target
tables during a full load.
$sel:username:OracleSettings'
, oracleSettings_username
- Endpoint connection user name.
$sel:allowSelectNestedTables:OracleSettings'
, oracleSettings_allowSelectNestedTables
- Set this attribute to true
to enable replication of Oracle tables
containing columns that are nested tables or defined types.
$sel:readAheadBlocks:OracleSettings'
, oracleSettings_readAheadBlocks
- Set this attribute to change the number of read-ahead blocks that DMS
configures to perform a change data capture (CDC) load using Oracle
Automatic Storage Management (ASM). You can specify an integer value
between 1000 (the default) and 200,000 (the maximum).
$sel:archivedLogDestId:OracleSettings'
, oracleSettings_archivedLogDestId
- Specifies the ID of the destination for the archived redo logs. This
value should be the same as a number in the dest_id column of the
v$archived_log view. If you work with an additional redo log
destination, use the AdditionalArchivedLogDestId
option to specify the
additional destination ID. Doing this improves performance by ensuring
that the correct logs are accessed from the outset.
$sel:replacePathPrefix:OracleSettings'
, oracleSettings_replacePathPrefix
- Set this attribute to true in order to use the Binary Reader to capture
change data for an Amazon RDS for Oracle as the source. This setting
tells DMS instance to replace the default Oracle root with the specified
usePathPrefix
setting to access the redo logs.
$sel:accessAlternateDirectly:OracleSettings'
, oracleSettings_accessAlternateDirectly
- Set this attribute to false
in order to use the Binary Reader to
capture change data for an Amazon RDS for Oracle as the source. This
tells the DMS instance to not access redo logs through any specified
path prefix replacement using direct file access.
$sel:secretsManagerOracleAsmSecretId:OracleSettings'
, oracleSettings_secretsManagerOracleAsmSecretId
- Required only if your Oracle endpoint uses Advanced Storage Manager
(ASM). The full ARN, partial ARN, or friendly name of the
SecretsManagerOracleAsmSecret
that contains the Oracle ASM connection
details for the Oracle endpoint.
$sel:securityDbEncryption:OracleSettings'
, oracleSettings_securityDbEncryption
- For an Oracle source endpoint, the transparent data encryption (TDE)
password required by AWM DMS to access Oracle redo logs encrypted by TDE
using Binary Reader. It is also the TDE_Password
part of the
comma-separated value you set to the Password
request parameter when
you create the endpoint. The SecurityDbEncryptian
setting is related
to this SecurityDbEncryptionName
setting. For more information, see
Supported encryption methods for using Oracle as a source for DMS
in the Database Migration Service User Guide.
$sel:useLogminerReader:OracleSettings'
, oracleSettings_useLogminerReader
- Set this attribute to Y to capture change data using the Oracle LogMiner
utility (the default). Set this attribute to N if you want to access the
redo logs as a binary file. When you set UseLogminerReader
to N, also
set UseBfile
to Y. For more information on this setting and using
Oracle ASM, see
Using Oracle LogMiner or DMS Binary Reader for CDC
in the DMS User Guide.
$sel:readTableSpaceName:OracleSettings'
, oracleSettings_readTableSpaceName
- When set to true
, this attribute supports tablespace replication.
$sel:retryInterval:OracleSettings'
, oracleSettings_retryInterval
- Specifies the number of seconds that the system waits before resending a
query.
Example: retryInterval=6;
$sel:password:OracleSettings'
, oracleSettings_password
- Endpoint connection password.
$sel:spatialDataOptionToGeoJsonFunctionName:OracleSettings'
, oracleSettings_spatialDataOptionToGeoJsonFunctionName
- Use this attribute to convert SDO_GEOMETRY
to GEOJSON
format. By
default, DMS calls the SDO2GEOJSON
custom function if present and
accessible. Or you can create your own custom function that mimics the
operation of SDOGEOJSON
and set
SpatialDataOptionToGeoJsonFunctionName
to call it instead.
$sel:databaseName:OracleSettings'
, oracleSettings_databaseName
- Database name for the endpoint.
$sel:addSupplementalLogging:OracleSettings'
, oracleSettings_addSupplementalLogging
- Set this attribute to set up table-level supplemental logging for the
Oracle database. This attribute enables PRIMARY KEY supplemental logging
on all tables selected for a migration task.
If you use this option, you still need to enable database-level supplemental logging.
$sel:secretsManagerOracleAsmAccessRoleArn:OracleSettings'
, oracleSettings_secretsManagerOracleAsmAccessRoleArn
- Required only if your Oracle endpoint uses Advanced Storage Manager
(ASM). The full ARN of the IAM role that specifies DMS as the trusted
entity and grants the required permissions to access the
SecretsManagerOracleAsmSecret
. This SecretsManagerOracleAsmSecret
has the secret value that allows access to the Oracle ASM of the
endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and
SecretsManagerOracleAsmSecretId
. Or you can specify clear-text values
for AsmUserName
, AsmPassword
, and AsmServerName
. You can't
specify both. For more information on creating this
SecretsManagerOracleAsmSecret
and the
SecretsManagerOracleAsmAccessRoleArn
and
SecretsManagerOracleAsmSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:asmServer:OracleSettings'
, oracleSettings_asmServer
- For an Oracle source endpoint, your ASM server address. You can set this
value from the asm_server
value. You set asm_server
as part of the
extra connection attribute string to access an Oracle server with Binary
Reader that uses ASM. For more information, see
Configuration for change data capture (CDC) on an Oracle source database.
$sel:charLengthSemantics:OracleSettings'
, oracleSettings_charLengthSemantics
- Specifies whether the length of a character column is in bytes or in
characters. To indicate that the character column length is in
characters, set this attribute to CHAR
. Otherwise, the character
column length is in bytes.
Example: charLengthSemantics=CHAR;
$sel:archivedLogsOnly:OracleSettings'
, oracleSettings_archivedLogsOnly
- When this field is set to Y
, DMS only accesses the archived redo logs.
If the archived redo logs are stored on Oracle ASM only, the DMS user
account needs to be granted ASM privileges.
$sel:directPathParallelLoad:OracleSettings'
, oracleSettings_directPathParallelLoad
- When set to true
, this attribute specifies a parallel load when
useDirectPathFullLoad
is set to Y
. This attribute also only applies
when you use the DMS parallel load feature. Note that the target table
cannot have any constraints or indexes.
$sel:secretsManagerSecretId:OracleSettings'
, oracleSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the Oracle endpoint connection
details.
$sel:additionalArchivedLogDestId:OracleSettings'
, oracleSettings_additionalArchivedLogDestId
- Set this attribute with ArchivedLogDestId
in a primary/ standby
setup. This attribute is useful in the case of a switchover. In this
case, DMS needs to know which destination to get archive redo logs from
to read changes. This need arises because the previous primary instance
is now a standby instance after switchover.
Although DMS supports the use of the Oracle RESETLOGS
option to open
the database, never use RESETLOGS
unless necessary. For additional
information about RESETLOGS
, see
RMAN Data Repair Concepts
in the Oracle Database Backup and Recovery User's Guide.
$sel:asmPassword:OracleSettings'
, oracleSettings_asmPassword
- For an Oracle source endpoint, your Oracle Automatic Storage Management
(ASM) password. You can set this value from the asm_user_password
value. You set this value as part of the comma-separated value that you
set to the Password
request parameter when you create the endpoint to
access transaction logs using Binary Reader. For more information, see
Configuration for change data capture (CDC) on an Oracle source database.
$sel:enableHomogenousTablespace:OracleSettings'
, oracleSettings_enableHomogenousTablespace
- Set this attribute to enable homogenous tablespace replication and
create existing tables or indexes under the same tablespace on the
target.
$sel:parallelAsmReadThreads:OracleSettings'
, oracleSettings_parallelAsmReadThreads
- Set this attribute to change the number of threads that DMS configures
to perform a change data capture (CDC) load using Oracle Automatic
Storage Management (ASM). You can specify an integer value between 2
(the default) and 8 (the maximum). Use this attribute together with the
readAheadBlocks
attribute.
$sel:numberDatatypeScale:OracleSettings'
, oracleSettings_numberDatatypeScale
- Specifies the number scale. You can select a scale up to 38, or you can
select FLOAT. By default, the NUMBER data type is converted to precision
38, scale 10.
Example: numberDataTypeScale=12
$sel:usePathPrefix:OracleSettings'
, oracleSettings_usePathPrefix
- Set this string attribute to the required value in order to use the
Binary Reader to capture change data for an Amazon RDS for Oracle as the
source. This value specifies the path prefix used to replace the default
Oracle root to access the redo logs.
$sel:asmUser:OracleSettings'
, oracleSettings_asmUser
- For an Oracle source endpoint, your ASM user name. You can set this
value from the asm_user
value. You set asm_user
as part of the extra
connection attribute string to access an Oracle server with Binary
Reader that uses ASM. For more information, see
Configuration for change data capture (CDC) on an Oracle source database.
$sel:useAlternateFolderForOnline:OracleSettings'
, oracleSettings_useAlternateFolderForOnline
- Set this attribute to true
in order to use the Binary Reader to
capture change data for an Amazon RDS for Oracle as the source. This
tells the DMS instance to use any specified prefix replacement to access
all online redo logs.
$sel:port:OracleSettings'
, oracleSettings_port
- Endpoint TCP port.
OrderableReplicationInstance
data OrderableReplicationInstance Source #
In response to the DescribeOrderableReplicationInstances
operation,
this object describes an available replication instance. This
description includes the replication instance's type, engine version,
and allocated storage.
See: newOrderableReplicationInstance
smart constructor.
Constructors
OrderableReplicationInstance' (Maybe Text) (Maybe Int) (Maybe ReleaseStatusValues) (Maybe Int) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newOrderableReplicationInstance :: OrderableReplicationInstance Source #
Create a value of OrderableReplicationInstance
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:engineVersion:OrderableReplicationInstance'
, orderableReplicationInstance_engineVersion
- The version of the replication engine.
$sel:minAllocatedStorage:OrderableReplicationInstance'
, orderableReplicationInstance_minAllocatedStorage
- The minimum amount of storage (in gigabytes) that can be allocated for
the replication instance.
$sel:releaseStatus:OrderableReplicationInstance'
, orderableReplicationInstance_releaseStatus
- The value returned when the specified EngineVersion
of the replication
instance is in Beta or test mode. This indicates some features might not
work as expected.
DMS supports the ReleaseStatus
parameter in versions 3.1.4 and later.
$sel:includedAllocatedStorage:OrderableReplicationInstance'
, orderableReplicationInstance_includedAllocatedStorage
- The amount of storage (in gigabytes) that is allocated for the
replication instance.
$sel:availabilityZones:OrderableReplicationInstance'
, orderableReplicationInstance_availabilityZones
- List of Availability Zones for this replication instance.
$sel:maxAllocatedStorage:OrderableReplicationInstance'
, orderableReplicationInstance_maxAllocatedStorage
- The minimum amount of storage (in gigabytes) that can be allocated for
the replication instance.
$sel:replicationInstanceClass:OrderableReplicationInstance'
, orderableReplicationInstance_replicationInstanceClass
- The compute and memory capacity of the replication instance as defined
for the specified replication instance class. For example to specify the
instance class dms.c4.large, set this parameter to "dms.c4.large"
.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
$sel:defaultAllocatedStorage:OrderableReplicationInstance'
, orderableReplicationInstance_defaultAllocatedStorage
- The default amount of storage (in gigabytes) that is allocated for the
replication instance.
$sel:storageType:OrderableReplicationInstance'
, orderableReplicationInstance_storageType
- The type of storage used by the replication instance.
PendingMaintenanceAction
data PendingMaintenanceAction Source #
Describes a maintenance action pending for an DMS resource, including
when and how it will be applied. This data type is a response element to
the DescribePendingMaintenanceActions
operation.
See: newPendingMaintenanceAction
smart constructor.
Constructors
PendingMaintenanceAction' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newPendingMaintenanceAction :: PendingMaintenanceAction Source #
Create a value of PendingMaintenanceAction
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:autoAppliedAfterDate:PendingMaintenanceAction'
, pendingMaintenanceAction_autoAppliedAfterDate
- The date of the maintenance window when the action is to be applied. The
maintenance action is applied to the resource during its first
maintenance window after this date. If this date is specified, any
next-maintenance
opt-in requests are ignored.
$sel:action:PendingMaintenanceAction'
, pendingMaintenanceAction_action
- The type of pending maintenance action that is available for the
resource.
$sel:optInStatus:PendingMaintenanceAction'
, pendingMaintenanceAction_optInStatus
- The type of opt-in request that has been received for the resource.
$sel:description:PendingMaintenanceAction'
, pendingMaintenanceAction_description
- A description providing more detail about the maintenance action.
$sel:forcedApplyDate:PendingMaintenanceAction'
, pendingMaintenanceAction_forcedApplyDate
- The date when the maintenance action will be automatically applied. The
maintenance action is applied to the resource on this date regardless of
the maintenance window for the resource. If this date is specified, any
immediate
opt-in requests are ignored.
$sel:currentApplyDate:PendingMaintenanceAction'
, pendingMaintenanceAction_currentApplyDate
- The effective date when the pending maintenance action will be applied
to the resource. This date takes into account opt-in requests received
from the ApplyPendingMaintenanceAction
API operation, and also the
AutoAppliedAfterDate
and ForcedApplyDate
parameter values. This
value is blank if an opt-in request has not been received and nothing
has been specified for AutoAppliedAfterDate
or ForcedApplyDate
.
PostgreSQLSettings
data PostgreSQLSettings Source #
Provides information that defines a PostgreSQL endpoint.
See: newPostgreSQLSettings
smart constructor.
Constructors
PostgreSQLSettings' (Maybe Int) (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe PluginNameValue) (Maybe Int) (Maybe Text) (Maybe Bool) |
Instances
newPostgreSQLSettings :: PostgreSQLSettings Source #
Create a value of PostgreSQLSettings
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:executeTimeout:PostgreSQLSettings'
, postgreSQLSettings_executeTimeout
- Sets the client statement timeout for the PostgreSQL instance, in
seconds. The default value is 60 seconds.
Example: executeTimeout=100;
$sel:maxFileSize:PostgreSQLSettings'
, postgreSQLSettings_maxFileSize
- Specifies the maximum size (in KB) of any .csv file used to transfer
data to PostgreSQL.
Example: maxFileSize=512
$sel:failTasksOnLobTruncation:PostgreSQLSettings'
, postgreSQLSettings_failTasksOnLobTruncation
- When set to true
, this value causes a task to fail if the actual size
of a LOB column is greater than the specified LobMaxSize
.
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
$sel:serverName:PostgreSQLSettings'
, postgreSQLSettings_serverName
- Fully qualified domain name of the endpoint.
$sel:ddlArtifactsSchema:PostgreSQLSettings'
, postgreSQLSettings_ddlArtifactsSchema
- The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
$sel:slotName:PostgreSQLSettings'
, postgreSQLSettings_slotName
- Sets the name of a previously created logical replication slot for a
change data capture (CDC) load of the PostgreSQL source instance.
When used with the CdcStartPosition
request parameter for the DMS API
, this attribute also makes it possible to use native CDC start points.
DMS verifies that the specified logical replication slot exists before
starting the CDC load task. It also verifies that the task was created
with a valid setting of CdcStartPosition
. If the specified slot
doesn't exist or the task doesn't have a valid CdcStartPosition
setting, DMS raises an error.
For more information about setting the CdcStartPosition
request
parameter, see
Determining a CDC native start point
in the Database Migration Service User Guide. For more information
about using CdcStartPosition
, see
CreateReplicationTask,
StartReplicationTask,
and
ModifyReplicationTask.
$sel:secretsManagerAccessRoleArn:PostgreSQLSettings'
, postgreSQLSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the PostgreSQL endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:username:PostgreSQLSettings'
, postgreSQLSettings_username
- Endpoint connection user name.
$sel:heartbeatFrequency:PostgreSQLSettings'
, postgreSQLSettings_heartbeatFrequency
- Sets the WAL heartbeat frequency (in minutes).
$sel:password:PostgreSQLSettings'
, postgreSQLSettings_password
- Endpoint connection password.
$sel:databaseName:PostgreSQLSettings'
, postgreSQLSettings_databaseName
- Database name for the endpoint.
$sel:afterConnectScript:PostgreSQLSettings'
, postgreSQLSettings_afterConnectScript
- For use with change data capture (CDC) only, this attribute has DMS
bypass foreign keys and user triggers to reduce the time it takes to
bulk load data.
Example: afterConnectScript=SET session_replication_role='replica'
$sel:secretsManagerSecretId:PostgreSQLSettings'
, postgreSQLSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the PostgreSQL endpoint connection
details.
$sel:captureDdls:PostgreSQLSettings'
, postgreSQLSettings_captureDdls
- To capture DDL events, DMS creates various artifacts in the PostgreSQL
database when the task starts. You can later remove these artifacts.
If this value is set to N
, you don't have to create tables or
triggers on the source database.
$sel:pluginName:PostgreSQLSettings'
, postgreSQLSettings_pluginName
- Specifies the plugin to use to create a replication slot.
$sel:port:PostgreSQLSettings'
, postgreSQLSettings_port
- Endpoint TCP port.
$sel:heartbeatSchema:PostgreSQLSettings'
, postgreSQLSettings_heartbeatSchema
- Sets the schema in which the heartbeat artifacts are created.
$sel:heartbeatEnable:PostgreSQLSettings'
, postgreSQLSettings_heartbeatEnable
- The write-ahead log (WAL) heartbeat feature mimics a dummy transaction.
By doing this, it prevents idle logical replication slots from holding
onto old WAL logs, which can result in storage full situations on the
source. This heartbeat keeps restart_lsn
moving and prevents storage
full scenarios.
RedisSettings
data RedisSettings Source #
Provides information that defines a Redis target endpoint.
See: newRedisSettings
smart constructor.
Constructors
RedisSettings' (Maybe SslSecurityProtocolValue) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe RedisAuthTypeValue) Text Int |
Instances
Create a value of RedisSettings
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:sslSecurityProtocol:RedisSettings'
, redisSettings_sslSecurityProtocol
- The connection to a Redis target endpoint using Transport Layer Security
(TLS). Valid values include plaintext
and ssl-encryption
. The
default is ssl-encryption
. The ssl-encryption
option makes an
encrypted connection. Optionally, you can identify an Amazon Resource
Name (ARN) for an SSL certificate authority (CA) using the
SslCaCertificateArn
setting. If an ARN isn't given for a CA, DMS uses
the Amazon root CA.
The plaintext
option doesn't provide Transport Layer Security (TLS)
encryption for traffic between endpoint and database.
$sel:authUserName:RedisSettings'
, redisSettings_authUserName
- The user name provided with the auth-role
option of the AuthType
setting for a Redis target endpoint.
$sel:sslCaCertificateArn:RedisSettings'
, redisSettings_sslCaCertificateArn
- The Amazon Resource Name (ARN) for the certificate authority (CA) that
DMS uses to connect to your Redis target endpoint.
$sel:authPassword:RedisSettings'
, redisSettings_authPassword
- The password provided with the auth-role
and auth-token
options of
the AuthType
setting for a Redis target endpoint.
$sel:authType:RedisSettings'
, redisSettings_authType
- The type of authentication to perform when connecting to a Redis target.
Options include none
, auth-token
, and auth-role
. The auth-token
option requires an AuthPassword
value to be provided. The auth-role
option requires AuthUserName
and AuthPassword
values to be provided.
$sel:serverName:RedisSettings'
, redisSettings_serverName
- Fully qualified domain name of the endpoint.
$sel:port:RedisSettings'
, redisSettings_port
- Transmission Control Protocol (TCP) port for the endpoint.
RedshiftSettings
data RedshiftSettings Source #
Provides information that defines an Amazon Redshift endpoint.
See: newRedshiftSettings
smart constructor.
Constructors
RedshiftSettings' (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EncryptionModeValue) (Maybe Text) (Maybe Bool) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) |
Instances
newRedshiftSettings :: RedshiftSettings Source #
Create a value of RedshiftSettings
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:emptyAsNull:RedshiftSettings'
, redshiftSettings_emptyAsNull
- A value that specifies whether DMS should migrate empty CHAR and VARCHAR
fields as NULL. A value of true
sets empty CHAR and VARCHAR fields to
null. The default is false
.
$sel:caseSensitiveNames:RedshiftSettings'
, redshiftSettings_caseSensitiveNames
- If Amazon Redshift is configured to support case sensitive schema names,
set CaseSensitiveNames
to true
. The default is false
.
$sel:maxFileSize:RedshiftSettings'
, redshiftSettings_maxFileSize
- The maximum size (in KB) of any .csv file used to load data on an S3
bucket and transfer data to Amazon Redshift. It defaults to 1048576KB (1
GB).
$sel:replaceChars:RedshiftSettings'
, redshiftSettings_replaceChars
- A value that specifies to replaces the invalid characters specified in
ReplaceInvalidChars
, substituting the specified characters instead.
The default is "?"
.
$sel:serverName:RedshiftSettings'
, redshiftSettings_serverName
- The name of the Amazon Redshift cluster you are using.
$sel:connectionTimeout:RedshiftSettings'
, redshiftSettings_connectionTimeout
- A value that sets the amount of time to wait (in milliseconds) before
timing out, beginning from when you initially establish a connection.
$sel:loadTimeout:RedshiftSettings'
, redshiftSettings_loadTimeout
- The amount of time to wait (in milliseconds) before timing out of
operations performed by DMS on a Redshift cluster, such as Redshift
COPY, INSERT, DELETE, and UPDATE.
$sel:serviceAccessRoleArn:RedshiftSettings'
, redshiftSettings_serviceAccessRoleArn
- The Amazon Resource Name (ARN) of the IAM role that has access to the
Amazon Redshift service. The role must allow the iam:PassRole
action.
$sel:explicitIds:RedshiftSettings'
, redshiftSettings_explicitIds
- This setting is only valid for a full-load migration task. Set
ExplicitIds
to true
to have tables with IDENTITY
columns override
their auto-generated values with explicit values loaded from the source
data files used to populate the tables. The default is false
.
$sel:bucketFolder:RedshiftSettings'
, redshiftSettings_bucketFolder
- An S3 folder where the comma-separated-value (.csv) files are stored
before being uploaded to the target Redshift cluster.
For full load mode, DMS converts source records into .csv files and
loads them to the BucketFolder/TableID path. DMS uses the Redshift
COPY
command to upload the .csv files to the target table. The files
are deleted once the COPY
operation has finished. For more
information, see
COPY in the
Amazon Redshift Database Developer Guide.
For change-data-capture (CDC) mode, DMS creates a NetChanges table, and loads the .csv files to this BucketFolder/NetChangesTableID path.
$sel:truncateColumns:RedshiftSettings'
, redshiftSettings_truncateColumns
- A value that specifies to truncate data in columns to the appropriate
number of characters, so that the data fits in the column. This
parameter applies only to columns with a VARCHAR or CHAR data type, and
rows with a size of 4 MB or less. Choose true
to truncate data. The
default is false
.
$sel:secretsManagerAccessRoleArn:RedshiftSettings'
, redshiftSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the Amazon Redshift
endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:replaceInvalidChars:RedshiftSettings'
, redshiftSettings_replaceInvalidChars
- A list of characters that you want to replace. Use with ReplaceChars
.
$sel:username:RedshiftSettings'
, redshiftSettings_username
- An Amazon Redshift user name for a registered user.
$sel:bucketName:RedshiftSettings'
, redshiftSettings_bucketName
- The name of the intermediate S3 bucket used to store .csv files before
uploading data to Redshift.
$sel:encryptionMode:RedshiftSettings'
, redshiftSettings_encryptionMode
- The type of server-side encryption that you want to use for your data.
This encryption type is part of the endpoint settings or the extra
connections attributes for Amazon S3. You can choose either SSE_S3
(the default) or SSE_KMS
.
For the ModifyEndpoint
operation, you can change the existing value of
the EncryptionMode
parameter from SSE_KMS
to SSE_S3
. But you can’t
change the existing value from SSE_S3
to SSE_KMS
.
To use SSE_S3
, create an Identity and Access Management (IAM) role
with a policy that allows "arn:aws:s3:::*"
to use the following
actions: "s3:PutObject", "s3:ListBucket"
$sel:dateFormat:RedshiftSettings'
, redshiftSettings_dateFormat
- The date format that you are using. Valid values are auto
(case-sensitive), your date format string enclosed in quotes, or NULL.
If this parameter is left unset (NULL), it defaults to a format of
'YYYY-MM-DD'. Using auto
recognizes most strings, even some that
aren't supported when you use a date format string.
If your date and time values use formats different from each other, set
this to auto
.
$sel:removeQuotes:RedshiftSettings'
, redshiftSettings_removeQuotes
- A value that specifies to remove surrounding quotation marks from
strings in the incoming data. All characters within the quotation marks,
including delimiters, are retained. Choose true
to remove quotation
marks. The default is false
.
$sel:password:RedshiftSettings'
, redshiftSettings_password
- The password for the user named in the username
property.
$sel:databaseName:RedshiftSettings'
, redshiftSettings_databaseName
- The name of the Amazon Redshift data warehouse (service) that you are
working with.
$sel:acceptAnyDate:RedshiftSettings'
, redshiftSettings_acceptAnyDate
- A value that indicates to allow any date format, including invalid
formats such as 00/00/00 00:00:00, to be loaded without generating an
error. You can choose true
or false
(the default).
This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.
$sel:afterConnectScript:RedshiftSettings'
, redshiftSettings_afterConnectScript
- Code to run after connecting. This parameter should contain the code
itself, not the name of a file containing the code.
$sel:secretsManagerSecretId:RedshiftSettings'
, redshiftSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the Amazon Redshift endpoint
connection details.
$sel:writeBufferSize:RedshiftSettings'
, redshiftSettings_writeBufferSize
- The size (in KB) of the in-memory file write buffer used when generating
.csv files on the local disk at the DMS replication instance. The
default value is 1000 (buffer size is 1000KB).
$sel:compUpdate:RedshiftSettings'
, redshiftSettings_compUpdate
- If you set CompUpdate
to true
Amazon Redshift applies automatic
compression if the table is empty. This applies even if the table
columns already have encodings other than RAW
. If you set CompUpdate
to false
, automatic compression is disabled and existing column
encodings aren't changed. The default is true
.
$sel:trimBlanks:RedshiftSettings'
, redshiftSettings_trimBlanks
- A value that specifies to remove the trailing white space characters
from a VARCHAR string. This parameter applies only to columns with a
VARCHAR data type. Choose true
to remove unneeded white space. The
default is false
.
$sel:timeFormat:RedshiftSettings'
, redshiftSettings_timeFormat
- The time format that you want to use. Valid values are auto
(case-sensitive), 'timeformat_string'
, 'epochsecs'
, or
'epochmillisecs'
. It defaults to 10. Using auto
recognizes most
strings, even some that aren't supported when you use a time format
string.
If your date and time values use formats different from each other, set
this parameter to auto
.
$sel:serverSideEncryptionKmsKeyId:RedshiftSettings'
, redshiftSettings_serverSideEncryptionKmsKeyId
- The KMS key ID. If you are using SSE_KMS
for the EncryptionMode
,
provide this key ID. The key that you use needs an attached policy that
enables IAM user permissions and allows use of the key.
$sel:port:RedshiftSettings'
, redshiftSettings_port
- The port number for Amazon Redshift. The default value is 5439.
$sel:fileTransferUploadStreams:RedshiftSettings'
, redshiftSettings_fileTransferUploadStreams
- The number of threads used to upload a single file. This parameter
accepts a value from 1 through 64. It defaults to 10.
The number of parallel streams used to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more information, see Multipart upload overview.
FileTransferUploadStreams
accepts a value from 1 through 64. It
defaults to 10.
RefreshSchemasStatus
data RefreshSchemasStatus Source #
Provides information that describes status of a schema at an endpoint
specified by the DescribeRefreshSchemaStatus
operation.
See: newRefreshSchemasStatus
smart constructor.
Constructors
RefreshSchemasStatus' (Maybe RefreshSchemasStatusTypeValue) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newRefreshSchemasStatus :: RefreshSchemasStatus Source #
Create a value of RefreshSchemasStatus
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:RefreshSchemasStatus'
, refreshSchemasStatus_status
- The status of the schema.
$sel:lastRefreshDate:RefreshSchemasStatus'
, refreshSchemasStatus_lastRefreshDate
- The date the schema was last refreshed.
$sel:replicationInstanceArn:RefreshSchemasStatus'
, refreshSchemasStatus_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
$sel:endpointArn:RefreshSchemasStatus'
, refreshSchemasStatus_endpointArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
endpoint.
$sel:lastFailureMessage:RefreshSchemasStatus'
, refreshSchemasStatus_lastFailureMessage
- The last failure message for the schema.
ReplicationInstance
data ReplicationInstance Source #
Provides information that defines a replication instance.
See: newReplicationInstance
smart constructor.
Constructors
ReplicationInstance' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe ReplicationSubnetGroup) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [VpcSecurityGroupMembership]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReplicationPendingModifiedValues) |
Instances
newReplicationInstance :: ReplicationInstance Source #
Create a value of ReplicationInstance
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:engineVersion:ReplicationInstance'
, replicationInstance_engineVersion
- The engine version number of the replication instance.
If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgrade
to true
.
$sel:publiclyAccessible:ReplicationInstance'
, replicationInstance_publiclyAccessible
- Specifies the accessibility options for the replication instance. A
value of true
represents an instance with a public IP address. A value
of false
represents an instance with a private IP address. The default
value is true
.
$sel:autoMinorVersionUpgrade:ReplicationInstance'
, replicationInstance_autoMinorVersionUpgrade
- Boolean value indicating if minor version upgrades will be automatically
applied to the instance.
$sel:replicationInstancePublicIpAddresses:ReplicationInstance'
, replicationInstance_replicationInstancePublicIpAddresses
- One or more public IP addresses for the replication instance.
$sel:replicationSubnetGroup:ReplicationInstance'
, replicationInstance_replicationSubnetGroup
- The subnet group for the replication instance.
$sel:instanceCreateTime:ReplicationInstance'
, replicationInstance_instanceCreateTime
- The time the replication instance was created.
$sel:freeUntil:ReplicationInstance'
, replicationInstance_freeUntil
- The expiration date of the free replication instance that is part of the
Free DMS program.
$sel:replicationInstanceStatus:ReplicationInstance'
, replicationInstance_replicationInstanceStatus
- The status of the replication instance. The possible return values
include:
"available"
"creating"
"deleted"
"deleting"
"failed"
"modifying"
"upgrading"
"rebooting"
"resetting-master-credentials"
"storage-full"
"incompatible-credentials"
"incompatible-network"
"maintenance"
$sel:replicationInstancePrivateIpAddresses:ReplicationInstance'
, replicationInstance_replicationInstancePrivateIpAddresses
- One or more private IP addresses for the replication instance.
$sel:preferredMaintenanceWindow:ReplicationInstance'
, replicationInstance_preferredMaintenanceWindow
- The maintenance window times for the replication instance. Any pending
upgrades to the replication instance are performed during this time.
$sel:replicationInstancePrivateIpAddress:ReplicationInstance'
, replicationInstance_replicationInstancePrivateIpAddress
- The private IP address of the replication instance.
$sel:kmsKeyId:ReplicationInstance'
, replicationInstance_kmsKeyId
- An KMS key identifier that is used to encrypt the data on the
replication instance.
If you don't specify a value for the KmsKeyId
parameter, then DMS
uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
$sel:availabilityZone:ReplicationInstance'
, replicationInstance_availabilityZone
- The Availability Zone for the instance.
$sel:vpcSecurityGroups:ReplicationInstance'
, replicationInstance_vpcSecurityGroups
- The VPC security group for the instance.
$sel:multiAZ:ReplicationInstance'
, replicationInstance_multiAZ
- Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone
parameter if the Multi-AZ parameter is
set to true
.
$sel:secondaryAvailabilityZone:ReplicationInstance'
, replicationInstance_secondaryAvailabilityZone
- The Availability Zone of the standby replication instance in a Multi-AZ
deployment.
$sel:replicationInstanceArn:ReplicationInstance'
, replicationInstance_replicationInstanceArn
- The Amazon Resource Name (ARN) of the replication instance.
$sel:allocatedStorage:ReplicationInstance'
, replicationInstance_allocatedStorage
- The amount of storage (in gigabytes) that is allocated for the
replication instance.
$sel:dnsNameServers:ReplicationInstance'
, replicationInstance_dnsNameServers
- The DNS name servers supported for the replication instance to access
your on-premise source or target database.
$sel:replicationInstancePublicIpAddress:ReplicationInstance'
, replicationInstance_replicationInstancePublicIpAddress
- The public IP address of the replication instance.
$sel:replicationInstanceClass:ReplicationInstance'
, replicationInstance_replicationInstanceClass
- The compute and memory capacity of the replication instance as defined
for the specified replication instance class. It is a required
parameter, although a default value is pre-selected in the DMS console.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
$sel:replicationInstanceIdentifier:ReplicationInstance'
, replicationInstance_replicationInstanceIdentifier
- The replication instance identifier is a required parameter. This
parameter is stored as a lowercase string.
Constraints:
- Must contain 1-63 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example: myrepinstance
$sel:pendingModifiedValues:ReplicationInstance'
, replicationInstance_pendingModifiedValues
- The pending modification values.
ReplicationInstanceTaskLog
data ReplicationInstanceTaskLog Source #
Contains metadata for a replication instance task log.
See: newReplicationInstanceTaskLog
smart constructor.
Instances
newReplicationInstanceTaskLog :: ReplicationInstanceTaskLog Source #
Create a value of ReplicationInstanceTaskLog
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:replicationTaskName:ReplicationInstanceTaskLog'
, replicationInstanceTaskLog_replicationTaskName
- The name of the replication task.
$sel:replicationTaskArn:ReplicationInstanceTaskLog'
, replicationInstanceTaskLog_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
$sel:replicationInstanceTaskLogSize:ReplicationInstanceTaskLog'
, replicationInstanceTaskLog_replicationInstanceTaskLogSize
- The size, in bytes, of the replication task log.
ReplicationPendingModifiedValues
data ReplicationPendingModifiedValues Source #
Provides information about the values of pending modifications to a replication instance. This data type is an object of the ReplicationInstance user-defined data type.
See: newReplicationPendingModifiedValues
smart constructor.
Instances
newReplicationPendingModifiedValues :: ReplicationPendingModifiedValues Source #
Create a value of ReplicationPendingModifiedValues
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:engineVersion:ReplicationPendingModifiedValues'
, replicationPendingModifiedValues_engineVersion
- The engine version number of the replication instance.
$sel:multiAZ:ReplicationPendingModifiedValues'
, replicationPendingModifiedValues_multiAZ
- Specifies whether the replication instance is a Multi-AZ deployment. You
can't set the AvailabilityZone
parameter if the Multi-AZ parameter is
set to true
.
$sel:allocatedStorage:ReplicationPendingModifiedValues'
, replicationPendingModifiedValues_allocatedStorage
- The amount of storage (in gigabytes) that is allocated for the
replication instance.
$sel:replicationInstanceClass:ReplicationPendingModifiedValues'
, replicationPendingModifiedValues_replicationInstanceClass
- The compute and memory capacity of the replication instance as defined
for the specified replication instance class.
For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
ReplicationSubnetGroup
data ReplicationSubnetGroup Source #
Describes a subnet group in response to a request by the
DescribeReplicationSubnetGroups
operation.
See: newReplicationSubnetGroup
smart constructor.
Constructors
ReplicationSubnetGroup' (Maybe Text) (Maybe [Subnet]) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newReplicationSubnetGroup :: ReplicationSubnetGroup Source #
Create a value of ReplicationSubnetGroup
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:vpcId:ReplicationSubnetGroup'
, replicationSubnetGroup_vpcId
- The ID of the VPC.
$sel:subnets:ReplicationSubnetGroup'
, replicationSubnetGroup_subnets
- The subnets that are in the subnet group.
$sel:replicationSubnetGroupIdentifier:ReplicationSubnetGroup'
, replicationSubnetGroup_replicationSubnetGroupIdentifier
- The identifier of the replication instance subnet group.
$sel:subnetGroupStatus:ReplicationSubnetGroup'
, replicationSubnetGroup_subnetGroupStatus
- The status of the subnet group.
$sel:replicationSubnetGroupDescription:ReplicationSubnetGroup'
, replicationSubnetGroup_replicationSubnetGroupDescription
- A description for the replication subnet group.
ReplicationTask
data ReplicationTask Source #
Provides information that describes a replication task created by the
CreateReplicationTask
operation.
See: newReplicationTask
smart constructor.
Constructors
ReplicationTask' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe MigrationTypeValue) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReplicationTaskStats) (Maybe Text) (Maybe Text) |
Instances
newReplicationTask :: ReplicationTask Source #
Create a value of ReplicationTask
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:replicationTaskSettings:ReplicationTask'
, replicationTask_replicationTaskSettings
- The settings for the replication task.
$sel:status:ReplicationTask'
, replicationTask_status
- The status of the replication task. This response parameter can return
one of the following values:
"moving"
– The task is being moved in response to running the MoveReplicationTask operation."creating"
– The task is being created in response to running the CreateReplicationTask operation."deleting"
– The task is being deleted in response to running the DeleteReplicationTask operation."failed"
– The task failed to successfully complete the database migration in response to running the StartReplicationTask operation."failed-move"
– The task failed to move in response to running the MoveReplicationTask operation."modifying"
– The task definition is being modified in response to running the ModifyReplicationTask operation."ready"
– The task is in aready
state where it can respond to other task operations, such as StartReplicationTask or DeleteReplicationTask ."running"
– The task is performing a database migration in response to running the StartReplicationTask operation."starting"
– The task is preparing to perform a database migration in response to running the StartReplicationTask operation."stopped"
– The task has stopped in response to running the StopReplicationTask operation."stopping"
– The task is preparing to stop in response to running the StopReplicationTask operation."testing"
– The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun or the StartReplicationTaskAssessment operation.StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The StartReplicationTaskAssessment operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.
$sel:stopReason:ReplicationTask'
, replicationTask_stopReason
- The reason the replication task was stopped. This response parameter can
return one of the following values:
"STOP_REASON_FULL_LOAD_COMPLETED"
– Full-load migration completed."STOP_REASON_CACHED_CHANGES_APPLIED"
– Change data capture (CDC) load completed."STOP_REASON_CACHED_CHANGES_NOT_APPLIED"
– In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration."STOP_REASON_SERVER_TIME"
– The migration stopped at the specified server time.
$sel:targetEndpointArn:ReplicationTask'
, replicationTask_targetEndpointArn
- The ARN that uniquely identifies the endpoint.
$sel:replicationTaskIdentifier:ReplicationTask'
, replicationTask_replicationTaskIdentifier
- The user-assigned replication task identifier or name.
Constraints:
- Must contain 1-255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
$sel:cdcStartPosition:ReplicationTask'
, replicationTask_cdcStartPosition
- Indicates when you want a change data capture (CDC) operation to start.
Use either CdcStartPosition
or CdcStartTime
to specify when you want
the CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, or LSN/SCN format.
Date Example: --cdc-start-position “2018-03-08T12:12:12”
Checkpoint Example: --cdc-start-position "checkpoint:V1mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:187600#93"
LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
$sel:replicationTaskStartDate:ReplicationTask'
, replicationTask_replicationTaskStartDate
- The date the replication task is scheduled to start.
$sel:sourceEndpointArn:ReplicationTask'
, replicationTask_sourceEndpointArn
- The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
$sel:recoveryCheckpoint:ReplicationTask'
, replicationTask_recoveryCheckpoint
- Indicates the last checkpoint that occurred during a change data capture
(CDC) operation. You can provide this value to the CdcStartPosition
parameter to start a CDC operation that begins at that checkpoint.
$sel:tableMappings:ReplicationTask'
, replicationTask_tableMappings
- Table mappings specified in the task.
$sel:targetReplicationInstanceArn:ReplicationTask'
, replicationTask_targetReplicationInstanceArn
- The ARN of the replication instance to which this task is moved in
response to running the
MoveReplicationTask
operation. Otherwise, this response parameter isn't a member of the
ReplicationTask
object.
$sel:replicationTaskCreationDate:ReplicationTask'
, replicationTask_replicationTaskCreationDate
- The date the replication task was created.
$sel:migrationType:ReplicationTask'
, replicationTask_migrationType
- The type of migration.
$sel:replicationTaskArn:ReplicationTask'
, replicationTask_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
$sel:taskData:ReplicationTask'
, replicationTask_taskData
- Supplemental information that the task requires to migrate the data for
certain source and target endpoints. For more information, see
Specifying Supplemental Data for Task Settings
in the Database Migration Service User Guide.
$sel:cdcStopPosition:ReplicationTask'
, replicationTask_cdcStopPosition
- Indicates when you want a change data capture (CDC) operation to stop.
The value can be either server time or commit time.
Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”
Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
$sel:replicationTaskStats:ReplicationTask'
, replicationTask_replicationTaskStats
- The statistics for the task, including elapsed time, tables loaded, and
table errors.
$sel:replicationInstanceArn:ReplicationTask'
, replicationTask_replicationInstanceArn
- The ARN of the replication instance.
$sel:lastFailureMessage:ReplicationTask'
, replicationTask_lastFailureMessage
- The last error (failure) message generated for the replication task.
ReplicationTaskAssessmentResult
data ReplicationTaskAssessmentResult Source #
The task assessment report in JSON format.
See: newReplicationTaskAssessmentResult
smart constructor.
Constructors
ReplicationTaskAssessmentResult' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
Instances
newReplicationTaskAssessmentResult :: ReplicationTaskAssessmentResult Source #
Create a value of ReplicationTaskAssessmentResult
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:assessmentResults:ReplicationTaskAssessmentResult'
, replicationTaskAssessmentResult_assessmentResults
- The task assessment results in JSON format.
The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
$sel:assessmentResultsFile:ReplicationTaskAssessmentResult'
, replicationTaskAssessmentResult_assessmentResultsFile
- The file containing the results of the task assessment.
$sel:replicationTaskIdentifier:ReplicationTaskAssessmentResult'
, replicationTaskAssessmentResult_replicationTaskIdentifier
- The replication task identifier of the task on which the task assessment
was run.
$sel:assessmentStatus:ReplicationTaskAssessmentResult'
, replicationTaskAssessmentResult_assessmentStatus
- The status of the task assessment.
$sel:s3ObjectUrl:ReplicationTaskAssessmentResult'
, replicationTaskAssessmentResult_s3ObjectUrl
- The URL of the S3 object containing the task assessment results.
The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
$sel:replicationTaskLastAssessmentDate:ReplicationTaskAssessmentResult'
, replicationTaskAssessmentResult_replicationTaskLastAssessmentDate
- The date the task assessment was completed.
$sel:replicationTaskArn:ReplicationTaskAssessmentResult'
, replicationTaskAssessmentResult_replicationTaskArn
- The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskAssessmentRun
data ReplicationTaskAssessmentRun Source #
Provides information that describes a premigration assessment run that
you have started using the StartReplicationTaskAssessmentRun
operation.
Some of the information appears based on other operations that can
return the ReplicationTaskAssessmentRun
object.
See: newReplicationTaskAssessmentRun
smart constructor.
Constructors
ReplicationTaskAssessmentRun' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe ReplicationTaskAssessmentRunProgress) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newReplicationTaskAssessmentRun :: ReplicationTaskAssessmentRun Source #
Create a value of ReplicationTaskAssessmentRun
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:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_status
- Assessment run status.
This status can have one of the following values:
"cancelling"
– The assessment run was canceled by theCancelReplicationTaskAssessmentRun
operation."deleting"
– The assessment run was deleted by theDeleteReplicationTaskAssessmentRun
operation."failed"
– At least one individual assessment completed with afailed
status."error-provisioning"
– An internal error occurred while resources were provisioned (duringprovisioning
status)."error-executing"
– An internal error occurred while individual assessments ran (duringrunning
status)."invalid state"
– The assessment run is in an unknown state."passed"
– All individual assessments have completed, and none has afailed
status."provisioning"
– Resources required to run individual assessments are being provisioned."running"
– Individual assessments are being run."starting"
– The assessment run is starting, but resources are not yet being provisioned for individual assessments.
$sel:serviceAccessRoleArn:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_serviceAccessRoleArn
- ARN of the service role used to start the assessment run using the
StartReplicationTaskAssessmentRun
operation. The role must allow the
iam:PassRole
action.
$sel:replicationTaskAssessmentRunCreationDate:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_replicationTaskAssessmentRunCreationDate
- Date on which the assessment run was created using the
StartReplicationTaskAssessmentRun
operation.
$sel:assessmentProgress:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_assessmentProgress
- Indication of the completion progress for the individual assessments
specified to run.
$sel:resultKmsKeyArn:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_resultKmsKeyArn
- ARN of the KMS encryption key used to encrypt the assessment run
results.
$sel:replicationTaskArn:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_replicationTaskArn
- ARN of the migration task associated with this premigration assessment
run.
$sel:resultLocationBucket:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_resultLocationBucket
- Amazon S3 bucket where DMS stores the results of this assessment run.
$sel:resultLocationFolder:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_resultLocationFolder
- Folder in an Amazon S3 bucket where DMS stores the results of this
assessment run.
$sel:resultEncryptionMode:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_resultEncryptionMode
- Encryption mode used to encrypt the assessment run results.
$sel:assessmentRunName:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_assessmentRunName
- Unique name of the assessment run.
$sel:replicationTaskAssessmentRunArn:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_replicationTaskAssessmentRunArn
- Amazon Resource Name (ARN) of this assessment run.
$sel:lastFailureMessage:ReplicationTaskAssessmentRun'
, replicationTaskAssessmentRun_lastFailureMessage
- Last message generated by an individual assessment failure.
ReplicationTaskAssessmentRunProgress
data ReplicationTaskAssessmentRunProgress Source #
The progress values reported by the AssessmentProgress
response
element.
See: newReplicationTaskAssessmentRunProgress
smart constructor.
Constructors
ReplicationTaskAssessmentRunProgress' (Maybe Int) (Maybe Int) |
Instances
newReplicationTaskAssessmentRunProgress :: ReplicationTaskAssessmentRunProgress Source #
Create a value of ReplicationTaskAssessmentRunProgress
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:individualAssessmentCount:ReplicationTaskAssessmentRunProgress'
, replicationTaskAssessmentRunProgress_individualAssessmentCount
- The number of individual assessments that are specified to run.
$sel:individualAssessmentCompletedCount:ReplicationTaskAssessmentRunProgress'
, replicationTaskAssessmentRunProgress_individualAssessmentCompletedCount
- The number of individual assessments that have completed, successfully
or not.
ReplicationTaskIndividualAssessment
data ReplicationTaskIndividualAssessment Source #
Provides information that describes an individual assessment from a premigration assessment run.
See: newReplicationTaskIndividualAssessment
smart constructor.
Constructors
ReplicationTaskIndividualAssessment' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newReplicationTaskIndividualAssessment :: ReplicationTaskIndividualAssessment Source #
Create a value of ReplicationTaskIndividualAssessment
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:ReplicationTaskIndividualAssessment'
, replicationTaskIndividualAssessment_status
- Individual assessment status.
This status can have one of the following values:
"cancelled"
"error"
"failed"
"passed"
"pending"
"running"
$sel:replicationTaskIndividualAssessmentStartDate:ReplicationTaskIndividualAssessment'
, replicationTaskIndividualAssessment_replicationTaskIndividualAssessmentStartDate
- Date when this individual assessment was started as part of running the
StartReplicationTaskAssessmentRun
operation.
$sel:individualAssessmentName:ReplicationTaskIndividualAssessment'
, replicationTaskIndividualAssessment_individualAssessmentName
- Name of this individual assessment.
$sel:replicationTaskIndividualAssessmentArn:ReplicationTaskIndividualAssessment'
, replicationTaskIndividualAssessment_replicationTaskIndividualAssessmentArn
- Amazon Resource Name (ARN) of this individual assessment.
$sel:replicationTaskAssessmentRunArn:ReplicationTaskIndividualAssessment'
, replicationTaskIndividualAssessment_replicationTaskAssessmentRunArn
- ARN of the premigration assessment run that is created to run this
individual assessment.
ReplicationTaskStats
data ReplicationTaskStats Source #
In response to a request by the DescribeReplicationTasks
operation,
this object provides a collection of statistics about a replication
task.
See: newReplicationTaskStats
smart constructor.
Constructors
ReplicationTaskStats' (Maybe POSIX) (Maybe Int) (Maybe POSIX) (Maybe Integer) (Maybe POSIX) (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe POSIX) |
Instances
newReplicationTaskStats :: ReplicationTaskStats Source #
Create a value of ReplicationTaskStats
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:stopDate:ReplicationTaskStats'
, replicationTaskStats_stopDate
- The date the replication task was stopped.
$sel:fullLoadProgressPercent:ReplicationTaskStats'
, replicationTaskStats_fullLoadProgressPercent
- The percent complete for the full load migration task.
$sel:fullLoadStartDate:ReplicationTaskStats'
, replicationTaskStats_fullLoadStartDate
- The date the replication task full load was started.
$sel:elapsedTimeMillis:ReplicationTaskStats'
, replicationTaskStats_elapsedTimeMillis
- The elapsed time of the task, in milliseconds.
$sel:startDate:ReplicationTaskStats'
, replicationTaskStats_startDate
- The date the replication task was started either with a fresh start or a
resume. For more information, see
StartReplicationTaskType.
$sel:tablesErrored:ReplicationTaskStats'
, replicationTaskStats_tablesErrored
- The number of errors that have occurred during this task.
$sel:fullLoadFinishDate:ReplicationTaskStats'
, replicationTaskStats_fullLoadFinishDate
- The date the replication task full load was completed.
$sel:tablesLoaded:ReplicationTaskStats'
, replicationTaskStats_tablesLoaded
- The number of tables loaded for this task.
$sel:tablesQueued:ReplicationTaskStats'
, replicationTaskStats_tablesQueued
- The number of tables queued for this task.
$sel:tablesLoading:ReplicationTaskStats'
, replicationTaskStats_tablesLoading
- The number of tables currently loading for this task.
$sel:freshStartDate:ReplicationTaskStats'
, replicationTaskStats_freshStartDate
- The date the replication task was started either with a fresh start or a
target reload.
ResourcePendingMaintenanceActions
data ResourcePendingMaintenanceActions Source #
Identifies an DMS resource and any pending actions for it.
See: newResourcePendingMaintenanceActions
smart constructor.
Constructors
ResourcePendingMaintenanceActions' (Maybe [PendingMaintenanceAction]) (Maybe Text) |
Instances
newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions Source #
Create a value of ResourcePendingMaintenanceActions
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:pendingMaintenanceActionDetails:ResourcePendingMaintenanceActions'
, resourcePendingMaintenanceActions_pendingMaintenanceActionDetails
- Detailed information about the pending maintenance action.
$sel:resourceIdentifier:ResourcePendingMaintenanceActions'
, resourcePendingMaintenanceActions_resourceIdentifier
- The Amazon Resource Name (ARN) of the DMS resource that the pending
maintenance action applies to. For information about creating an ARN,
see
Constructing an Amazon Resource Name (ARN) for DMS
in the DMS documentation.
S3Settings
data S3Settings Source #
Settings for exporting data to Amazon S3.
See: newS3Settings
smart constructor.
Constructors
S3Settings' (Maybe ParquetVersionValue) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataFormatValue) (Maybe Bool) (Maybe EncodingTypeValue) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe EncryptionModeValue) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe DatePartitionDelimiterValue) (Maybe Bool) (Maybe CannedAclForObjectsValue) (Maybe CompressionTypeValue) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe DatePartitionSequenceValue) (Maybe Int) (Maybe Text) |
Instances
newS3Settings :: S3Settings Source #
Create a value of S3Settings
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:parquetVersion:S3Settings'
, s3Settings_parquetVersion
- The version of the Apache Parquet format that you want to use:
parquet_1_0
(the default) or parquet_2_0
.
$sel:preserveTransactions:S3Settings'
, s3Settings_preserveTransactions
- If set to true
, DMS saves the transaction order for a change data
capture (CDC) load on the Amazon S3 target specified by
CdcPath
. For more information, see
Capturing data changes (CDC) including transaction order on the S3 target.
This setting is supported in DMS versions 3.4.2 and later.
$sel:maxFileSize:S3Settings'
, s3Settings_maxFileSize
- A value that specifies the maximum size (in KB) of any .csv file to be
created while migrating to an S3 target during full load.
The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.
$sel:csvNoSupValue:S3Settings'
, s3Settings_csvNoSupValue
- This setting only applies if your Amazon S3 output files during a change
data capture (CDC) load are written in .csv format. If
UseCsvNoSupValue
is set to true, specify a string value that you want DMS to use for all
columns not included in the supplemental log. If you do not specify a
string value, DMS uses the null value for these columns regardless of
the UseCsvNoSupValue
setting.
This setting is supported in DMS versions 3.4.1 and later.
$sel:rfc4180:S3Settings'
, s3Settings_rfc4180
- For an S3 source, when this value is set to true
or y
, each leading
double quotation mark has to be followed by an ending double quotation
mark. This formatting complies with RFC 4180. When this value is set to
false
or n
, string literals are copied to the target as is. In this
case, a delimiter (row or column) signals the end of the field. Thus,
you can't use a delimiter as part of the string, because it signals the
end of the value.
For an S3 target, an optional parameter used to set behavior to comply
with RFC 4180 for data migrated to Amazon S3 using .csv file format
only. When this value is set to true
or y
using Amazon S3 as a
target, if the data has quotation marks or newline characters in it, DMS
encloses the entire column with an additional pair of double quotation
marks ("). Every quotation mark within the data is repeated twice.
The default value is true
. Valid values include true
, false
, y
,
and n
.
$sel:parquetTimestampInMillisecond:S3Settings'
, s3Settings_parquetTimestampInMillisecond
- A value that specifies the precision of any TIMESTAMP
column values
that are written to an Amazon S3 object file in .parquet format.
DMS supports the ParquetTimestampInMillisecond
parameter in versions
3.1.4 and later.
When ParquetTimestampInMillisecond
is set to true
or y
, DMS writes
all TIMESTAMP
columns in a .parquet formatted file with millisecond
precision. Otherwise, DMS writes them with microsecond precision.
Currently, Amazon Athena and Glue can handle only millisecond precision
for TIMESTAMP
values. Set this parameter to true
for S3 endpoint
object files that are .parquet formatted only if you plan to query or
process the data with Athena or Glue.
DMS writes any TIMESTAMP
column values written to an S3 file in .csv
format with microsecond precision.
Setting ParquetTimestampInMillisecond
has no effect on the string
format of the timestamp column value that is inserted by setting the
TimestampColumnName
parameter.
$sel:includeOpForFullLoad:S3Settings'
, s3Settings_includeOpForFullLoad
- A value that enables a full load to write INSERT operations to the
comma-separated value (.csv) output files only to indicate how the rows
were added to the source database.
DMS supports the IncludeOpForFullLoad
parameter in versions 3.1.4 and
later.
For full load, records can only be inserted. By default (the false
setting), no information is recorded in these output files for a full
load to indicate that the rows were inserted at the source database. If
IncludeOpForFullLoad
is set to true
or y
, the INSERT is recorded
as an I annotation in the first field of the .csv file. This allows the
format of your target records from a full load to be consistent with the
target records from a CDC load.
This setting works together with the CdcInsertsOnly
and the
CdcInsertsAndUpdates
parameters for output to .csv files only. For
more information about how these settings work together, see
Indicating Source DB Operations in Migrated S3 Data
in the Database Migration Service User Guide..
$sel:cdcMinFileSize:S3Settings'
, s3Settings_cdcMinFileSize
- Minimum file size, defined in megabytes, to reach for a file output to
Amazon S3.
When CdcMinFileSize
and CdcMaxBatchInterval
are both specified, the
file write is triggered by whichever parameter condition is met first
within an DMS CloudFormation template.
The default value is 32 MB.
$sel:csvDelimiter:S3Settings'
, s3Settings_csvDelimiter
- The delimiter used to separate columns in the .csv file for both source
and target. The default is a comma.
$sel:serviceAccessRoleArn:S3Settings'
, s3Settings_serviceAccessRoleArn
- The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole
action. It is a required
parameter that enables DMS to write and read objects from an S3 bucket.
$sel:bucketFolder:S3Settings'
, s3Settings_bucketFolder
- An optional parameter to set a folder name in the S3 bucket. If
provided, tables are created in the path
bucketFolder/schema_name/table_name/
. If this parameter isn't
specified, then the path used is schema_name/table_name/
.
$sel:dataFormat:S3Settings'
, s3Settings_dataFormat
- The format of the data that you want to use for output. You can choose
one of the following:
csv
: This is a row-based file format with comma-separated values (.csv).parquet
: Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response.
$sel:datePartitionEnabled:S3Settings'
, s3Settings_datePartitionEnabled
- When set to true
, this parameter partitions S3 bucket folders based on
transaction commit dates. The default value is false
. For more
information about date-based folder partitioning, see
Using date-based folder partitioning.
$sel:encodingType:S3Settings'
, s3Settings_encodingType
- The type of encoding you are using:
RLE_DICTIONARY
uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.PLAIN
doesn't use encoding at all. Values are stored as they are.PLAIN_DICTIONARY
builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.
$sel:cdcMaxBatchInterval:S3Settings'
, s3Settings_cdcMaxBatchInterval
- Maximum length of the interval, defined in seconds, after which to
output a file to Amazon S3.
When CdcMaxBatchInterval
and CdcMinFileSize
are both specified, the
file write is triggered by whichever parameter condition is met first
within an DMS CloudFormation template.
The default value is 60 seconds.
$sel:ignoreHeaderRows:S3Settings'
, s3Settings_ignoreHeaderRows
- When this value is set to 1, DMS ignores the first row header in a .csv
file. A value of 1 turns on the feature; a value of 0 turns off the
feature.
The default is 0.
$sel:externalTableDefinition:S3Settings'
, s3Settings_externalTableDefinition
- Specifies how tables are defined in the S3 source files only.
$sel:dictPageSizeLimit:S3Settings'
, s3Settings_dictPageSizeLimit
- The maximum size of an encoded dictionary page of a column. If the
dictionary page exceeds this, this column is stored using an encoding
type of PLAIN
. This parameter defaults to 1024 * 1024 bytes (1 MiB),
the maximum size of a dictionary page before it reverts to PLAIN
encoding. This size is used for .parquet file format only.
$sel:bucketName:S3Settings'
, s3Settings_bucketName
- The name of the S3 bucket.
$sel:encryptionMode:S3Settings'
, s3Settings_encryptionMode
- The type of server-side encryption that you want to use for your data.
This encryption type is part of the endpoint settings or the extra
connections attributes for Amazon S3. You can choose either SSE_S3
(the default) or SSE_KMS
.
For the ModifyEndpoint
operation, you can change the existing value of
the EncryptionMode
parameter from SSE_KMS
to SSE_S3
. But you can’t
change the existing value from SSE_S3
to SSE_KMS
.
To use SSE_S3
, you need an Identity and Access Management (IAM) role
with permission to allow "arn:aws:s3:::dms-*"
to use the following
actions:
s3:CreateBucket
s3:ListBucket
s3:DeleteBucket
s3:GetBucketLocation
s3:GetObject
s3:PutObject
s3:DeleteObject
s3:GetObjectVersion
s3:GetBucketPolicy
s3:PutBucketPolicy
s3:DeleteBucketPolicy
$sel:enableStatistics:S3Settings'
, s3Settings_enableStatistics
- A value that enables statistics for Parquet pages and row groups. Choose
true
to enable statistics, false
to disable. Statistics include
NULL
, DISTINCT
, MAX
, and MIN
values. This parameter defaults to
true
. This value is used for .parquet file format only.
$sel:cdcInsertsOnly:S3Settings'
, s3Settings_cdcInsertsOnly
- A value that enables a change data capture (CDC) load to write only
INSERT operations to .csv or columnar storage (.parquet) output files.
By default (the false
setting), the first field in a .csv or .parquet
record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These
values indicate whether the row was inserted, updated, or deleted at the
source database for a CDC load to the target.
If CdcInsertsOnly
is set to true
or y
, only INSERTs from the
source database are migrated to the .csv or .parquet file. For .csv
format only, how these INSERTs are recorded depends on the value of
IncludeOpForFullLoad
. If IncludeOpForFullLoad
is set to true
, the
first field of every CDC record is set to I to indicate the INSERT
operation at the source. If IncludeOpForFullLoad
is set to false
,
every CDC record is written without a first field to indicate the INSERT
operation at the source. For more information about how these settings
work together, see
Indicating Source DB Operations in Migrated S3 Data
in the Database Migration Service User Guide..
DMS supports the interaction described preceding between the
CdcInsertsOnly
and IncludeOpForFullLoad
parameters in versions 3.1.4
and later.
CdcInsertsOnly
and CdcInsertsAndUpdates
can't both be set to true
for the same endpoint. Set either CdcInsertsOnly
or
CdcInsertsAndUpdates
to true
for the same endpoint, but not both.
$sel:timestampColumnName:S3Settings'
, s3Settings_timestampColumnName
- A value that when nonblank causes DMS to add a column with timestamp
information to the endpoint data for an Amazon S3 target.
DMS supports the TimestampColumnName
parameter in versions 3.1.4 and
later.
DMS includes an additional STRING
column in the .csv or .parquet
object files of your migrated data when you set TimestampColumnName
to
a nonblank value.
For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.
For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.
The string format for this timestamp column value is
yyyy-MM-dd HH:mm:ss.SSSSSS
. By default, the precision of this value is
in microseconds. For a CDC load, the rounding of the precision depends
on the commit timestamp supported by DMS for the source database.
When the AddColumnName
parameter is set to true
, DMS also includes a
name for the timestamp column that you set with TimestampColumnName
.
$sel:csvRowDelimiter:S3Settings'
, s3Settings_csvRowDelimiter
- The delimiter used to separate rows in the .csv file for both source and
target. The default is a carriage return (\n
).
$sel:datePartitionDelimiter:S3Settings'
, s3Settings_datePartitionDelimiter
- Specifies a date separating delimiter to use during folder partitioning.
The default value is SLASH
. Use this parameter when
DatePartitionedEnabled
is set to true
.
$sel:addColumnName:S3Settings'
, s3Settings_addColumnName
- An optional parameter that, when set to true
or y
, you can use to
add column name information to the .csv output file.
The default value is false
. Valid values are true
, false
, y
, and
n
.
$sel:cannedAclForObjects:S3Settings'
, s3Settings_cannedAclForObjects
- A value that enables DMS to specify a predefined (canned) access control
list for objects created in an Amazon S3 bucket as .csv or .parquet
files. For more information about Amazon S3 canned ACLs, see
Canned ACL
in the Amazon S3 Developer Guide.
The default value is NONE. Valid values include NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ, AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.
$sel:compressionType:S3Settings'
, s3Settings_compressionType
- An optional parameter to use GZIP to compress the target files. Set to
GZIP to compress the target files. Either set this parameter to NONE
(the default) or don't use it to leave the files uncompressed. This
parameter applies to both .csv and .parquet file formats.
$sel:csvNullValue:S3Settings'
, s3Settings_csvNullValue
- An optional parameter that specifies how DMS treats null values. While
handling the null value, you can use this parameter to pass a
user-defined string as null when writing to the target. For example,
when target columns are not nullable, you can use this option to
differentiate between the empty string value and the null value. So, if
you set this parameter value to the empty string ("" or ''), DMS
treats the empty string as the null value instead of NULL
.
The default value is NULL
. Valid values include any valid string.
$sel:serverSideEncryptionKmsKeyId:S3Settings'
, s3Settings_serverSideEncryptionKmsKeyId
- If you are using SSE_KMS
for the EncryptionMode
, provide the KMS key
ID. The key that you use needs an attached policy that enables Identity
and Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example:
aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value
$sel:dataPageSize:S3Settings'
, s3Settings_dataPageSize
- The size of one data page in bytes. This parameter defaults to 1024 *
1024 bytes (1 MiB). This number is used for .parquet file format only.
$sel:useCsvNoSupValue:S3Settings'
, s3Settings_useCsvNoSupValue
- This setting applies if the S3 output files during a change data capture
(CDC) load are written in .csv format. If set to true
for columns not
included in the supplemental log, DMS uses the value specified by
CsvNoSupValue
. If not set or set to false
, DMS uses the null value for these
columns.
This setting is supported in DMS versions 3.4.1 and later.
$sel:cdcInsertsAndUpdates:S3Settings'
, s3Settings_cdcInsertsAndUpdates
- A value that enables a change data capture (CDC) load to write INSERT
and UPDATE operations to .csv or .parquet (columnar storage) output
files. The default setting is false
, but when CdcInsertsAndUpdates
is set to true
or y
, only INSERTs and UPDATEs from the source
database are migrated to the .csv or .parquet file.
For .csv file format only, how these INSERTs and UPDATEs are recorded
depends on the value of the IncludeOpForFullLoad
parameter. If
IncludeOpForFullLoad
is set to true
, the first field of every CDC
record is set to either I
or U
to indicate INSERT and UPDATE
operations at the source. But if IncludeOpForFullLoad
is set to
false
, CDC records are written without an indication of INSERT or
UPDATE operations at the source. For more information about how these
settings work together, see
Indicating Source DB Operations in Migrated S3 Data
in the Database Migration Service User Guide..
DMS supports the use of the CdcInsertsAndUpdates
parameter in versions
3.3.1 and later.
CdcInsertsOnly
and CdcInsertsAndUpdates
can't both be set to true
for the same endpoint. Set either CdcInsertsOnly
or
CdcInsertsAndUpdates
to true
for the same endpoint, but not both.
$sel:datePartitionSequence:S3Settings'
, s3Settings_datePartitionSequence
- Identifies the sequence of the date format to use during folder
partitioning. The default value is YYYYMMDD
. Use this parameter when
DatePartitionedEnabled
is set to true
.
$sel:rowGroupLength:S3Settings'
, s3Settings_rowGroupLength
- The number of rows in a row group. A smaller row group size provides
faster reads. But as the number of row groups grows, the slower writes
become. This parameter defaults to 10,000 rows. This number is used for
.parquet file format only.
If you choose a value larger than the maximum, RowGroupLength
is set
to the max row group length in bytes (64 * 1024 * 1024).
$sel:cdcPath:S3Settings'
, s3Settings_cdcPath
- Specifies the folder path of CDC files. For an S3 source, this setting
is required if a task captures change data; otherwise, it's optional.
If CdcPath
is set, DMS reads CDC files from this path and replicates
the data changes to the target endpoint. For an S3 target if you set
PreserveTransactions
to true
, DMS verifies that you have set this parameter to a folder
path on your S3 target where DMS can save the transaction order for the
CDC load. DMS creates this CDC folder path in either your S3 target
working directory or the S3 target location specified by
BucketFolder
and
BucketName
.
For example, if you specify CdcPath
as MyChangedData
, and you
specify BucketName
as MyTargetBucket
but do not specify
BucketFolder
, DMS creates the CDC folder path following:
MyTargetBucket/MyChangedData
.
If you specify the same CdcPath
, and you specify BucketName
as
MyTargetBucket
and BucketFolder
as MyTargetData
, DMS creates the
CDC folder path following:
MyTargetBucket/MyTargetData/MyChangedData
.
For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 target.
This setting is supported in DMS versions 3.4.2 and later.
Subnet
In response to a request by the DescribeReplicationSubnetGroups
operation, this object identifies a subnet by its given Availability
Zone, subnet identifier, and status.
See: newSubnet
smart constructor.
Instances
Eq Subnet Source # | |
Read Subnet Source # | |
Show Subnet Source # | |
Generic Subnet Source # | |
NFData Subnet Source # | |
Defined in Amazonka.DMS.Types.Subnet | |
Hashable Subnet Source # | |
Defined in Amazonka.DMS.Types.Subnet | |
FromJSON Subnet Source # | |
type Rep Subnet Source # | |
Defined in Amazonka.DMS.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.DMS.Types.Subnet" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "subnetIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityZone))))) |
Create a value of Subnet
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:subnetStatus:Subnet'
, subnet_subnetStatus
- The status of the subnet.
$sel:subnetIdentifier:Subnet'
, subnet_subnetIdentifier
- The subnet identifier.
$sel:subnetAvailabilityZone:Subnet'
, subnet_subnetAvailabilityZone
- The Availability Zone of the subnet.
SupportedEndpointType
data SupportedEndpointType Source #
Provides information about types of supported endpoints in response to a
request by the DescribeEndpointTypes
operation. This information
includes the type of endpoint, the database engine name, and whether
change data capture (CDC) is supported.
See: newSupportedEndpointType
smart constructor.
Constructors
SupportedEndpointType' (Maybe Text) (Maybe ReplicationEndpointTypeValue) (Maybe Text) (Maybe Text) (Maybe Bool) |
Instances
newSupportedEndpointType :: SupportedEndpointType Source #
Create a value of SupportedEndpointType
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:engineDisplayName:SupportedEndpointType'
, supportedEndpointType_engineDisplayName
- The expanded name for the engine name. For example, if the EngineName
parameter is "aurora," this value would be "Amazon Aurora MySQL."
$sel:endpointType:SupportedEndpointType'
, supportedEndpointType_endpointType
- The type of endpoint. Valid values are source
and target
.
$sel:engineName:SupportedEndpointType'
, supportedEndpointType_engineName
- The database engine name. Valid values, depending on the EndpointType,
include "mysql"
, "oracle"
, "postgres"
, "mariadb"
,
"aurora"
, "aurora-postgresql"
, "redshift"
, "s3"
,
"db2"
, "azuredb"
, "sybase"
, "dynamodb"
, "mongodb"
,
"kinesis"
, "kafka"
, "elasticsearch"
, "documentdb"
,
"sqlserver"
, and "neptune"
.
$sel:replicationInstanceEngineMinimumVersion:SupportedEndpointType'
, supportedEndpointType_replicationInstanceEngineMinimumVersion
- The earliest DMS engine version that supports this endpoint engine. Note
that endpoint engines released with DMS versions earlier than 3.1.1 do
not return a value for this parameter.
$sel:supportsCDC:SupportedEndpointType'
, supportedEndpointType_supportsCDC
- Indicates if change data capture (CDC) is supported.
SybaseSettings
data SybaseSettings Source #
Provides information that defines a SAP ASE endpoint.
See: newSybaseSettings
smart constructor.
Constructors
SybaseSettings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Int) |
Instances
newSybaseSettings :: SybaseSettings Source #
Create a value of SybaseSettings
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:serverName:SybaseSettings'
, sybaseSettings_serverName
- Fully qualified domain name of the endpoint.
$sel:secretsManagerAccessRoleArn:SybaseSettings'
, sybaseSettings_secretsManagerAccessRoleArn
- The full Amazon Resource Name (ARN) of the IAM role that specifies DMS
as the trusted entity and grants the required permissions to access the
value in SecretsManagerSecret
. The role must allow the iam:PassRole
action. SecretsManagerSecret
has the value of the Amazon Web Services
Secrets Manager secret that allows access to the SAP ASE endpoint.
You can specify one of two sets of values for these permissions. You can
specify the values for this setting and SecretsManagerSecretId
. Or you
can specify clear-text values for UserName
, Password
, ServerName
,
and Port
. You can't specify both. For more information on creating
this SecretsManagerSecret
and the SecretsManagerAccessRoleArn
and
SecretsManagerSecretId
required to access it, see
Using secrets to access Database Migration Service resources
in the Database Migration Service User Guide.
$sel:username:SybaseSettings'
, sybaseSettings_username
- Endpoint connection user name.
$sel:password:SybaseSettings'
, sybaseSettings_password
- Endpoint connection password.
$sel:databaseName:SybaseSettings'
, sybaseSettings_databaseName
- Database name for the endpoint.
$sel:secretsManagerSecretId:SybaseSettings'
, sybaseSettings_secretsManagerSecretId
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret
that contains the SAP SAE endpoint connection
details.
$sel:port:SybaseSettings'
, sybaseSettings_port
- Endpoint TCP port.
TableStatistics
data TableStatistics Source #
Provides a collection of table statistics in response to a request by
the DescribeTableStatistics
operation.
See: newTableStatistics
smart constructor.
Constructors
TableStatistics' (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe Integer) (Maybe Bool) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
Instances
newTableStatistics :: TableStatistics Source #
Create a value of TableStatistics
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:validationState:TableStatistics'
, tableStatistics_validationState
- The validation state of the table.
This parameter can have the following values:
- Not enabled – Validation isn't enabled for the table in the migration task.
- Pending records – Some records in the table are waiting for validation.
- Mismatched records – Some records in the table don't match between the source and target.
- Suspended records – Some records in the table couldn't be validated.
- No primary key –The table couldn't be validated because it has no primary key.
- Table error – The table wasn't validated because it's in an error state and some data wasn't migrated.
- Validated – All rows in the table are validated. If the table is updated, the status can change from Validated.
- Error – The table couldn't be validated because of an unexpected error.
- Pending validation – The table is waiting validation.
- Preparing table – Preparing the table enabled in the migration task for validation.
- Pending revalidation – All rows in the table are pending validation after the table was updated.
$sel:fullLoadRows:TableStatistics'
, tableStatistics_fullLoadRows
- The number of rows added during the full load operation.
$sel:inserts:TableStatistics'
, tableStatistics_inserts
- The number of insert actions performed on a table.
$sel:fullLoadEndTime:TableStatistics'
, tableStatistics_fullLoadEndTime
- The time when the full load operation completed.
$sel:fullLoadCondtnlChkFailedRows:TableStatistics'
, tableStatistics_fullLoadCondtnlChkFailedRows
- The number of rows that failed conditional checks during the full load
operation (valid only for migrations where DynamoDB is the target).
$sel:fullLoadReloaded:TableStatistics'
, tableStatistics_fullLoadReloaded
- A value that indicates if the table was reloaded (true
) or loaded as
part of a new full load operation (false
).
$sel:validationFailedRecords:TableStatistics'
, tableStatistics_validationFailedRecords
- The number of records that failed validation.
$sel:validationSuspendedRecords:TableStatistics'
, tableStatistics_validationSuspendedRecords
- The number of records that couldn't be validated.
$sel:schemaName:TableStatistics'
, tableStatistics_schemaName
- The schema name.
$sel:validationStateDetails:TableStatistics'
, tableStatistics_validationStateDetails
- Additional details about the state of validation.
$sel:tableState:TableStatistics'
, tableStatistics_tableState
- The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded
$sel:fullLoadErrorRows:TableStatistics'
, tableStatistics_fullLoadErrorRows
- The number of rows that failed to load during the full load operation
(valid only for migrations where DynamoDB is the target).
$sel:ddls:TableStatistics'
, tableStatistics_ddls
- The data definition language (DDL) used to build and modify the
structure of your tables.
$sel:deletes:TableStatistics'
, tableStatistics_deletes
- The number of delete actions performed on a table.
$sel:updates:TableStatistics'
, tableStatistics_updates
- The number of update actions performed on a table.
$sel:validationPendingRecords:TableStatistics'
, tableStatistics_validationPendingRecords
- The number of records that have yet to be validated.
$sel:fullLoadStartTime:TableStatistics'
, tableStatistics_fullLoadStartTime
- The time when the full load operation started.
$sel:lastUpdateTime:TableStatistics'
, tableStatistics_lastUpdateTime
- The last time a table was updated.
$sel:tableName:TableStatistics'
, tableStatistics_tableName
- The name of the table.
TableToReload
data TableToReload Source #
Provides the name of the schema and table to be reloaded.
See: newTableToReload
smart constructor.
Constructors
TableToReload' Text Text |
Instances
Create a value of TableToReload
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:schemaName:TableToReload'
, tableToReload_schemaName
- The schema name of the table to be reloaded.
$sel:tableName:TableToReload'
, tableToReload_tableName
- The table name of the table to be reloaded.
Tag
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.DMS.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.DMS.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.DMS.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.DMS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.DMS.Types.Tag" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
Create a value of Tag
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:Tag'
, tag_value
- A value is the optional value of the tag. The string value can be 1-256
Unicode characters in length and can't be prefixed with "aws:" or
"dms:". The string can only contain only the set of Unicode letters,
digits, white-space, '_', '.', '/', '=', '+', '-' (Java
regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
$sel:resourceArn:Tag'
, tag_resourceArn
- The Amazon Resource Name (ARN) string that uniquely identifies the
resource for which the tag is created.
$sel:key:Tag'
, tag_key
- A key is the required name of the tag. The string value can be 1-128
Unicode characters in length and can't be prefixed with "aws:" or
"dms:". The string can only contain only the set of Unicode letters,
digits, white-space, '_', '.', '/', '=', '+', '-' (Java
regular expressions: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
VpcSecurityGroupMembership
data VpcSecurityGroupMembership Source #
Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
See: newVpcSecurityGroupMembership
smart constructor.
Constructors
VpcSecurityGroupMembership' (Maybe Text) (Maybe Text) |
Instances
newVpcSecurityGroupMembership :: VpcSecurityGroupMembership Source #
Create a value of VpcSecurityGroupMembership
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:VpcSecurityGroupMembership'
, vpcSecurityGroupMembership_status
- The status of the VPC security group.
$sel:vpcSecurityGroupId:VpcSecurityGroupMembership'
, vpcSecurityGroupMembership_vpcSecurityGroupId
- The VPC security group ID.