| 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.Types
Contents
- Service Configuration
- Errors
- 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
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
- 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' {}
- newAccountQuota :: AccountQuota
- accountQuota_max :: Lens' AccountQuota (Maybe Integer)
- accountQuota_used :: Lens' AccountQuota (Maybe Integer)
- accountQuota_accountQuotaName :: Lens' AccountQuota (Maybe Text)
- data AvailabilityZone = AvailabilityZone' {}
- newAvailabilityZone :: AvailabilityZone
- availabilityZone_name :: Lens' AvailabilityZone (Maybe Text)
- data Certificate = Certificate' {}
- newCertificate :: Certificate
- certificate_certificateOwner :: Lens' Certificate (Maybe Text)
- certificate_signingAlgorithm :: Lens' Certificate (Maybe Text)
- certificate_validFromDate :: Lens' Certificate (Maybe UTCTime)
- certificate_certificatePem :: Lens' Certificate (Maybe Text)
- certificate_certificateArn :: Lens' Certificate (Maybe Text)
- certificate_certificateCreationDate :: Lens' Certificate (Maybe UTCTime)
- certificate_certificateIdentifier :: Lens' Certificate (Maybe Text)
- certificate_certificateWallet :: Lens' Certificate (Maybe ByteString)
- certificate_keyLength :: Lens' Certificate (Maybe Int)
- certificate_validToDate :: Lens' Certificate (Maybe UTCTime)
- data Connection = Connection' {}
- newConnection :: Connection
- connection_status :: Lens' Connection (Maybe Text)
- connection_replicationInstanceArn :: Lens' Connection (Maybe Text)
- connection_endpointIdentifier :: Lens' Connection (Maybe Text)
- connection_replicationInstanceIdentifier :: Lens' Connection (Maybe Text)
- connection_endpointArn :: Lens' Connection (Maybe Text)
- connection_lastFailureMessage :: Lens' Connection (Maybe Text)
- data DmsTransferSettings = DmsTransferSettings' {}
- newDmsTransferSettings :: DmsTransferSettings
- dmsTransferSettings_serviceAccessRoleArn :: Lens' DmsTransferSettings (Maybe Text)
- dmsTransferSettings_bucketName :: Lens' DmsTransferSettings (Maybe Text)
- data DocDbSettings = DocDbSettings' {
- serverName :: Maybe Text
- secretsManagerAccessRoleArn :: Maybe Text
- username :: Maybe Text
- kmsKeyId :: Maybe Text
- password :: Maybe (Sensitive Text)
- nestingLevel :: Maybe NestingLevelValue
- databaseName :: Maybe Text
- docsToInvestigate :: Maybe Int
- secretsManagerSecretId :: Maybe Text
- extractDocId :: Maybe Bool
- port :: Maybe Int
- newDocDbSettings :: DocDbSettings
- docDbSettings_serverName :: Lens' DocDbSettings (Maybe Text)
- docDbSettings_secretsManagerAccessRoleArn :: Lens' DocDbSettings (Maybe Text)
- docDbSettings_username :: Lens' DocDbSettings (Maybe Text)
- docDbSettings_kmsKeyId :: Lens' DocDbSettings (Maybe Text)
- docDbSettings_password :: Lens' DocDbSettings (Maybe Text)
- docDbSettings_nestingLevel :: Lens' DocDbSettings (Maybe NestingLevelValue)
- docDbSettings_databaseName :: Lens' DocDbSettings (Maybe Text)
- docDbSettings_docsToInvestigate :: Lens' DocDbSettings (Maybe Int)
- docDbSettings_secretsManagerSecretId :: Lens' DocDbSettings (Maybe Text)
- docDbSettings_extractDocId :: Lens' DocDbSettings (Maybe Bool)
- docDbSettings_port :: Lens' DocDbSettings (Maybe Int)
- data DynamoDbSettings = DynamoDbSettings' {}
- newDynamoDbSettings :: Text -> DynamoDbSettings
- dynamoDbSettings_serviceAccessRoleArn :: Lens' DynamoDbSettings Text
- data ElasticsearchSettings = ElasticsearchSettings' {}
- newElasticsearchSettings :: Text -> Text -> ElasticsearchSettings
- elasticsearchSettings_fullLoadErrorPercentage :: Lens' ElasticsearchSettings (Maybe Int)
- elasticsearchSettings_errorRetryDuration :: Lens' ElasticsearchSettings (Maybe Int)
- elasticsearchSettings_serviceAccessRoleArn :: Lens' ElasticsearchSettings Text
- elasticsearchSettings_endpointUri :: Lens' ElasticsearchSettings Text
- data Endpoint = Endpoint' {
- status :: Maybe Text
- dmsTransferSettings :: Maybe DmsTransferSettings
- mySQLSettings :: Maybe MySQLSettings
- serverName :: Maybe Text
- microsoftSQLServerSettings :: Maybe MicrosoftSQLServerSettings
- certificateArn :: Maybe Text
- serviceAccessRoleArn :: Maybe Text
- docDbSettings :: Maybe DocDbSettings
- engineDisplayName :: Maybe Text
- postgreSQLSettings :: Maybe PostgreSQLSettings
- extraConnectionAttributes :: Maybe Text
- kafkaSettings :: Maybe KafkaSettings
- oracleSettings :: Maybe OracleSettings
- endpointType :: Maybe ReplicationEndpointTypeValue
- redshiftSettings :: Maybe RedshiftSettings
- elasticsearchSettings :: Maybe ElasticsearchSettings
- username :: Maybe Text
- externalTableDefinition :: Maybe Text
- engineName :: Maybe Text
- redisSettings :: Maybe RedisSettings
- neptuneSettings :: Maybe NeptuneSettings
- iBMDb2Settings :: Maybe IBMDb2Settings
- kmsKeyId :: Maybe Text
- mongoDbSettings :: Maybe MongoDbSettings
- sslMode :: Maybe DmsSslModeValue
- sybaseSettings :: Maybe SybaseSettings
- databaseName :: Maybe Text
- s3Settings :: Maybe S3Settings
- kinesisSettings :: Maybe KinesisSettings
- endpointIdentifier :: Maybe Text
- externalId :: Maybe Text
- dynamoDbSettings :: Maybe DynamoDbSettings
- endpointArn :: Maybe Text
- port :: Maybe Int
- newEndpoint :: Endpoint
- endpoint_status :: Lens' Endpoint (Maybe Text)
- endpoint_dmsTransferSettings :: Lens' Endpoint (Maybe DmsTransferSettings)
- endpoint_mySQLSettings :: Lens' Endpoint (Maybe MySQLSettings)
- endpoint_serverName :: Lens' Endpoint (Maybe Text)
- endpoint_microsoftSQLServerSettings :: Lens' Endpoint (Maybe MicrosoftSQLServerSettings)
- endpoint_certificateArn :: Lens' Endpoint (Maybe Text)
- endpoint_serviceAccessRoleArn :: Lens' Endpoint (Maybe Text)
- endpoint_docDbSettings :: Lens' Endpoint (Maybe DocDbSettings)
- endpoint_engineDisplayName :: Lens' Endpoint (Maybe Text)
- endpoint_postgreSQLSettings :: Lens' Endpoint (Maybe PostgreSQLSettings)
- endpoint_extraConnectionAttributes :: Lens' Endpoint (Maybe Text)
- endpoint_kafkaSettings :: Lens' Endpoint (Maybe KafkaSettings)
- endpoint_oracleSettings :: Lens' Endpoint (Maybe OracleSettings)
- endpoint_endpointType :: Lens' Endpoint (Maybe ReplicationEndpointTypeValue)
- endpoint_redshiftSettings :: Lens' Endpoint (Maybe RedshiftSettings)
- endpoint_elasticsearchSettings :: Lens' Endpoint (Maybe ElasticsearchSettings)
- endpoint_username :: Lens' Endpoint (Maybe Text)
- endpoint_externalTableDefinition :: Lens' Endpoint (Maybe Text)
- endpoint_engineName :: Lens' Endpoint (Maybe Text)
- endpoint_redisSettings :: Lens' Endpoint (Maybe RedisSettings)
- endpoint_neptuneSettings :: Lens' Endpoint (Maybe NeptuneSettings)
- endpoint_iBMDb2Settings :: Lens' Endpoint (Maybe IBMDb2Settings)
- endpoint_kmsKeyId :: Lens' Endpoint (Maybe Text)
- endpoint_mongoDbSettings :: Lens' Endpoint (Maybe MongoDbSettings)
- endpoint_sslMode :: Lens' Endpoint (Maybe DmsSslModeValue)
- endpoint_sybaseSettings :: Lens' Endpoint (Maybe SybaseSettings)
- endpoint_databaseName :: Lens' Endpoint (Maybe Text)
- endpoint_s3Settings :: Lens' Endpoint (Maybe S3Settings)
- endpoint_kinesisSettings :: Lens' Endpoint (Maybe KinesisSettings)
- endpoint_endpointIdentifier :: Lens' Endpoint (Maybe Text)
- endpoint_externalId :: Lens' Endpoint (Maybe Text)
- endpoint_dynamoDbSettings :: Lens' Endpoint (Maybe DynamoDbSettings)
- endpoint_endpointArn :: Lens' Endpoint (Maybe Text)
- endpoint_port :: Lens' Endpoint (Maybe Int)
- data EndpointSetting = EndpointSetting' {
- sensitive :: Maybe Bool
- intValueMax :: Maybe Int
- applicability :: Maybe Text
- name :: Maybe Text
- intValueMin :: Maybe Int
- units :: Maybe Text
- defaultValue :: Maybe Text
- type' :: Maybe EndpointSettingTypeValue
- enumValues :: Maybe [Text]
- newEndpointSetting :: EndpointSetting
- endpointSetting_sensitive :: Lens' EndpointSetting (Maybe Bool)
- endpointSetting_intValueMax :: Lens' EndpointSetting (Maybe Int)
- endpointSetting_applicability :: Lens' EndpointSetting (Maybe Text)
- endpointSetting_name :: Lens' EndpointSetting (Maybe Text)
- endpointSetting_intValueMin :: Lens' EndpointSetting (Maybe Int)
- endpointSetting_units :: Lens' EndpointSetting (Maybe Text)
- endpointSetting_defaultValue :: Lens' EndpointSetting (Maybe Text)
- endpointSetting_type :: Lens' EndpointSetting (Maybe EndpointSettingTypeValue)
- endpointSetting_enumValues :: Lens' EndpointSetting (Maybe [Text])
- data Event = Event' {
- sourceType :: Maybe SourceType
- sourceIdentifier :: Maybe Text
- date :: Maybe POSIX
- eventCategories :: Maybe [Text]
- message :: Maybe Text
- newEvent :: Event
- event_sourceType :: Lens' Event (Maybe SourceType)
- event_sourceIdentifier :: Lens' Event (Maybe Text)
- event_date :: Lens' Event (Maybe UTCTime)
- event_eventCategories :: Lens' Event (Maybe [Text])
- event_message :: Lens' Event (Maybe Text)
- data EventCategoryGroup = EventCategoryGroup' {
- sourceType :: Maybe Text
- eventCategories :: Maybe [Text]
- newEventCategoryGroup :: EventCategoryGroup
- eventCategoryGroup_sourceType :: Lens' EventCategoryGroup (Maybe Text)
- eventCategoryGroup_eventCategories :: Lens' EventCategoryGroup (Maybe [Text])
- data EventSubscription = EventSubscription' {}
- newEventSubscription :: EventSubscription
- eventSubscription_status :: Lens' EventSubscription (Maybe Text)
- eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text)
- eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text)
- eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text)
- eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool)
- eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text)
- eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text)
- eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text])
- eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text])
- data Filter = Filter' {}
- newFilter :: Text -> Filter
- filter_name :: Lens' Filter Text
- filter_values :: Lens' Filter [Text]
- data IBMDb2Settings = IBMDb2Settings' {}
- newIBMDb2Settings :: IBMDb2Settings
- iBMDb2Settings_serverName :: Lens' IBMDb2Settings (Maybe Text)
- iBMDb2Settings_currentLsn :: Lens' IBMDb2Settings (Maybe Text)
- iBMDb2Settings_setDataCaptureChanges :: Lens' IBMDb2Settings (Maybe Bool)
- iBMDb2Settings_secretsManagerAccessRoleArn :: Lens' IBMDb2Settings (Maybe Text)
- iBMDb2Settings_username :: Lens' IBMDb2Settings (Maybe Text)
- iBMDb2Settings_password :: Lens' IBMDb2Settings (Maybe Text)
- iBMDb2Settings_databaseName :: Lens' IBMDb2Settings (Maybe Text)
- iBMDb2Settings_secretsManagerSecretId :: Lens' IBMDb2Settings (Maybe Text)
- iBMDb2Settings_maxKBytesPerRead :: Lens' IBMDb2Settings (Maybe Int)
- iBMDb2Settings_port :: Lens' IBMDb2Settings (Maybe Int)
- data KafkaSettings = KafkaSettings' {
- sslClientKeyArn :: Maybe Text
- includeTransactionDetails :: Maybe Bool
- includeTableAlterOperations :: Maybe Bool
- sslClientCertificateArn :: Maybe Text
- sslCaCertificateArn :: Maybe Text
- partitionIncludeSchemaTable :: Maybe Bool
- topic :: Maybe Text
- includeControlDetails :: Maybe Bool
- noHexPrefix :: Maybe Bool
- saslPassword :: Maybe (Sensitive Text)
- sslClientKeyPassword :: Maybe (Sensitive Text)
- includePartitionValue :: Maybe Bool
- messageFormat :: Maybe MessageFormatValue
- securityProtocol :: Maybe KafkaSecurityProtocol
- saslUsername :: Maybe Text
- broker :: Maybe Text
- messageMaxBytes :: Maybe Int
- includeNullAndEmpty :: Maybe Bool
- newKafkaSettings :: KafkaSettings
- kafkaSettings_sslClientKeyArn :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_includeTransactionDetails :: Lens' KafkaSettings (Maybe Bool)
- kafkaSettings_includeTableAlterOperations :: Lens' KafkaSettings (Maybe Bool)
- kafkaSettings_sslClientCertificateArn :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_sslCaCertificateArn :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_partitionIncludeSchemaTable :: Lens' KafkaSettings (Maybe Bool)
- kafkaSettings_topic :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_includeControlDetails :: Lens' KafkaSettings (Maybe Bool)
- kafkaSettings_noHexPrefix :: Lens' KafkaSettings (Maybe Bool)
- kafkaSettings_saslPassword :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_sslClientKeyPassword :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_includePartitionValue :: Lens' KafkaSettings (Maybe Bool)
- kafkaSettings_messageFormat :: Lens' KafkaSettings (Maybe MessageFormatValue)
- kafkaSettings_securityProtocol :: Lens' KafkaSettings (Maybe KafkaSecurityProtocol)
- kafkaSettings_saslUsername :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_broker :: Lens' KafkaSettings (Maybe Text)
- kafkaSettings_messageMaxBytes :: Lens' KafkaSettings (Maybe Int)
- kafkaSettings_includeNullAndEmpty :: Lens' KafkaSettings (Maybe Bool)
- data KinesisSettings = KinesisSettings' {
- includeTransactionDetails :: Maybe Bool
- includeTableAlterOperations :: Maybe Bool
- serviceAccessRoleArn :: Maybe Text
- partitionIncludeSchemaTable :: Maybe Bool
- streamArn :: Maybe Text
- includeControlDetails :: Maybe Bool
- noHexPrefix :: Maybe Bool
- includePartitionValue :: Maybe Bool
- messageFormat :: Maybe MessageFormatValue
- includeNullAndEmpty :: Maybe Bool
- newKinesisSettings :: KinesisSettings
- kinesisSettings_includeTransactionDetails :: Lens' KinesisSettings (Maybe Bool)
- kinesisSettings_includeTableAlterOperations :: Lens' KinesisSettings (Maybe Bool)
- kinesisSettings_serviceAccessRoleArn :: Lens' KinesisSettings (Maybe Text)
- kinesisSettings_partitionIncludeSchemaTable :: Lens' KinesisSettings (Maybe Bool)
- kinesisSettings_streamArn :: Lens' KinesisSettings (Maybe Text)
- kinesisSettings_includeControlDetails :: Lens' KinesisSettings (Maybe Bool)
- kinesisSettings_noHexPrefix :: Lens' KinesisSettings (Maybe Bool)
- kinesisSettings_includePartitionValue :: Lens' KinesisSettings (Maybe Bool)
- kinesisSettings_messageFormat :: Lens' KinesisSettings (Maybe MessageFormatValue)
- kinesisSettings_includeNullAndEmpty :: Lens' KinesisSettings (Maybe Bool)
- data MicrosoftSQLServerSettings = MicrosoftSQLServerSettings' {
- bcpPacketSize :: Maybe Int
- useBcpFullLoad :: Maybe Bool
- serverName :: Maybe Text
- querySingleAlwaysOnNode :: Maybe Bool
- secretsManagerAccessRoleArn :: Maybe Text
- username :: Maybe Text
- safeguardPolicy :: Maybe SafeguardPolicy
- password :: Maybe (Sensitive Text)
- databaseName :: Maybe Text
- secretsManagerSecretId :: Maybe Text
- readBackupOnly :: Maybe Bool
- useThirdPartyBackupDevice :: Maybe Bool
- controlTablesFileGroup :: Maybe Text
- port :: Maybe Int
- newMicrosoftSQLServerSettings :: MicrosoftSQLServerSettings
- microsoftSQLServerSettings_bcpPacketSize :: Lens' MicrosoftSQLServerSettings (Maybe Int)
- microsoftSQLServerSettings_useBcpFullLoad :: Lens' MicrosoftSQLServerSettings (Maybe Bool)
- microsoftSQLServerSettings_serverName :: Lens' MicrosoftSQLServerSettings (Maybe Text)
- microsoftSQLServerSettings_querySingleAlwaysOnNode :: Lens' MicrosoftSQLServerSettings (Maybe Bool)
- microsoftSQLServerSettings_secretsManagerAccessRoleArn :: Lens' MicrosoftSQLServerSettings (Maybe Text)
- microsoftSQLServerSettings_username :: Lens' MicrosoftSQLServerSettings (Maybe Text)
- microsoftSQLServerSettings_safeguardPolicy :: Lens' MicrosoftSQLServerSettings (Maybe SafeguardPolicy)
- microsoftSQLServerSettings_password :: Lens' MicrosoftSQLServerSettings (Maybe Text)
- microsoftSQLServerSettings_databaseName :: Lens' MicrosoftSQLServerSettings (Maybe Text)
- microsoftSQLServerSettings_secretsManagerSecretId :: Lens' MicrosoftSQLServerSettings (Maybe Text)
- microsoftSQLServerSettings_readBackupOnly :: Lens' MicrosoftSQLServerSettings (Maybe Bool)
- microsoftSQLServerSettings_useThirdPartyBackupDevice :: Lens' MicrosoftSQLServerSettings (Maybe Bool)
- microsoftSQLServerSettings_controlTablesFileGroup :: Lens' MicrosoftSQLServerSettings (Maybe Text)
- microsoftSQLServerSettings_port :: Lens' MicrosoftSQLServerSettings (Maybe Int)
- data MongoDbSettings = MongoDbSettings' {
- serverName :: Maybe Text
- secretsManagerAccessRoleArn :: Maybe Text
- authMechanism :: Maybe AuthMechanismValue
- username :: Maybe Text
- kmsKeyId :: Maybe Text
- password :: Maybe (Sensitive Text)
- nestingLevel :: Maybe NestingLevelValue
- databaseName :: Maybe Text
- docsToInvestigate :: Maybe Text
- authSource :: Maybe Text
- secretsManagerSecretId :: Maybe Text
- extractDocId :: Maybe Text
- authType :: Maybe AuthTypeValue
- port :: Maybe Int
- newMongoDbSettings :: MongoDbSettings
- mongoDbSettings_serverName :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_secretsManagerAccessRoleArn :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_authMechanism :: Lens' MongoDbSettings (Maybe AuthMechanismValue)
- mongoDbSettings_username :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_kmsKeyId :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_password :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_nestingLevel :: Lens' MongoDbSettings (Maybe NestingLevelValue)
- mongoDbSettings_databaseName :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_docsToInvestigate :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_authSource :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_secretsManagerSecretId :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_extractDocId :: Lens' MongoDbSettings (Maybe Text)
- mongoDbSettings_authType :: Lens' MongoDbSettings (Maybe AuthTypeValue)
- mongoDbSettings_port :: Lens' MongoDbSettings (Maybe Int)
- data MySQLSettings = MySQLSettings' {
- maxFileSize :: Maybe Int
- targetDbType :: Maybe TargetDbType
- serverName :: Maybe Text
- cleanSourceMetadataOnMismatch :: Maybe Bool
- parallelLoadThreads :: Maybe Int
- secretsManagerAccessRoleArn :: Maybe Text
- username :: Maybe Text
- password :: Maybe (Sensitive Text)
- eventsPollInterval :: Maybe Int
- databaseName :: Maybe Text
- afterConnectScript :: Maybe Text
- secretsManagerSecretId :: Maybe Text
- serverTimezone :: Maybe Text
- port :: Maybe Int
- newMySQLSettings :: MySQLSettings
- mySQLSettings_maxFileSize :: Lens' MySQLSettings (Maybe Int)
- mySQLSettings_targetDbType :: Lens' MySQLSettings (Maybe TargetDbType)
- mySQLSettings_serverName :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_cleanSourceMetadataOnMismatch :: Lens' MySQLSettings (Maybe Bool)
- mySQLSettings_parallelLoadThreads :: Lens' MySQLSettings (Maybe Int)
- mySQLSettings_secretsManagerAccessRoleArn :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_username :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_password :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_eventsPollInterval :: Lens' MySQLSettings (Maybe Int)
- mySQLSettings_databaseName :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_afterConnectScript :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_secretsManagerSecretId :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_serverTimezone :: Lens' MySQLSettings (Maybe Text)
- mySQLSettings_port :: Lens' MySQLSettings (Maybe Int)
- data NeptuneSettings = NeptuneSettings' {}
- newNeptuneSettings :: Text -> Text -> NeptuneSettings
- neptuneSettings_maxFileSize :: Lens' NeptuneSettings (Maybe Int)
- neptuneSettings_maxRetryCount :: Lens' NeptuneSettings (Maybe Int)
- neptuneSettings_serviceAccessRoleArn :: Lens' NeptuneSettings (Maybe Text)
- neptuneSettings_iamAuthEnabled :: Lens' NeptuneSettings (Maybe Bool)
- neptuneSettings_errorRetryDuration :: Lens' NeptuneSettings (Maybe Int)
- neptuneSettings_s3BucketName :: Lens' NeptuneSettings Text
- neptuneSettings_s3BucketFolder :: Lens' NeptuneSettings Text
- data OracleSettings = OracleSettings' {
- useBFile :: Maybe Bool
- standbyDelayTime :: Maybe Int
- failTasksOnLobTruncation :: Maybe Bool
- serverName :: Maybe Text
- directPathNoLog :: Maybe Bool
- extraArchivedLogDestIds :: Maybe [Int]
- securityDbEncryptionName :: Maybe Text
- oraclePathPrefix :: Maybe Text
- secretsManagerAccessRoleArn :: Maybe Text
- useDirectPathFullLoad :: Maybe Bool
- username :: Maybe Text
- allowSelectNestedTables :: Maybe Bool
- readAheadBlocks :: Maybe Int
- archivedLogDestId :: Maybe Int
- replacePathPrefix :: Maybe Bool
- accessAlternateDirectly :: Maybe Bool
- secretsManagerOracleAsmSecretId :: Maybe Text
- securityDbEncryption :: Maybe (Sensitive Text)
- useLogminerReader :: Maybe Bool
- readTableSpaceName :: Maybe Bool
- retryInterval :: Maybe Int
- password :: Maybe (Sensitive Text)
- spatialDataOptionToGeoJsonFunctionName :: Maybe Text
- databaseName :: Maybe Text
- addSupplementalLogging :: Maybe Bool
- secretsManagerOracleAsmAccessRoleArn :: Maybe Text
- asmServer :: Maybe Text
- charLengthSemantics :: Maybe CharLengthSemantics
- archivedLogsOnly :: Maybe Bool
- directPathParallelLoad :: Maybe Bool
- secretsManagerSecretId :: Maybe Text
- additionalArchivedLogDestId :: Maybe Int
- asmPassword :: Maybe (Sensitive Text)
- enableHomogenousTablespace :: Maybe Bool
- parallelAsmReadThreads :: Maybe Int
- numberDatatypeScale :: Maybe Int
- usePathPrefix :: Maybe Text
- asmUser :: Maybe Text
- useAlternateFolderForOnline :: Maybe Bool
- port :: Maybe Int
- newOracleSettings :: OracleSettings
- oracleSettings_useBFile :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_standbyDelayTime :: Lens' OracleSettings (Maybe Int)
- oracleSettings_failTasksOnLobTruncation :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_serverName :: Lens' OracleSettings (Maybe Text)
- oracleSettings_directPathNoLog :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_extraArchivedLogDestIds :: Lens' OracleSettings (Maybe [Int])
- oracleSettings_securityDbEncryptionName :: Lens' OracleSettings (Maybe Text)
- oracleSettings_oraclePathPrefix :: Lens' OracleSettings (Maybe Text)
- oracleSettings_secretsManagerAccessRoleArn :: Lens' OracleSettings (Maybe Text)
- oracleSettings_useDirectPathFullLoad :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_username :: Lens' OracleSettings (Maybe Text)
- oracleSettings_allowSelectNestedTables :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_readAheadBlocks :: Lens' OracleSettings (Maybe Int)
- oracleSettings_archivedLogDestId :: Lens' OracleSettings (Maybe Int)
- oracleSettings_replacePathPrefix :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_accessAlternateDirectly :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_secretsManagerOracleAsmSecretId :: Lens' OracleSettings (Maybe Text)
- oracleSettings_securityDbEncryption :: Lens' OracleSettings (Maybe Text)
- oracleSettings_useLogminerReader :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_readTableSpaceName :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_retryInterval :: Lens' OracleSettings (Maybe Int)
- oracleSettings_password :: Lens' OracleSettings (Maybe Text)
- oracleSettings_spatialDataOptionToGeoJsonFunctionName :: Lens' OracleSettings (Maybe Text)
- oracleSettings_databaseName :: Lens' OracleSettings (Maybe Text)
- oracleSettings_addSupplementalLogging :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_secretsManagerOracleAsmAccessRoleArn :: Lens' OracleSettings (Maybe Text)
- oracleSettings_asmServer :: Lens' OracleSettings (Maybe Text)
- oracleSettings_charLengthSemantics :: Lens' OracleSettings (Maybe CharLengthSemantics)
- oracleSettings_archivedLogsOnly :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_directPathParallelLoad :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_secretsManagerSecretId :: Lens' OracleSettings (Maybe Text)
- oracleSettings_additionalArchivedLogDestId :: Lens' OracleSettings (Maybe Int)
- oracleSettings_asmPassword :: Lens' OracleSettings (Maybe Text)
- oracleSettings_enableHomogenousTablespace :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_parallelAsmReadThreads :: Lens' OracleSettings (Maybe Int)
- oracleSettings_numberDatatypeScale :: Lens' OracleSettings (Maybe Int)
- oracleSettings_usePathPrefix :: Lens' OracleSettings (Maybe Text)
- oracleSettings_asmUser :: Lens' OracleSettings (Maybe Text)
- oracleSettings_useAlternateFolderForOnline :: Lens' OracleSettings (Maybe Bool)
- oracleSettings_port :: Lens' OracleSettings (Maybe Int)
- data OrderableReplicationInstance = OrderableReplicationInstance' {
- engineVersion :: Maybe Text
- minAllocatedStorage :: Maybe Int
- releaseStatus :: Maybe ReleaseStatusValues
- includedAllocatedStorage :: Maybe Int
- availabilityZones :: Maybe [Text]
- maxAllocatedStorage :: Maybe Int
- replicationInstanceClass :: Maybe Text
- defaultAllocatedStorage :: Maybe Int
- storageType :: Maybe Text
- newOrderableReplicationInstance :: OrderableReplicationInstance
- orderableReplicationInstance_engineVersion :: Lens' OrderableReplicationInstance (Maybe Text)
- orderableReplicationInstance_minAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int)
- orderableReplicationInstance_releaseStatus :: Lens' OrderableReplicationInstance (Maybe ReleaseStatusValues)
- orderableReplicationInstance_includedAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int)
- orderableReplicationInstance_availabilityZones :: Lens' OrderableReplicationInstance (Maybe [Text])
- orderableReplicationInstance_maxAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int)
- orderableReplicationInstance_replicationInstanceClass :: Lens' OrderableReplicationInstance (Maybe Text)
- orderableReplicationInstance_defaultAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int)
- orderableReplicationInstance_storageType :: Lens' OrderableReplicationInstance (Maybe Text)
- data PendingMaintenanceAction = PendingMaintenanceAction' {}
- newPendingMaintenanceAction :: PendingMaintenanceAction
- pendingMaintenanceAction_autoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)
- pendingMaintenanceAction_action :: Lens' PendingMaintenanceAction (Maybe Text)
- pendingMaintenanceAction_optInStatus :: Lens' PendingMaintenanceAction (Maybe Text)
- pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text)
- pendingMaintenanceAction_forcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)
- pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime)
- data PostgreSQLSettings = PostgreSQLSettings' {
- executeTimeout :: Maybe Int
- maxFileSize :: Maybe Int
- failTasksOnLobTruncation :: Maybe Bool
- serverName :: Maybe Text
- ddlArtifactsSchema :: Maybe Text
- slotName :: Maybe Text
- secretsManagerAccessRoleArn :: Maybe Text
- username :: Maybe Text
- heartbeatFrequency :: Maybe Int
- password :: Maybe (Sensitive Text)
- databaseName :: Maybe Text
- afterConnectScript :: Maybe Text
- secretsManagerSecretId :: Maybe Text
- captureDdls :: Maybe Bool
- pluginName :: Maybe PluginNameValue
- port :: Maybe Int
- heartbeatSchema :: Maybe Text
- heartbeatEnable :: Maybe Bool
- newPostgreSQLSettings :: PostgreSQLSettings
- postgreSQLSettings_executeTimeout :: Lens' PostgreSQLSettings (Maybe Int)
- postgreSQLSettings_maxFileSize :: Lens' PostgreSQLSettings (Maybe Int)
- postgreSQLSettings_failTasksOnLobTruncation :: Lens' PostgreSQLSettings (Maybe Bool)
- postgreSQLSettings_serverName :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_ddlArtifactsSchema :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_slotName :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_secretsManagerAccessRoleArn :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_username :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_heartbeatFrequency :: Lens' PostgreSQLSettings (Maybe Int)
- postgreSQLSettings_password :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_databaseName :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_afterConnectScript :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_secretsManagerSecretId :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_captureDdls :: Lens' PostgreSQLSettings (Maybe Bool)
- postgreSQLSettings_pluginName :: Lens' PostgreSQLSettings (Maybe PluginNameValue)
- postgreSQLSettings_port :: Lens' PostgreSQLSettings (Maybe Int)
- postgreSQLSettings_heartbeatSchema :: Lens' PostgreSQLSettings (Maybe Text)
- postgreSQLSettings_heartbeatEnable :: Lens' PostgreSQLSettings (Maybe Bool)
- data RedisSettings = RedisSettings' {}
- newRedisSettings :: Text -> Int -> RedisSettings
- redisSettings_sslSecurityProtocol :: Lens' RedisSettings (Maybe SslSecurityProtocolValue)
- redisSettings_authUserName :: Lens' RedisSettings (Maybe Text)
- redisSettings_sslCaCertificateArn :: Lens' RedisSettings (Maybe Text)
- redisSettings_authPassword :: Lens' RedisSettings (Maybe Text)
- redisSettings_authType :: Lens' RedisSettings (Maybe RedisAuthTypeValue)
- redisSettings_serverName :: Lens' RedisSettings Text
- redisSettings_port :: Lens' RedisSettings Int
- data RedshiftSettings = RedshiftSettings' {
- emptyAsNull :: Maybe Bool
- caseSensitiveNames :: Maybe Bool
- maxFileSize :: Maybe Int
- replaceChars :: Maybe Text
- serverName :: Maybe Text
- connectionTimeout :: Maybe Int
- loadTimeout :: Maybe Int
- serviceAccessRoleArn :: Maybe Text
- explicitIds :: Maybe Bool
- bucketFolder :: Maybe Text
- truncateColumns :: Maybe Bool
- secretsManagerAccessRoleArn :: Maybe Text
- replaceInvalidChars :: Maybe Text
- username :: Maybe Text
- bucketName :: Maybe Text
- encryptionMode :: Maybe EncryptionModeValue
- dateFormat :: Maybe Text
- removeQuotes :: Maybe Bool
- password :: Maybe (Sensitive Text)
- databaseName :: Maybe Text
- acceptAnyDate :: Maybe Bool
- afterConnectScript :: Maybe Text
- secretsManagerSecretId :: Maybe Text
- writeBufferSize :: Maybe Int
- compUpdate :: Maybe Bool
- trimBlanks :: Maybe Bool
- timeFormat :: Maybe Text
- serverSideEncryptionKmsKeyId :: Maybe Text
- port :: Maybe Int
- fileTransferUploadStreams :: Maybe Int
- newRedshiftSettings :: RedshiftSettings
- redshiftSettings_emptyAsNull :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_caseSensitiveNames :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_maxFileSize :: Lens' RedshiftSettings (Maybe Int)
- redshiftSettings_replaceChars :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_serverName :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_connectionTimeout :: Lens' RedshiftSettings (Maybe Int)
- redshiftSettings_loadTimeout :: Lens' RedshiftSettings (Maybe Int)
- redshiftSettings_serviceAccessRoleArn :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_explicitIds :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_bucketFolder :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_truncateColumns :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_secretsManagerAccessRoleArn :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_replaceInvalidChars :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_username :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_bucketName :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_encryptionMode :: Lens' RedshiftSettings (Maybe EncryptionModeValue)
- redshiftSettings_dateFormat :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_removeQuotes :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_password :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_databaseName :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_acceptAnyDate :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_afterConnectScript :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_secretsManagerSecretId :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_writeBufferSize :: Lens' RedshiftSettings (Maybe Int)
- redshiftSettings_compUpdate :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_trimBlanks :: Lens' RedshiftSettings (Maybe Bool)
- redshiftSettings_timeFormat :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_serverSideEncryptionKmsKeyId :: Lens' RedshiftSettings (Maybe Text)
- redshiftSettings_port :: Lens' RedshiftSettings (Maybe Int)
- redshiftSettings_fileTransferUploadStreams :: Lens' RedshiftSettings (Maybe Int)
- data RefreshSchemasStatus = RefreshSchemasStatus' {}
- newRefreshSchemasStatus :: RefreshSchemasStatus
- refreshSchemasStatus_status :: Lens' RefreshSchemasStatus (Maybe RefreshSchemasStatusTypeValue)
- refreshSchemasStatus_lastRefreshDate :: Lens' RefreshSchemasStatus (Maybe UTCTime)
- refreshSchemasStatus_replicationInstanceArn :: Lens' RefreshSchemasStatus (Maybe Text)
- refreshSchemasStatus_endpointArn :: Lens' RefreshSchemasStatus (Maybe Text)
- refreshSchemasStatus_lastFailureMessage :: Lens' RefreshSchemasStatus (Maybe Text)
- data ReplicationInstance = ReplicationInstance' {
- engineVersion :: Maybe Text
- publiclyAccessible :: Maybe Bool
- autoMinorVersionUpgrade :: Maybe Bool
- replicationInstancePublicIpAddresses :: Maybe [Text]
- replicationSubnetGroup :: Maybe ReplicationSubnetGroup
- instanceCreateTime :: Maybe POSIX
- freeUntil :: Maybe POSIX
- replicationInstanceStatus :: Maybe Text
- replicationInstancePrivateIpAddresses :: Maybe [Text]
- preferredMaintenanceWindow :: Maybe Text
- replicationInstancePrivateIpAddress :: Maybe Text
- kmsKeyId :: Maybe Text
- availabilityZone :: Maybe Text
- vpcSecurityGroups :: Maybe [VpcSecurityGroupMembership]
- multiAZ :: Maybe Bool
- secondaryAvailabilityZone :: Maybe Text
- replicationInstanceArn :: Maybe Text
- allocatedStorage :: Maybe Int
- dnsNameServers :: Maybe Text
- replicationInstancePublicIpAddress :: Maybe Text
- replicationInstanceClass :: Maybe Text
- replicationInstanceIdentifier :: Maybe Text
- pendingModifiedValues :: Maybe ReplicationPendingModifiedValues
- newReplicationInstance :: ReplicationInstance
- replicationInstance_engineVersion :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_publiclyAccessible :: Lens' ReplicationInstance (Maybe Bool)
- replicationInstance_autoMinorVersionUpgrade :: Lens' ReplicationInstance (Maybe Bool)
- replicationInstance_replicationInstancePublicIpAddresses :: Lens' ReplicationInstance (Maybe [Text])
- replicationInstance_replicationSubnetGroup :: Lens' ReplicationInstance (Maybe ReplicationSubnetGroup)
- replicationInstance_instanceCreateTime :: Lens' ReplicationInstance (Maybe UTCTime)
- replicationInstance_freeUntil :: Lens' ReplicationInstance (Maybe UTCTime)
- replicationInstance_replicationInstanceStatus :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_replicationInstancePrivateIpAddresses :: Lens' ReplicationInstance (Maybe [Text])
- replicationInstance_preferredMaintenanceWindow :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_replicationInstancePrivateIpAddress :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_kmsKeyId :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_availabilityZone :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_vpcSecurityGroups :: Lens' ReplicationInstance (Maybe [VpcSecurityGroupMembership])
- replicationInstance_multiAZ :: Lens' ReplicationInstance (Maybe Bool)
- replicationInstance_secondaryAvailabilityZone :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_replicationInstanceArn :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_allocatedStorage :: Lens' ReplicationInstance (Maybe Int)
- replicationInstance_dnsNameServers :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_replicationInstancePublicIpAddress :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_replicationInstanceClass :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_replicationInstanceIdentifier :: Lens' ReplicationInstance (Maybe Text)
- replicationInstance_pendingModifiedValues :: Lens' ReplicationInstance (Maybe ReplicationPendingModifiedValues)
- data ReplicationInstanceTaskLog = ReplicationInstanceTaskLog' {}
- newReplicationInstanceTaskLog :: ReplicationInstanceTaskLog
- replicationInstanceTaskLog_replicationTaskName :: Lens' ReplicationInstanceTaskLog (Maybe Text)
- replicationInstanceTaskLog_replicationTaskArn :: Lens' ReplicationInstanceTaskLog (Maybe Text)
- replicationInstanceTaskLog_replicationInstanceTaskLogSize :: Lens' ReplicationInstanceTaskLog (Maybe Integer)
- data ReplicationPendingModifiedValues = ReplicationPendingModifiedValues' {}
- newReplicationPendingModifiedValues :: ReplicationPendingModifiedValues
- replicationPendingModifiedValues_engineVersion :: Lens' ReplicationPendingModifiedValues (Maybe Text)
- replicationPendingModifiedValues_multiAZ :: Lens' ReplicationPendingModifiedValues (Maybe Bool)
- replicationPendingModifiedValues_allocatedStorage :: Lens' ReplicationPendingModifiedValues (Maybe Int)
- replicationPendingModifiedValues_replicationInstanceClass :: Lens' ReplicationPendingModifiedValues (Maybe Text)
- data ReplicationSubnetGroup = ReplicationSubnetGroup' {}
- newReplicationSubnetGroup :: ReplicationSubnetGroup
- replicationSubnetGroup_vpcId :: Lens' ReplicationSubnetGroup (Maybe Text)
- replicationSubnetGroup_subnets :: Lens' ReplicationSubnetGroup (Maybe [Subnet])
- replicationSubnetGroup_replicationSubnetGroupIdentifier :: Lens' ReplicationSubnetGroup (Maybe Text)
- replicationSubnetGroup_subnetGroupStatus :: Lens' ReplicationSubnetGroup (Maybe Text)
- replicationSubnetGroup_replicationSubnetGroupDescription :: Lens' ReplicationSubnetGroup (Maybe Text)
- data ReplicationTask = ReplicationTask' {
- replicationTaskSettings :: Maybe Text
- status :: Maybe Text
- stopReason :: Maybe Text
- targetEndpointArn :: Maybe Text
- replicationTaskIdentifier :: Maybe Text
- cdcStartPosition :: Maybe Text
- replicationTaskStartDate :: Maybe POSIX
- sourceEndpointArn :: Maybe Text
- recoveryCheckpoint :: Maybe Text
- tableMappings :: Maybe Text
- targetReplicationInstanceArn :: Maybe Text
- replicationTaskCreationDate :: Maybe POSIX
- migrationType :: Maybe MigrationTypeValue
- replicationTaskArn :: Maybe Text
- taskData :: Maybe Text
- cdcStopPosition :: Maybe Text
- replicationTaskStats :: Maybe ReplicationTaskStats
- replicationInstanceArn :: Maybe Text
- lastFailureMessage :: Maybe Text
- newReplicationTask :: ReplicationTask
- replicationTask_replicationTaskSettings :: Lens' ReplicationTask (Maybe Text)
- replicationTask_status :: Lens' ReplicationTask (Maybe Text)
- replicationTask_stopReason :: Lens' ReplicationTask (Maybe Text)
- replicationTask_targetEndpointArn :: Lens' ReplicationTask (Maybe Text)
- replicationTask_replicationTaskIdentifier :: Lens' ReplicationTask (Maybe Text)
- replicationTask_cdcStartPosition :: Lens' ReplicationTask (Maybe Text)
- replicationTask_replicationTaskStartDate :: Lens' ReplicationTask (Maybe UTCTime)
- replicationTask_sourceEndpointArn :: Lens' ReplicationTask (Maybe Text)
- replicationTask_recoveryCheckpoint :: Lens' ReplicationTask (Maybe Text)
- replicationTask_tableMappings :: Lens' ReplicationTask (Maybe Text)
- replicationTask_targetReplicationInstanceArn :: Lens' ReplicationTask (Maybe Text)
- replicationTask_replicationTaskCreationDate :: Lens' ReplicationTask (Maybe UTCTime)
- replicationTask_migrationType :: Lens' ReplicationTask (Maybe MigrationTypeValue)
- replicationTask_replicationTaskArn :: Lens' ReplicationTask (Maybe Text)
- replicationTask_taskData :: Lens' ReplicationTask (Maybe Text)
- replicationTask_cdcStopPosition :: Lens' ReplicationTask (Maybe Text)
- replicationTask_replicationTaskStats :: Lens' ReplicationTask (Maybe ReplicationTaskStats)
- replicationTask_replicationInstanceArn :: Lens' ReplicationTask (Maybe Text)
- replicationTask_lastFailureMessage :: Lens' ReplicationTask (Maybe Text)
- data ReplicationTaskAssessmentResult = ReplicationTaskAssessmentResult' {}
- newReplicationTaskAssessmentResult :: ReplicationTaskAssessmentResult
- replicationTaskAssessmentResult_assessmentResults :: Lens' ReplicationTaskAssessmentResult (Maybe Text)
- replicationTaskAssessmentResult_assessmentResultsFile :: Lens' ReplicationTaskAssessmentResult (Maybe Text)
- replicationTaskAssessmentResult_replicationTaskIdentifier :: Lens' ReplicationTaskAssessmentResult (Maybe Text)
- replicationTaskAssessmentResult_assessmentStatus :: Lens' ReplicationTaskAssessmentResult (Maybe Text)
- replicationTaskAssessmentResult_s3ObjectUrl :: Lens' ReplicationTaskAssessmentResult (Maybe Text)
- replicationTaskAssessmentResult_replicationTaskLastAssessmentDate :: Lens' ReplicationTaskAssessmentResult (Maybe UTCTime)
- replicationTaskAssessmentResult_replicationTaskArn :: Lens' ReplicationTaskAssessmentResult (Maybe Text)
- data ReplicationTaskAssessmentRun = ReplicationTaskAssessmentRun' {
- status :: Maybe Text
- serviceAccessRoleArn :: Maybe Text
- replicationTaskAssessmentRunCreationDate :: Maybe POSIX
- assessmentProgress :: Maybe ReplicationTaskAssessmentRunProgress
- resultKmsKeyArn :: Maybe Text
- replicationTaskArn :: Maybe Text
- resultLocationBucket :: Maybe Text
- resultLocationFolder :: Maybe Text
- resultEncryptionMode :: Maybe Text
- assessmentRunName :: Maybe Text
- replicationTaskAssessmentRunArn :: Maybe Text
- lastFailureMessage :: Maybe Text
- newReplicationTaskAssessmentRun :: ReplicationTaskAssessmentRun
- replicationTaskAssessmentRun_status :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_serviceAccessRoleArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_replicationTaskAssessmentRunCreationDate :: Lens' ReplicationTaskAssessmentRun (Maybe UTCTime)
- replicationTaskAssessmentRun_assessmentProgress :: Lens' ReplicationTaskAssessmentRun (Maybe ReplicationTaskAssessmentRunProgress)
- replicationTaskAssessmentRun_resultKmsKeyArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_replicationTaskArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_resultLocationBucket :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_resultLocationFolder :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_resultEncryptionMode :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_assessmentRunName :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_replicationTaskAssessmentRunArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- replicationTaskAssessmentRun_lastFailureMessage :: Lens' ReplicationTaskAssessmentRun (Maybe Text)
- data ReplicationTaskAssessmentRunProgress = ReplicationTaskAssessmentRunProgress' {}
- newReplicationTaskAssessmentRunProgress :: ReplicationTaskAssessmentRunProgress
- replicationTaskAssessmentRunProgress_individualAssessmentCount :: Lens' ReplicationTaskAssessmentRunProgress (Maybe Int)
- replicationTaskAssessmentRunProgress_individualAssessmentCompletedCount :: Lens' ReplicationTaskAssessmentRunProgress (Maybe Int)
- data ReplicationTaskIndividualAssessment = ReplicationTaskIndividualAssessment' {}
- newReplicationTaskIndividualAssessment :: ReplicationTaskIndividualAssessment
- replicationTaskIndividualAssessment_status :: Lens' ReplicationTaskIndividualAssessment (Maybe Text)
- replicationTaskIndividualAssessment_replicationTaskIndividualAssessmentStartDate :: Lens' ReplicationTaskIndividualAssessment (Maybe UTCTime)
- replicationTaskIndividualAssessment_individualAssessmentName :: Lens' ReplicationTaskIndividualAssessment (Maybe Text)
- replicationTaskIndividualAssessment_replicationTaskIndividualAssessmentArn :: Lens' ReplicationTaskIndividualAssessment (Maybe Text)
- replicationTaskIndividualAssessment_replicationTaskAssessmentRunArn :: Lens' ReplicationTaskIndividualAssessment (Maybe Text)
- data ReplicationTaskStats = ReplicationTaskStats' {
- stopDate :: Maybe POSIX
- fullLoadProgressPercent :: Maybe Int
- fullLoadStartDate :: Maybe POSIX
- elapsedTimeMillis :: Maybe Integer
- startDate :: Maybe POSIX
- tablesErrored :: Maybe Int
- fullLoadFinishDate :: Maybe POSIX
- tablesLoaded :: Maybe Int
- tablesQueued :: Maybe Int
- tablesLoading :: Maybe Int
- freshStartDate :: Maybe POSIX
- newReplicationTaskStats :: ReplicationTaskStats
- replicationTaskStats_stopDate :: Lens' ReplicationTaskStats (Maybe UTCTime)
- replicationTaskStats_fullLoadProgressPercent :: Lens' ReplicationTaskStats (Maybe Int)
- replicationTaskStats_fullLoadStartDate :: Lens' ReplicationTaskStats (Maybe UTCTime)
- replicationTaskStats_elapsedTimeMillis :: Lens' ReplicationTaskStats (Maybe Integer)
- replicationTaskStats_startDate :: Lens' ReplicationTaskStats (Maybe UTCTime)
- replicationTaskStats_tablesErrored :: Lens' ReplicationTaskStats (Maybe Int)
- replicationTaskStats_fullLoadFinishDate :: Lens' ReplicationTaskStats (Maybe UTCTime)
- replicationTaskStats_tablesLoaded :: Lens' ReplicationTaskStats (Maybe Int)
- replicationTaskStats_tablesQueued :: Lens' ReplicationTaskStats (Maybe Int)
- replicationTaskStats_tablesLoading :: Lens' ReplicationTaskStats (Maybe Int)
- replicationTaskStats_freshStartDate :: Lens' ReplicationTaskStats (Maybe UTCTime)
- data ResourcePendingMaintenanceActions = ResourcePendingMaintenanceActions' {}
- newResourcePendingMaintenanceActions :: ResourcePendingMaintenanceActions
- resourcePendingMaintenanceActions_pendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions (Maybe [PendingMaintenanceAction])
- resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text)
- data S3Settings = S3Settings' {
- parquetVersion :: Maybe ParquetVersionValue
- preserveTransactions :: Maybe Bool
- maxFileSize :: Maybe Int
- csvNoSupValue :: Maybe Text
- rfc4180 :: Maybe Bool
- parquetTimestampInMillisecond :: Maybe Bool
- includeOpForFullLoad :: Maybe Bool
- cdcMinFileSize :: Maybe Int
- csvDelimiter :: Maybe Text
- serviceAccessRoleArn :: Maybe Text
- bucketFolder :: Maybe Text
- dataFormat :: Maybe DataFormatValue
- datePartitionEnabled :: Maybe Bool
- encodingType :: Maybe EncodingTypeValue
- cdcMaxBatchInterval :: Maybe Int
- ignoreHeaderRows :: Maybe Int
- externalTableDefinition :: Maybe Text
- dictPageSizeLimit :: Maybe Int
- bucketName :: Maybe Text
- encryptionMode :: Maybe EncryptionModeValue
- enableStatistics :: Maybe Bool
- cdcInsertsOnly :: Maybe Bool
- timestampColumnName :: Maybe Text
- csvRowDelimiter :: Maybe Text
- datePartitionDelimiter :: Maybe DatePartitionDelimiterValue
- addColumnName :: Maybe Bool
- cannedAclForObjects :: Maybe CannedAclForObjectsValue
- compressionType :: Maybe CompressionTypeValue
- csvNullValue :: Maybe Text
- serverSideEncryptionKmsKeyId :: Maybe Text
- dataPageSize :: Maybe Int
- useCsvNoSupValue :: Maybe Bool
- cdcInsertsAndUpdates :: Maybe Bool
- datePartitionSequence :: Maybe DatePartitionSequenceValue
- rowGroupLength :: Maybe Int
- cdcPath :: Maybe Text
- newS3Settings :: S3Settings
- s3Settings_parquetVersion :: Lens' S3Settings (Maybe ParquetVersionValue)
- s3Settings_preserveTransactions :: Lens' S3Settings (Maybe Bool)
- s3Settings_maxFileSize :: Lens' S3Settings (Maybe Int)
- s3Settings_csvNoSupValue :: Lens' S3Settings (Maybe Text)
- s3Settings_rfc4180 :: Lens' S3Settings (Maybe Bool)
- s3Settings_parquetTimestampInMillisecond :: Lens' S3Settings (Maybe Bool)
- s3Settings_includeOpForFullLoad :: Lens' S3Settings (Maybe Bool)
- s3Settings_cdcMinFileSize :: Lens' S3Settings (Maybe Int)
- s3Settings_csvDelimiter :: Lens' S3Settings (Maybe Text)
- s3Settings_serviceAccessRoleArn :: Lens' S3Settings (Maybe Text)
- s3Settings_bucketFolder :: Lens' S3Settings (Maybe Text)
- s3Settings_dataFormat :: Lens' S3Settings (Maybe DataFormatValue)
- s3Settings_datePartitionEnabled :: Lens' S3Settings (Maybe Bool)
- s3Settings_encodingType :: Lens' S3Settings (Maybe EncodingTypeValue)
- s3Settings_cdcMaxBatchInterval :: Lens' S3Settings (Maybe Int)
- s3Settings_ignoreHeaderRows :: Lens' S3Settings (Maybe Int)
- s3Settings_externalTableDefinition :: Lens' S3Settings (Maybe Text)
- s3Settings_dictPageSizeLimit :: Lens' S3Settings (Maybe Int)
- s3Settings_bucketName :: Lens' S3Settings (Maybe Text)
- s3Settings_encryptionMode :: Lens' S3Settings (Maybe EncryptionModeValue)
- s3Settings_enableStatistics :: Lens' S3Settings (Maybe Bool)
- s3Settings_cdcInsertsOnly :: Lens' S3Settings (Maybe Bool)
- s3Settings_timestampColumnName :: Lens' S3Settings (Maybe Text)
- s3Settings_csvRowDelimiter :: Lens' S3Settings (Maybe Text)
- s3Settings_datePartitionDelimiter :: Lens' S3Settings (Maybe DatePartitionDelimiterValue)
- s3Settings_addColumnName :: Lens' S3Settings (Maybe Bool)
- s3Settings_cannedAclForObjects :: Lens' S3Settings (Maybe CannedAclForObjectsValue)
- s3Settings_compressionType :: Lens' S3Settings (Maybe CompressionTypeValue)
- s3Settings_csvNullValue :: Lens' S3Settings (Maybe Text)
- s3Settings_serverSideEncryptionKmsKeyId :: Lens' S3Settings (Maybe Text)
- s3Settings_dataPageSize :: Lens' S3Settings (Maybe Int)
- s3Settings_useCsvNoSupValue :: Lens' S3Settings (Maybe Bool)
- s3Settings_cdcInsertsAndUpdates :: Lens' S3Settings (Maybe Bool)
- s3Settings_datePartitionSequence :: Lens' S3Settings (Maybe DatePartitionSequenceValue)
- s3Settings_rowGroupLength :: Lens' S3Settings (Maybe Int)
- s3Settings_cdcPath :: Lens' S3Settings (Maybe Text)
- data Subnet = Subnet' {}
- newSubnet :: Subnet
- subnet_subnetStatus :: Lens' Subnet (Maybe Text)
- subnet_subnetIdentifier :: Lens' Subnet (Maybe Text)
- subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)
- data SupportedEndpointType = SupportedEndpointType' {}
- newSupportedEndpointType :: SupportedEndpointType
- supportedEndpointType_engineDisplayName :: Lens' SupportedEndpointType (Maybe Text)
- supportedEndpointType_endpointType :: Lens' SupportedEndpointType (Maybe ReplicationEndpointTypeValue)
- supportedEndpointType_engineName :: Lens' SupportedEndpointType (Maybe Text)
- supportedEndpointType_replicationInstanceEngineMinimumVersion :: Lens' SupportedEndpointType (Maybe Text)
- supportedEndpointType_supportsCDC :: Lens' SupportedEndpointType (Maybe Bool)
- data SybaseSettings = SybaseSettings' {}
- newSybaseSettings :: SybaseSettings
- sybaseSettings_serverName :: Lens' SybaseSettings (Maybe Text)
- sybaseSettings_secretsManagerAccessRoleArn :: Lens' SybaseSettings (Maybe Text)
- sybaseSettings_username :: Lens' SybaseSettings (Maybe Text)
- sybaseSettings_password :: Lens' SybaseSettings (Maybe Text)
- sybaseSettings_databaseName :: Lens' SybaseSettings (Maybe Text)
- sybaseSettings_secretsManagerSecretId :: Lens' SybaseSettings (Maybe Text)
- sybaseSettings_port :: Lens' SybaseSettings (Maybe Int)
- data TableStatistics = TableStatistics' {
- validationState :: Maybe Text
- fullLoadRows :: Maybe Integer
- inserts :: Maybe Integer
- fullLoadEndTime :: Maybe POSIX
- fullLoadCondtnlChkFailedRows :: Maybe Integer
- fullLoadReloaded :: Maybe Bool
- validationFailedRecords :: Maybe Integer
- validationSuspendedRecords :: Maybe Integer
- schemaName :: Maybe Text
- validationStateDetails :: Maybe Text
- tableState :: Maybe Text
- fullLoadErrorRows :: Maybe Integer
- ddls :: Maybe Integer
- deletes :: Maybe Integer
- updates :: Maybe Integer
- validationPendingRecords :: Maybe Integer
- fullLoadStartTime :: Maybe POSIX
- lastUpdateTime :: Maybe POSIX
- tableName :: Maybe Text
- newTableStatistics :: TableStatistics
- tableStatistics_validationState :: Lens' TableStatistics (Maybe Text)
- tableStatistics_fullLoadRows :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_inserts :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_fullLoadEndTime :: Lens' TableStatistics (Maybe UTCTime)
- tableStatistics_fullLoadCondtnlChkFailedRows :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_fullLoadReloaded :: Lens' TableStatistics (Maybe Bool)
- tableStatistics_validationFailedRecords :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_validationSuspendedRecords :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_schemaName :: Lens' TableStatistics (Maybe Text)
- tableStatistics_validationStateDetails :: Lens' TableStatistics (Maybe Text)
- tableStatistics_tableState :: Lens' TableStatistics (Maybe Text)
- tableStatistics_fullLoadErrorRows :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_ddls :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_deletes :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_updates :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_validationPendingRecords :: Lens' TableStatistics (Maybe Integer)
- tableStatistics_fullLoadStartTime :: Lens' TableStatistics (Maybe UTCTime)
- tableStatistics_lastUpdateTime :: Lens' TableStatistics (Maybe UTCTime)
- tableStatistics_tableName :: Lens' TableStatistics (Maybe Text)
- data TableToReload = TableToReload' {
- schemaName :: Text
- tableName :: Text
- newTableToReload :: Text -> Text -> TableToReload
- tableToReload_schemaName :: Lens' TableToReload Text
- tableToReload_tableName :: Lens' TableToReload Text
- data Tag = Tag' {}
- newTag :: Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_resourceArn :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag (Maybe Text)
- data VpcSecurityGroupMembership = VpcSecurityGroupMembership' {}
- newVpcSecurityGroupMembership :: VpcSecurityGroupMembership
- vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text)
- vpcSecurityGroupMembership_vpcSecurityGroupId :: Lens' VpcSecurityGroupMembership (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2016-01-01 of the Amazon Database Migration Service SDK configuration.
Errors
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified master key (CMK) isn't enabled.
_KMSFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
An Key Management Service (KMS) error is preventing access to KMS.
_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #
The subnet provided is invalid.
_KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DMS cannot access the KMS key.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
A specified Amazon S3 bucket, bucket folder, or other object can't be found.
_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 :: AsError a => Getting (First ServiceError) a ServiceError Source #
The certificate was not valid.
_SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized for the SNS subscription.
_ResourceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you are attempting to create already exists.
_InsufficientResourceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are not enough resources allocated to the database migration.
_S3AccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
Insufficient privileges are preventing access to an Amazon S3 object.
_SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The SNS topic is invalid.
_KMSNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified KMS entity or resource can't be found.
_KMSThrottlingFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
This request triggered KMS request throttling.
_ResourceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota for this resource quota has been exceeded.
_UpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
An upgrade dependency is preventing the database migration.
_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource could not be found.
_StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The storage quota has been exceeded.
_AccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
DMS was denied access to the endpoint. Check that the role is correctly configured.
_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified subnet is already in use.
_KMSInvalidStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The state of the specified KMS resource isn't valid for this request.
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.
Constructors
| AccountQuota' | |
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.
accountQuota_max :: Lens' AccountQuota (Maybe Integer) Source #
The maximum allowed value for the quota.
accountQuota_used :: Lens' AccountQuota (Maybe Integer) Source #
The amount currently used toward the quota maximum.
accountQuota_accountQuotaName :: Lens' AccountQuota (Maybe Text) Source #
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' | |
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.
availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #
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' | |
Fields
| |
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.
certificate_certificateOwner :: Lens' Certificate (Maybe Text) Source #
The owner of the certificate.
certificate_signingAlgorithm :: Lens' Certificate (Maybe Text) Source #
The signing algorithm for the certificate.
certificate_validFromDate :: Lens' Certificate (Maybe UTCTime) Source #
The beginning date that the certificate is valid.
certificate_certificatePem :: Lens' Certificate (Maybe Text) Source #
The contents of a .pem file, which contains an X.509 certificate.
certificate_certificateArn :: Lens' Certificate (Maybe Text) Source #
The Amazon Resource Name (ARN) for the certificate.
certificate_certificateCreationDate :: Lens' Certificate (Maybe UTCTime) Source #
The date that the certificate was created.
certificate_certificateIdentifier :: Lens' Certificate (Maybe Text) Source #
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.
certificate_certificateWallet :: Lens' Certificate (Maybe ByteString) Source #
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.
certificate_keyLength :: Lens' Certificate (Maybe Int) Source #
The key length of the cryptographic algorithm being used.
certificate_validToDate :: Lens' Certificate (Maybe UTCTime) Source #
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' | |
Fields
| |
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.
connection_status :: Lens' Connection (Maybe Text) Source #
The connection status. This parameter can return one of the following values:
"successful"
"testing"
"failed"
"deleting"
connection_replicationInstanceArn :: Lens' Connection (Maybe Text) Source #
The ARN of the replication instance.
connection_endpointIdentifier :: Lens' Connection (Maybe Text) Source #
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.
connection_replicationInstanceIdentifier :: Lens' Connection (Maybe Text) Source #
The replication instance identifier. This parameter is stored as a lowercase string.
connection_endpointArn :: Lens' Connection (Maybe Text) Source #
The ARN string that uniquely identifies the endpoint.
connection_lastFailureMessage :: Lens' Connection (Maybe Text) Source #
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' | |
Fields
| |
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.
dmsTransferSettings_serviceAccessRoleArn :: Lens' DmsTransferSettings (Maybe Text) Source #
The Amazon Resource Name (ARN) used by the service access IAM role. The
role must allow the iam:PassRole action.
dmsTransferSettings_bucketName :: Lens' DmsTransferSettings (Maybe Text) Source #
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' | |
Fields
| |
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.
docDbSettings_serverName :: Lens' DocDbSettings (Maybe Text) Source #
The name of the server on the DocumentDB source endpoint.
docDbSettings_secretsManagerAccessRoleArn :: Lens' DocDbSettings (Maybe Text) Source #
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.
docDbSettings_username :: Lens' DocDbSettings (Maybe Text) Source #
The user name you use to access the DocumentDB source endpoint.
docDbSettings_kmsKeyId :: Lens' DocDbSettings (Maybe Text) Source #
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.
docDbSettings_password :: Lens' DocDbSettings (Maybe Text) Source #
The password for the user account you use to access the DocumentDB source endpoint.
docDbSettings_nestingLevel :: Lens' DocDbSettings (Maybe NestingLevelValue) Source #
Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode.
Specify "one" to use table mode.
docDbSettings_databaseName :: Lens' DocDbSettings (Maybe Text) Source #
The database name on the DocumentDB source endpoint.
docDbSettings_docsToInvestigate :: Lens' DocDbSettings (Maybe Int) Source #
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.
docDbSettings_secretsManagerSecretId :: Lens' DocDbSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the DocumentDB endpoint connection
details.
docDbSettings_extractDocId :: Lens' DocDbSettings (Maybe Bool) Source #
Specifies the document ID. Use this setting when NestingLevel is set
to "none".
Default value is "false".
docDbSettings_port :: Lens' DocDbSettings (Maybe Int) Source #
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' | |
Fields
| |
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.
dynamoDbSettings_serviceAccessRoleArn :: Lens' DynamoDbSettings Text Source #
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.
Constructors
| ElasticsearchSettings' | |
Fields
| |
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.
elasticsearchSettings_fullLoadErrorPercentage :: Lens' ElasticsearchSettings (Maybe Int) Source #
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.
elasticsearchSettings_errorRetryDuration :: Lens' ElasticsearchSettings (Maybe Int) Source #
The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
elasticsearchSettings_serviceAccessRoleArn :: Lens' ElasticsearchSettings Text Source #
The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole action.
elasticsearchSettings_endpointUri :: Lens' ElasticsearchSettings Text Source #
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
| Endpoint' | |
Fields
| |
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:PassRoleaction.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.
endpoint_dmsTransferSettings :: Lens' Endpoint (Maybe DmsTransferSettings) Source #
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:PassRoleaction.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"}
endpoint_mySQLSettings :: Lens' Endpoint (Maybe MySQLSettings) Source #
The settings for the MySQL source and target endpoint. For more
information, see the MySQLSettings structure.
endpoint_microsoftSQLServerSettings :: Lens' Endpoint (Maybe MicrosoftSQLServerSettings) Source #
The settings for the Microsoft SQL Server source and target endpoint.
For more information, see the MicrosoftSQLServerSettings structure.
endpoint_certificateArn :: Lens' Endpoint (Maybe Text) Source #
The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
endpoint_serviceAccessRoleArn :: Lens' Endpoint (Maybe Text) Source #
The Amazon Resource Name (ARN) used by the service to access the IAM
role. The role must allow the iam:PassRole action.
endpoint_docDbSettings :: Lens' Endpoint (Maybe DocDbSettings) Source #
Undocumented member.
endpoint_engineDisplayName :: Lens' Endpoint (Maybe Text) Source #
The expanded name for the engine name. For example, if the EngineName
parameter is "aurora," this value would be "Amazon Aurora MySQL."
endpoint_postgreSQLSettings :: Lens' Endpoint (Maybe PostgreSQLSettings) Source #
The settings for the PostgreSQL source and target endpoint. For more
information, see the PostgreSQLSettings structure.
endpoint_extraConnectionAttributes :: Lens' Endpoint (Maybe Text) Source #
Additional connection attributes used to connect to the endpoint.
endpoint_kafkaSettings :: Lens' Endpoint (Maybe KafkaSettings) Source #
The settings for the Apache Kafka target endpoint. For more information,
see the KafkaSettings structure.
endpoint_oracleSettings :: Lens' Endpoint (Maybe OracleSettings) Source #
The settings for the Oracle source and target endpoint. For more
information, see the OracleSettings structure.
endpoint_endpointType :: Lens' Endpoint (Maybe ReplicationEndpointTypeValue) Source #
The type of endpoint. Valid values are source and target.
endpoint_redshiftSettings :: Lens' Endpoint (Maybe RedshiftSettings) Source #
Settings for the Amazon Redshift endpoint.
endpoint_elasticsearchSettings :: Lens' Endpoint (Maybe ElasticsearchSettings) Source #
The settings for the Elasticsearch source endpoint. For more
information, see the ElasticsearchSettings structure.
endpoint_username :: Lens' Endpoint (Maybe Text) Source #
The user name used to connect to the endpoint.
endpoint_externalTableDefinition :: Lens' Endpoint (Maybe Text) Source #
The external table definition.
endpoint_engineName :: Lens' Endpoint (Maybe Text) Source #
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".
endpoint_redisSettings :: Lens' Endpoint (Maybe RedisSettings) Source #
The settings for the Redis target endpoint. For more information, see
the RedisSettings structure.
endpoint_neptuneSettings :: Lens' Endpoint (Maybe NeptuneSettings) Source #
The settings for the Amazon Neptune target endpoint. For more
information, see the NeptuneSettings structure.
endpoint_iBMDb2Settings :: Lens' Endpoint (Maybe IBMDb2Settings) Source #
The settings for the IBM Db2 LUW source endpoint. For more information,
see the IBMDb2Settings structure.
endpoint_kmsKeyId :: Lens' Endpoint (Maybe Text) Source #
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.
endpoint_mongoDbSettings :: Lens' Endpoint (Maybe MongoDbSettings) Source #
The settings for the MongoDB source endpoint. For more information, see
the MongoDbSettings structure.
endpoint_sslMode :: Lens' Endpoint (Maybe DmsSslModeValue) Source #
The SSL mode used to connect to the endpoint. The default value is
none.
endpoint_sybaseSettings :: Lens' Endpoint (Maybe SybaseSettings) Source #
The settings for the SAP ASE source and target endpoint. For more
information, see the SybaseSettings structure.
endpoint_databaseName :: Lens' Endpoint (Maybe Text) Source #
The name of the database at the endpoint.
endpoint_s3Settings :: Lens' Endpoint (Maybe S3Settings) Source #
The settings for the S3 target endpoint. For more information, see the
S3Settings structure.
endpoint_kinesisSettings :: Lens' Endpoint (Maybe KinesisSettings) Source #
The settings for the Amazon Kinesis target endpoint. For more
information, see the KinesisSettings structure.
endpoint_endpointIdentifier :: Lens' Endpoint (Maybe Text) Source #
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.
endpoint_externalId :: Lens' Endpoint (Maybe Text) Source #
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.
endpoint_dynamoDbSettings :: Lens' Endpoint (Maybe DynamoDbSettings) Source #
The settings for the DynamoDB target endpoint. For more information, see
the DynamoDBSettings structure.
endpoint_endpointArn :: Lens' Endpoint (Maybe Text) Source #
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
EndpointSetting
data EndpointSetting Source #
Endpoint settings.
See: newEndpointSetting smart constructor.
Constructors
| EndpointSetting' | |
Fields
| |
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.
endpointSetting_sensitive :: Lens' EndpointSetting (Maybe Bool) Source #
A value that marks this endpoint setting as sensitive.
endpointSetting_intValueMax :: Lens' EndpointSetting (Maybe Int) Source #
The maximum value of an endpoint setting that is of type int.
endpointSetting_applicability :: Lens' EndpointSetting (Maybe Text) Source #
The relevance or validity of an endpoint setting for an engine name and its endpoint type.
endpointSetting_name :: Lens' EndpointSetting (Maybe Text) Source #
The name that you want to give the endpoint settings.
endpointSetting_intValueMin :: Lens' EndpointSetting (Maybe Int) Source #
The minimum value of an endpoint setting that is of type int.
endpointSetting_units :: Lens' EndpointSetting (Maybe Text) Source #
The unit of measure for this endpoint setting.
endpointSetting_defaultValue :: Lens' EndpointSetting (Maybe Text) Source #
The default value of the endpoint setting if no value is specified using
CreateEndpoint or ModifyEndpoint.
endpointSetting_type :: Lens' EndpointSetting (Maybe EndpointSettingTypeValue) Source #
The type of endpoint. Valid values are source and target.
endpointSetting_enumValues :: Lens' EndpointSetting (Maybe [Text]) Source #
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.
Constructors
| Event' | |
Fields
| |
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.
event_sourceType :: Lens' Event (Maybe SourceType) Source #
The type of DMS resource that generates events.
Valid values: replication-instance | endpoint | replication-task
event_eventCategories :: Lens' Event (Maybe [Text]) Source #
The event categories available for the specified source type.
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' | |
Fields
| |
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.
eventCategoryGroup_sourceType :: Lens' EventCategoryGroup (Maybe Text) Source #
The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
eventCategoryGroup_eventCategories :: Lens' EventCategoryGroup (Maybe [Text]) Source #
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' | |
Fields
| |
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.
eventSubscription_status :: Lens' EventSubscription (Maybe Text) Source #
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.
eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text) Source #
The Amazon Web Services customer account associated with the DMS event notification subscription.
eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text) Source #
The DMS event notification subscription Id.
eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text) Source #
The topic ARN of the DMS event notification subscription.
eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool) Source #
Boolean value that indicates if the event subscription is enabled.
eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text) Source #
The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text) Source #
The time the DMS event notification subscription was created.
eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text]) Source #
A lists of event categories.
eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text]) Source #
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.
Constructors
| Filter' | |
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.
filter_name :: Lens' Filter Text Source #
The name of the filter as specified for a Describe* or similar
operation.
filter_values :: Lens' Filter [Text] Source #
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' | |
Fields
| |
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.
iBMDb2Settings_serverName :: Lens' IBMDb2Settings (Maybe Text) Source #
Fully qualified domain name of the endpoint.
iBMDb2Settings_currentLsn :: Lens' IBMDb2Settings (Maybe Text) Source #
For ongoing replication (CDC), use CurrentLSN to specify a log sequence number (LSN) where you want the replication to start.
iBMDb2Settings_setDataCaptureChanges :: Lens' IBMDb2Settings (Maybe Bool) Source #
Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
iBMDb2Settings_secretsManagerAccessRoleArn :: Lens' IBMDb2Settings (Maybe Text) Source #
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.
iBMDb2Settings_username :: Lens' IBMDb2Settings (Maybe Text) Source #
Endpoint connection user name.
iBMDb2Settings_password :: Lens' IBMDb2Settings (Maybe Text) Source #
Endpoint connection password.
iBMDb2Settings_databaseName :: Lens' IBMDb2Settings (Maybe Text) Source #
Database name for the endpoint.
iBMDb2Settings_secretsManagerSecretId :: Lens' IBMDb2Settings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Db2 LUW endpoint connection
details.
iBMDb2Settings_maxKBytesPerRead :: Lens' IBMDb2Settings (Maybe Int) Source #
Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
iBMDb2Settings_port :: Lens' IBMDb2Settings (Maybe Int) Source #
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' | |
Fields
| |
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.
kafkaSettings_sslClientKeyArn :: Lens' KafkaSettings (Maybe Text) Source #
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
kafkaSettings_includeTransactionDetails :: Lens' KafkaSettings (Maybe Bool) Source #
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.
kafkaSettings_includeTableAlterOperations :: Lens' KafkaSettings (Maybe Bool) Source #
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.
kafkaSettings_sslClientCertificateArn :: Lens' KafkaSettings (Maybe Text) Source #
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
kafkaSettings_sslCaCertificateArn :: Lens' KafkaSettings (Maybe Text) Source #
The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
kafkaSettings_partitionIncludeSchemaTable :: Lens' KafkaSettings (Maybe Bool) Source #
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.
kafkaSettings_topic :: Lens' KafkaSettings (Maybe Text) Source #
The topic to which you migrate the data. If you don't specify a topic,
DMS specifies "kafka-default-topic" as the migration topic.
kafkaSettings_includeControlDetails :: Lens' KafkaSettings (Maybe Bool) Source #
Shows detailed control information for table definition, column
definition, and table and column changes in the Kafka message output.
The default is false.
kafkaSettings_noHexPrefix :: Lens' KafkaSettings (Maybe Bool) Source #
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.
kafkaSettings_saslPassword :: Lens' KafkaSettings (Maybe Text) Source #
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.
kafkaSettings_sslClientKeyPassword :: Lens' KafkaSettings (Maybe Text) Source #
The password for the client private key used to securely connect to a Kafka target endpoint.
kafkaSettings_includePartitionValue :: Lens' KafkaSettings (Maybe Bool) Source #
Shows the partition value within the Kafka message output unless the
partition type is schema-table-type. The default is false.
kafkaSettings_messageFormat :: Lens' KafkaSettings (Maybe MessageFormatValue) Source #
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).
kafkaSettings_securityProtocol :: Lens' KafkaSettings (Maybe KafkaSecurityProtocol) Source #
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.
kafkaSettings_saslUsername :: Lens' KafkaSettings (Maybe Text) Source #
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.
kafkaSettings_broker :: Lens' KafkaSettings (Maybe Text) Source #
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.
kafkaSettings_messageMaxBytes :: Lens' KafkaSettings (Maybe Int) Source #
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
kafkaSettings_includeNullAndEmpty :: Lens' KafkaSettings (Maybe Bool) Source #
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' | |
Fields
| |
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.
kinesisSettings_includeTransactionDetails :: Lens' KinesisSettings (Maybe Bool) Source #
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.
kinesisSettings_includeTableAlterOperations :: Lens' KinesisSettings (Maybe Bool) Source #
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.
kinesisSettings_serviceAccessRoleArn :: Lens' KinesisSettings (Maybe Text) Source #
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.
kinesisSettings_partitionIncludeSchemaTable :: Lens' KinesisSettings (Maybe Bool) Source #
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.
kinesisSettings_streamArn :: Lens' KinesisSettings (Maybe Text) Source #
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
kinesisSettings_includeControlDetails :: Lens' KinesisSettings (Maybe Bool) Source #
Shows detailed control information for table definition, column
definition, and table and column changes in the Kinesis message output.
The default is false.
kinesisSettings_noHexPrefix :: Lens' KinesisSettings (Maybe Bool) Source #
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.
kinesisSettings_includePartitionValue :: Lens' KinesisSettings (Maybe Bool) Source #
Shows the partition value within the Kinesis message output, unless the
partition type is schema-table-type. The default is false.
kinesisSettings_messageFormat :: Lens' KinesisSettings (Maybe MessageFormatValue) Source #
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).
kinesisSettings_includeNullAndEmpty :: Lens' KinesisSettings (Maybe Bool) Source #
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' | |
Fields
| |
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.
microsoftSQLServerSettings_bcpPacketSize :: Lens' MicrosoftSQLServerSettings (Maybe Int) Source #
The maximum size of the packets (in bytes) used to transfer data using BCP.
microsoftSQLServerSettings_useBcpFullLoad :: Lens' MicrosoftSQLServerSettings (Maybe Bool) Source #
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.
microsoftSQLServerSettings_serverName :: Lens' MicrosoftSQLServerSettings (Maybe Text) Source #
Fully qualified domain name of the endpoint.
microsoftSQLServerSettings_querySingleAlwaysOnNode :: Lens' MicrosoftSQLServerSettings (Maybe Bool) Source #
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.
microsoftSQLServerSettings_secretsManagerAccessRoleArn :: Lens' MicrosoftSQLServerSettings (Maybe Text) Source #
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.
microsoftSQLServerSettings_username :: Lens' MicrosoftSQLServerSettings (Maybe Text) Source #
Endpoint connection user name.
microsoftSQLServerSettings_safeguardPolicy :: Lens' MicrosoftSQLServerSettings (Maybe SafeguardPolicy) Source #
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.
microsoftSQLServerSettings_password :: Lens' MicrosoftSQLServerSettings (Maybe Text) Source #
Endpoint connection password.
microsoftSQLServerSettings_databaseName :: Lens' MicrosoftSQLServerSettings (Maybe Text) Source #
Database name for the endpoint.
microsoftSQLServerSettings_secretsManagerSecretId :: Lens' MicrosoftSQLServerSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the SQL Server endpoint connection
details.
microsoftSQLServerSettings_readBackupOnly :: Lens' MicrosoftSQLServerSettings (Maybe Bool) Source #
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.
microsoftSQLServerSettings_useThirdPartyBackupDevice :: Lens' MicrosoftSQLServerSettings (Maybe Bool) Source #
When this attribute is set to Y, DMS processes third-party transaction
log backups if they are created in native format.
microsoftSQLServerSettings_controlTablesFileGroup :: Lens' MicrosoftSQLServerSettings (Maybe Text) Source #
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.
microsoftSQLServerSettings_port :: Lens' MicrosoftSQLServerSettings (Maybe Int) Source #
Endpoint TCP port.
MongoDbSettings
data MongoDbSettings Source #
Provides information that defines a MongoDB endpoint.
See: newMongoDbSettings smart constructor.
Constructors
| MongoDbSettings' | |
Fields
| |
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.
mongoDbSettings_serverName :: Lens' MongoDbSettings (Maybe Text) Source #
The name of the server on the MongoDB source endpoint.
mongoDbSettings_secretsManagerAccessRoleArn :: Lens' MongoDbSettings (Maybe Text) Source #
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.
mongoDbSettings_authMechanism :: Lens' MongoDbSettings (Maybe AuthMechanismValue) Source #
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".
mongoDbSettings_username :: Lens' MongoDbSettings (Maybe Text) Source #
The user name you use to access the MongoDB source endpoint.
mongoDbSettings_kmsKeyId :: Lens' MongoDbSettings (Maybe Text) Source #
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.
mongoDbSettings_password :: Lens' MongoDbSettings (Maybe Text) Source #
The password for the user account you use to access the MongoDB source endpoint.
mongoDbSettings_nestingLevel :: Lens' MongoDbSettings (Maybe NestingLevelValue) Source #
Specifies either document or table mode.
Default value is "none". Specify "none" to use document mode.
Specify "one" to use table mode.
mongoDbSettings_databaseName :: Lens' MongoDbSettings (Maybe Text) Source #
The database name on the MongoDB source endpoint.
mongoDbSettings_docsToInvestigate :: Lens' MongoDbSettings (Maybe Text) Source #
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.
mongoDbSettings_authSource :: Lens' MongoDbSettings (Maybe Text) Source #
The MongoDB database name. This setting isn't used when AuthType is
set to "no".
The default is "admin".
mongoDbSettings_secretsManagerSecretId :: Lens' MongoDbSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the MongoDB endpoint connection
details.
mongoDbSettings_extractDocId :: Lens' MongoDbSettings (Maybe Text) Source #
Specifies the document ID. Use this setting when NestingLevel is set
to "none".
Default value is "false".
mongoDbSettings_authType :: Lens' MongoDbSettings (Maybe AuthTypeValue) Source #
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.
mongoDbSettings_port :: Lens' MongoDbSettings (Maybe Int) Source #
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' | |
Fields
| |
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.
mySQLSettings_maxFileSize :: Lens' MySQLSettings (Maybe Int) Source #
Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.
Example: maxFileSize=512
mySQLSettings_targetDbType :: Lens' MySQLSettings (Maybe TargetDbType) Source #
Specifies where to migrate source tables on the target, either to a single database or multiple databases.
Example: targetDbType=MULTIPLE_DATABASES
mySQLSettings_serverName :: Lens' MySQLSettings (Maybe Text) Source #
Fully qualified domain name of the endpoint.
mySQLSettings_cleanSourceMetadataOnMismatch :: Lens' MySQLSettings (Maybe Bool) Source #
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.
mySQLSettings_parallelLoadThreads :: Lens' MySQLSettings (Maybe Int) Source #
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
mySQLSettings_secretsManagerAccessRoleArn :: Lens' MySQLSettings (Maybe Text) Source #
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.
mySQLSettings_username :: Lens' MySQLSettings (Maybe Text) Source #
Endpoint connection user name.
mySQLSettings_password :: Lens' MySQLSettings (Maybe Text) Source #
Endpoint connection password.
mySQLSettings_eventsPollInterval :: Lens' MySQLSettings (Maybe Int) Source #
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.
mySQLSettings_databaseName :: Lens' MySQLSettings (Maybe Text) Source #
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.
mySQLSettings_afterConnectScript :: Lens' MySQLSettings (Maybe Text) Source #
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.
mySQLSettings_secretsManagerSecretId :: Lens' MySQLSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the MySQL endpoint connection
details.
mySQLSettings_serverTimezone :: Lens' MySQLSettings (Maybe Text) Source #
Specifies the time zone for the source MySQL database.
Example: serverTimezone=US/Pacific;
Note: Do not enclose time zones in single quotes.
mySQLSettings_port :: Lens' MySQLSettings (Maybe Int) Source #
Endpoint TCP port.
NeptuneSettings
data NeptuneSettings Source #
Provides information that defines an Amazon Neptune endpoint.
See: newNeptuneSettings smart constructor.
Constructors
| NeptuneSettings' | |
Fields
| |
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
neptuneSettings_maxFileSize :: Lens' NeptuneSettings (Maybe Int) Source #
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.
neptuneSettings_maxRetryCount :: Lens' NeptuneSettings (Maybe Int) Source #
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.
neptuneSettings_serviceAccessRoleArn :: Lens' NeptuneSettings (Maybe Text) Source #
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.
neptuneSettings_iamAuthEnabled :: Lens' NeptuneSettings (Maybe Bool) Source #
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.
neptuneSettings_errorRetryDuration :: Lens' NeptuneSettings (Maybe Int) Source #
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.
neptuneSettings_s3BucketName :: Lens' NeptuneSettings Text Source #
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.
neptuneSettings_s3BucketFolder :: Lens' NeptuneSettings Text Source #
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' | |
Fields
| |
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.
oracleSettings_useBFile :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_standbyDelayTime :: Lens' OracleSettings (Maybe Int) Source #
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.
oracleSettings_failTasksOnLobTruncation :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_serverName :: Lens' OracleSettings (Maybe Text) Source #
Fully qualified domain name of the endpoint.
oracleSettings_directPathNoLog :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_extraArchivedLogDestIds :: Lens' OracleSettings (Maybe [Int]) Source #
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.
oracleSettings_securityDbEncryptionName :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_oraclePathPrefix :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_secretsManagerAccessRoleArn :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_useDirectPathFullLoad :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_username :: Lens' OracleSettings (Maybe Text) Source #
Endpoint connection user name.
oracleSettings_allowSelectNestedTables :: Lens' OracleSettings (Maybe Bool) Source #
Set this attribute to true to enable replication of Oracle tables
containing columns that are nested tables or defined types.
oracleSettings_readAheadBlocks :: Lens' OracleSettings (Maybe Int) Source #
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).
oracleSettings_archivedLogDestId :: Lens' OracleSettings (Maybe Int) Source #
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.
oracleSettings_replacePathPrefix :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_accessAlternateDirectly :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_secretsManagerOracleAsmSecretId :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_securityDbEncryption :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_useLogminerReader :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_readTableSpaceName :: Lens' OracleSettings (Maybe Bool) Source #
When set to true, this attribute supports tablespace replication.
oracleSettings_retryInterval :: Lens' OracleSettings (Maybe Int) Source #
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
oracleSettings_password :: Lens' OracleSettings (Maybe Text) Source #
Endpoint connection password.
oracleSettings_spatialDataOptionToGeoJsonFunctionName :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_databaseName :: Lens' OracleSettings (Maybe Text) Source #
Database name for the endpoint.
oracleSettings_addSupplementalLogging :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_secretsManagerOracleAsmAccessRoleArn :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_asmServer :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_charLengthSemantics :: Lens' OracleSettings (Maybe CharLengthSemantics) Source #
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;
oracleSettings_archivedLogsOnly :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_directPathParallelLoad :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_secretsManagerSecretId :: Lens' OracleSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Oracle endpoint connection
details.
oracleSettings_additionalArchivedLogDestId :: Lens' OracleSettings (Maybe Int) Source #
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.
oracleSettings_asmPassword :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_enableHomogenousTablespace :: Lens' OracleSettings (Maybe Bool) Source #
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
oracleSettings_parallelAsmReadThreads :: Lens' OracleSettings (Maybe Int) Source #
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.
oracleSettings_numberDatatypeScale :: Lens' OracleSettings (Maybe Int) Source #
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
oracleSettings_usePathPrefix :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_asmUser :: Lens' OracleSettings (Maybe Text) Source #
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.
oracleSettings_useAlternateFolderForOnline :: Lens' OracleSettings (Maybe Bool) Source #
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.
oracleSettings_port :: Lens' OracleSettings (Maybe Int) Source #
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' | |
Fields
| |
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.
orderableReplicationInstance_engineVersion :: Lens' OrderableReplicationInstance (Maybe Text) Source #
The version of the replication engine.
orderableReplicationInstance_minAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source #
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
orderableReplicationInstance_releaseStatus :: Lens' OrderableReplicationInstance (Maybe ReleaseStatusValues) Source #
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.
orderableReplicationInstance_includedAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source #
The amount of storage (in gigabytes) that is allocated for the replication instance.
orderableReplicationInstance_availabilityZones :: Lens' OrderableReplicationInstance (Maybe [Text]) Source #
List of Availability Zones for this replication instance.
orderableReplicationInstance_maxAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source #
The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
orderableReplicationInstance_replicationInstanceClass :: Lens' OrderableReplicationInstance (Maybe Text) Source #
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.
orderableReplicationInstance_defaultAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source #
The default amount of storage (in gigabytes) that is allocated for the replication instance.
orderableReplicationInstance_storageType :: Lens' OrderableReplicationInstance (Maybe Text) Source #
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' | |
Fields
| |
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.
pendingMaintenanceAction_autoAppliedAfterDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #
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.
pendingMaintenanceAction_action :: Lens' PendingMaintenanceAction (Maybe Text) Source #
The type of pending maintenance action that is available for the resource.
pendingMaintenanceAction_optInStatus :: Lens' PendingMaintenanceAction (Maybe Text) Source #
The type of opt-in request that has been received for the resource.
pendingMaintenanceAction_description :: Lens' PendingMaintenanceAction (Maybe Text) Source #
A description providing more detail about the maintenance action.
pendingMaintenanceAction_forcedApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #
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.
pendingMaintenanceAction_currentApplyDate :: Lens' PendingMaintenanceAction (Maybe UTCTime) Source #
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' | |
Fields
| |
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.
postgreSQLSettings_executeTimeout :: Lens' PostgreSQLSettings (Maybe Int) Source #
Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
postgreSQLSettings_maxFileSize :: Lens' PostgreSQLSettings (Maybe Int) Source #
Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
postgreSQLSettings_failTasksOnLobTruncation :: Lens' PostgreSQLSettings (Maybe Bool) Source #
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.
postgreSQLSettings_serverName :: Lens' PostgreSQLSettings (Maybe Text) Source #
Fully qualified domain name of the endpoint.
postgreSQLSettings_ddlArtifactsSchema :: Lens' PostgreSQLSettings (Maybe Text) Source #
The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
postgreSQLSettings_slotName :: Lens' PostgreSQLSettings (Maybe Text) Source #
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.
postgreSQLSettings_secretsManagerAccessRoleArn :: Lens' PostgreSQLSettings (Maybe Text) Source #
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.
postgreSQLSettings_username :: Lens' PostgreSQLSettings (Maybe Text) Source #
Endpoint connection user name.
postgreSQLSettings_heartbeatFrequency :: Lens' PostgreSQLSettings (Maybe Int) Source #
Sets the WAL heartbeat frequency (in minutes).
postgreSQLSettings_password :: Lens' PostgreSQLSettings (Maybe Text) Source #
Endpoint connection password.
postgreSQLSettings_databaseName :: Lens' PostgreSQLSettings (Maybe Text) Source #
Database name for the endpoint.
postgreSQLSettings_afterConnectScript :: Lens' PostgreSQLSettings (Maybe Text) Source #
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'
postgreSQLSettings_secretsManagerSecretId :: Lens' PostgreSQLSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the PostgreSQL endpoint connection
details.
postgreSQLSettings_captureDdls :: Lens' PostgreSQLSettings (Maybe Bool) Source #
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.
postgreSQLSettings_pluginName :: Lens' PostgreSQLSettings (Maybe PluginNameValue) Source #
Specifies the plugin to use to create a replication slot.
postgreSQLSettings_port :: Lens' PostgreSQLSettings (Maybe Int) Source #
Endpoint TCP port.
postgreSQLSettings_heartbeatSchema :: Lens' PostgreSQLSettings (Maybe Text) Source #
Sets the schema in which the heartbeat artifacts are created.
postgreSQLSettings_heartbeatEnable :: Lens' PostgreSQLSettings (Maybe Bool) Source #
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' | |
Fields
| |
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.
redisSettings_sslSecurityProtocol :: Lens' RedisSettings (Maybe SslSecurityProtocolValue) Source #
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.
redisSettings_authUserName :: Lens' RedisSettings (Maybe Text) Source #
The user name provided with the auth-role option of the AuthType
setting for a Redis target endpoint.
redisSettings_sslCaCertificateArn :: Lens' RedisSettings (Maybe Text) Source #
The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.
redisSettings_authPassword :: Lens' RedisSettings (Maybe Text) Source #
The password provided with the auth-role and auth-token options of
the AuthType setting for a Redis target endpoint.
redisSettings_authType :: Lens' RedisSettings (Maybe RedisAuthTypeValue) Source #
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.
redisSettings_serverName :: Lens' RedisSettings Text Source #
Fully qualified domain name of the endpoint.
redisSettings_port :: Lens' RedisSettings Int Source #
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' | |
Fields
| |
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.
redshiftSettings_emptyAsNull :: Lens' RedshiftSettings (Maybe Bool) Source #
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.
redshiftSettings_caseSensitiveNames :: Lens' RedshiftSettings (Maybe Bool) Source #
If Amazon Redshift is configured to support case sensitive schema names,
set CaseSensitiveNames to true. The default is false.
redshiftSettings_maxFileSize :: Lens' RedshiftSettings (Maybe Int) Source #
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).
redshiftSettings_replaceChars :: Lens' RedshiftSettings (Maybe Text) Source #
A value that specifies to replaces the invalid characters specified in
ReplaceInvalidChars, substituting the specified characters instead.
The default is "?".
redshiftSettings_serverName :: Lens' RedshiftSettings (Maybe Text) Source #
The name of the Amazon Redshift cluster you are using.
redshiftSettings_connectionTimeout :: Lens' RedshiftSettings (Maybe Int) Source #
A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.
redshiftSettings_loadTimeout :: Lens' RedshiftSettings (Maybe Int) Source #
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.
redshiftSettings_serviceAccessRoleArn :: Lens' RedshiftSettings (Maybe Text) Source #
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.
redshiftSettings_explicitIds :: Lens' RedshiftSettings (Maybe Bool) Source #
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.
redshiftSettings_bucketFolder :: Lens' RedshiftSettings (Maybe Text) Source #
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.
redshiftSettings_truncateColumns :: Lens' RedshiftSettings (Maybe Bool) Source #
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.
redshiftSettings_secretsManagerAccessRoleArn :: Lens' RedshiftSettings (Maybe Text) Source #
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.
redshiftSettings_replaceInvalidChars :: Lens' RedshiftSettings (Maybe Text) Source #
A list of characters that you want to replace. Use with ReplaceChars.
redshiftSettings_username :: Lens' RedshiftSettings (Maybe Text) Source #
An Amazon Redshift user name for a registered user.
redshiftSettings_bucketName :: Lens' RedshiftSettings (Maybe Text) Source #
The name of the intermediate S3 bucket used to store .csv files before uploading data to Redshift.
redshiftSettings_encryptionMode :: Lens' RedshiftSettings (Maybe EncryptionModeValue) Source #
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"
redshiftSettings_dateFormat :: Lens' RedshiftSettings (Maybe Text) Source #
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.
redshiftSettings_removeQuotes :: Lens' RedshiftSettings (Maybe Bool) Source #
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.
redshiftSettings_password :: Lens' RedshiftSettings (Maybe Text) Source #
The password for the user named in the username property.
redshiftSettings_databaseName :: Lens' RedshiftSettings (Maybe Text) Source #
The name of the Amazon Redshift data warehouse (service) that you are working with.
redshiftSettings_acceptAnyDate :: Lens' RedshiftSettings (Maybe Bool) Source #
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.
redshiftSettings_afterConnectScript :: Lens' RedshiftSettings (Maybe Text) Source #
Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.
redshiftSettings_secretsManagerSecretId :: Lens' RedshiftSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Amazon Redshift endpoint
connection details.
redshiftSettings_writeBufferSize :: Lens' RedshiftSettings (Maybe Int) Source #
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).
redshiftSettings_compUpdate :: Lens' RedshiftSettings (Maybe Bool) Source #
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.
redshiftSettings_trimBlanks :: Lens' RedshiftSettings (Maybe Bool) Source #
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.
redshiftSettings_timeFormat :: Lens' RedshiftSettings (Maybe Text) Source #
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.
redshiftSettings_serverSideEncryptionKmsKeyId :: Lens' RedshiftSettings (Maybe Text) Source #
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.
redshiftSettings_port :: Lens' RedshiftSettings (Maybe Int) Source #
The port number for Amazon Redshift. The default value is 5439.
redshiftSettings_fileTransferUploadStreams :: Lens' RedshiftSettings (Maybe Int) Source #
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' | |
Fields
| |
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.
refreshSchemasStatus_status :: Lens' RefreshSchemasStatus (Maybe RefreshSchemasStatusTypeValue) Source #
The status of the schema.
refreshSchemasStatus_lastRefreshDate :: Lens' RefreshSchemasStatus (Maybe UTCTime) Source #
The date the schema was last refreshed.
refreshSchemasStatus_replicationInstanceArn :: Lens' RefreshSchemasStatus (Maybe Text) Source #
The Amazon Resource Name (ARN) of the replication instance.
refreshSchemasStatus_endpointArn :: Lens' RefreshSchemasStatus (Maybe Text) Source #
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
refreshSchemasStatus_lastFailureMessage :: Lens' RefreshSchemasStatus (Maybe Text) Source #
The last failure message for the schema.
ReplicationInstance
data ReplicationInstance Source #
Provides information that defines a replication instance.
See: newReplicationInstance smart constructor.
Constructors
| ReplicationInstance' | |
Fields
| |
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.
replicationInstance_engineVersion :: Lens' ReplicationInstance (Maybe Text) Source #
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.
replicationInstance_publiclyAccessible :: Lens' ReplicationInstance (Maybe Bool) Source #
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.
replicationInstance_autoMinorVersionUpgrade :: Lens' ReplicationInstance (Maybe Bool) Source #
Boolean value indicating if minor version upgrades will be automatically applied to the instance.
replicationInstance_replicationInstancePublicIpAddresses :: Lens' ReplicationInstance (Maybe [Text]) Source #
One or more public IP addresses for the replication instance.
replicationInstance_replicationSubnetGroup :: Lens' ReplicationInstance (Maybe ReplicationSubnetGroup) Source #
The subnet group for the replication instance.
replicationInstance_instanceCreateTime :: Lens' ReplicationInstance (Maybe UTCTime) Source #
The time the replication instance was created.
replicationInstance_freeUntil :: Lens' ReplicationInstance (Maybe UTCTime) Source #
The expiration date of the free replication instance that is part of the Free DMS program.
replicationInstance_replicationInstanceStatus :: Lens' ReplicationInstance (Maybe Text) Source #
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"
replicationInstance_replicationInstancePrivateIpAddresses :: Lens' ReplicationInstance (Maybe [Text]) Source #
One or more private IP addresses for the replication instance.
replicationInstance_preferredMaintenanceWindow :: Lens' ReplicationInstance (Maybe Text) Source #
The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
replicationInstance_replicationInstancePrivateIpAddress :: Lens' ReplicationInstance (Maybe Text) Source #
The private IP address of the replication instance.
replicationInstance_kmsKeyId :: Lens' ReplicationInstance (Maybe Text) Source #
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.
replicationInstance_availabilityZone :: Lens' ReplicationInstance (Maybe Text) Source #
The Availability Zone for the instance.
replicationInstance_vpcSecurityGroups :: Lens' ReplicationInstance (Maybe [VpcSecurityGroupMembership]) Source #
The VPC security group for the instance.
replicationInstance_multiAZ :: Lens' ReplicationInstance (Maybe Bool) Source #
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.
replicationInstance_secondaryAvailabilityZone :: Lens' ReplicationInstance (Maybe Text) Source #
The Availability Zone of the standby replication instance in a Multi-AZ deployment.
replicationInstance_replicationInstanceArn :: Lens' ReplicationInstance (Maybe Text) Source #
The Amazon Resource Name (ARN) of the replication instance.
replicationInstance_allocatedStorage :: Lens' ReplicationInstance (Maybe Int) Source #
The amount of storage (in gigabytes) that is allocated for the replication instance.
replicationInstance_dnsNameServers :: Lens' ReplicationInstance (Maybe Text) Source #
The DNS name servers supported for the replication instance to access your on-premise source or target database.
replicationInstance_replicationInstancePublicIpAddress :: Lens' ReplicationInstance (Maybe Text) Source #
The public IP address of the replication instance.
replicationInstance_replicationInstanceClass :: Lens' ReplicationInstance (Maybe Text) Source #
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.
replicationInstance_replicationInstanceIdentifier :: Lens' ReplicationInstance (Maybe Text) Source #
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
replicationInstance_pendingModifiedValues :: Lens' ReplicationInstance (Maybe ReplicationPendingModifiedValues) Source #
The pending modification values.
ReplicationInstanceTaskLog
data ReplicationInstanceTaskLog Source #
Contains metadata for a replication instance task log.
See: newReplicationInstanceTaskLog smart constructor.
Constructors
| ReplicationInstanceTaskLog' | |
Fields
| |
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.
replicationInstanceTaskLog_replicationTaskName :: Lens' ReplicationInstanceTaskLog (Maybe Text) Source #
The name of the replication task.
replicationInstanceTaskLog_replicationTaskArn :: Lens' ReplicationInstanceTaskLog (Maybe Text) Source #
The Amazon Resource Name (ARN) of the replication task.
replicationInstanceTaskLog_replicationInstanceTaskLogSize :: Lens' ReplicationInstanceTaskLog (Maybe Integer) Source #
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.
Constructors
| ReplicationPendingModifiedValues' | |
Fields
| |
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.
replicationPendingModifiedValues_engineVersion :: Lens' ReplicationPendingModifiedValues (Maybe Text) Source #
The engine version number of the replication instance.
replicationPendingModifiedValues_multiAZ :: Lens' ReplicationPendingModifiedValues (Maybe Bool) Source #
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.
replicationPendingModifiedValues_allocatedStorage :: Lens' ReplicationPendingModifiedValues (Maybe Int) Source #
The amount of storage (in gigabytes) that is allocated for the replication instance.
replicationPendingModifiedValues_replicationInstanceClass :: Lens' ReplicationPendingModifiedValues (Maybe Text) Source #
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' | |
Fields
| |
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.
replicationSubnetGroup_vpcId :: Lens' ReplicationSubnetGroup (Maybe Text) Source #
The ID of the VPC.
replicationSubnetGroup_subnets :: Lens' ReplicationSubnetGroup (Maybe [Subnet]) Source #
The subnets that are in the subnet group.
replicationSubnetGroup_replicationSubnetGroupIdentifier :: Lens' ReplicationSubnetGroup (Maybe Text) Source #
The identifier of the replication instance subnet group.
replicationSubnetGroup_subnetGroupStatus :: Lens' ReplicationSubnetGroup (Maybe Text) Source #
The status of the subnet group.
replicationSubnetGroup_replicationSubnetGroupDescription :: Lens' ReplicationSubnetGroup (Maybe Text) Source #
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' | |
Fields
| |
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 areadystate 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.
replicationTask_replicationTaskSettings :: Lens' ReplicationTask (Maybe Text) Source #
The settings for the replication task.
replicationTask_status :: Lens' ReplicationTask (Maybe Text) Source #
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 areadystate 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.
replicationTask_stopReason :: Lens' ReplicationTask (Maybe Text) Source #
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.
replicationTask_targetEndpointArn :: Lens' ReplicationTask (Maybe Text) Source #
The ARN that uniquely identifies the endpoint.
replicationTask_replicationTaskIdentifier :: Lens' ReplicationTask (Maybe Text) Source #
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.
replicationTask_cdcStartPosition :: Lens' ReplicationTask (Maybe Text) Source #
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”
replicationTask_replicationTaskStartDate :: Lens' ReplicationTask (Maybe UTCTime) Source #
The date the replication task is scheduled to start.
replicationTask_sourceEndpointArn :: Lens' ReplicationTask (Maybe Text) Source #
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
replicationTask_recoveryCheckpoint :: Lens' ReplicationTask (Maybe Text) Source #
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.
replicationTask_tableMappings :: Lens' ReplicationTask (Maybe Text) Source #
Table mappings specified in the task.
replicationTask_targetReplicationInstanceArn :: Lens' ReplicationTask (Maybe Text) Source #
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.
replicationTask_replicationTaskCreationDate :: Lens' ReplicationTask (Maybe UTCTime) Source #
The date the replication task was created.
replicationTask_migrationType :: Lens' ReplicationTask (Maybe MigrationTypeValue) Source #
The type of migration.
replicationTask_replicationTaskArn :: Lens' ReplicationTask (Maybe Text) Source #
The Amazon Resource Name (ARN) of the replication task.
replicationTask_taskData :: Lens' ReplicationTask (Maybe Text) Source #
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.
replicationTask_cdcStopPosition :: Lens' ReplicationTask (Maybe Text) Source #
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 “
replicationTask_replicationTaskStats :: Lens' ReplicationTask (Maybe ReplicationTaskStats) Source #
The statistics for the task, including elapsed time, tables loaded, and table errors.
replicationTask_replicationInstanceArn :: Lens' ReplicationTask (Maybe Text) Source #
The ARN of the replication instance.
replicationTask_lastFailureMessage :: Lens' ReplicationTask (Maybe Text) Source #
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' | |
Fields
| |
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.
replicationTaskAssessmentResult_assessmentResults :: Lens' ReplicationTaskAssessmentResult (Maybe Text) Source #
The task assessment results in JSON format.
The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the request.
replicationTaskAssessmentResult_assessmentResultsFile :: Lens' ReplicationTaskAssessmentResult (Maybe Text) Source #
The file containing the results of the task assessment.
replicationTaskAssessmentResult_replicationTaskIdentifier :: Lens' ReplicationTaskAssessmentResult (Maybe Text) Source #
The replication task identifier of the task on which the task assessment was run.
replicationTaskAssessmentResult_assessmentStatus :: Lens' ReplicationTaskAssessmentResult (Maybe Text) Source #
The status of the task assessment.
replicationTaskAssessmentResult_s3ObjectUrl :: Lens' ReplicationTaskAssessmentResult (Maybe Text) Source #
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.
replicationTaskAssessmentResult_replicationTaskLastAssessmentDate :: Lens' ReplicationTaskAssessmentResult (Maybe UTCTime) Source #
The date the task assessment was completed.
replicationTaskAssessmentResult_replicationTaskArn :: Lens' ReplicationTaskAssessmentResult (Maybe Text) Source #
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' | |
Fields
| |
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 theCancelReplicationTaskAssessmentRunoperation."deleting"– The assessment run was deleted by theDeleteReplicationTaskAssessmentRunoperation."failed"– At least one individual assessment completed with afailedstatus."error-provisioning"– An internal error occurred while resources were provisioned (duringprovisioningstatus)."error-executing"– An internal error occurred while individual assessments ran (duringrunningstatus)."invalid state"– The assessment run is in an unknown state."passed"– All individual assessments have completed, and none has afailedstatus."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.
replicationTaskAssessmentRun_status :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
Assessment run status.
This status can have one of the following values:
"cancelling"– The assessment run was canceled by theCancelReplicationTaskAssessmentRunoperation."deleting"– The assessment run was deleted by theDeleteReplicationTaskAssessmentRunoperation."failed"– At least one individual assessment completed with afailedstatus."error-provisioning"– An internal error occurred while resources were provisioned (duringprovisioningstatus)."error-executing"– An internal error occurred while individual assessments ran (duringrunningstatus)."invalid state"– The assessment run is in an unknown state."passed"– All individual assessments have completed, and none has afailedstatus."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.
replicationTaskAssessmentRun_serviceAccessRoleArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
ARN of the service role used to start the assessment run using the
StartReplicationTaskAssessmentRun operation. The role must allow the
iam:PassRole action.
replicationTaskAssessmentRun_replicationTaskAssessmentRunCreationDate :: Lens' ReplicationTaskAssessmentRun (Maybe UTCTime) Source #
Date on which the assessment run was created using the
StartReplicationTaskAssessmentRun operation.
replicationTaskAssessmentRun_assessmentProgress :: Lens' ReplicationTaskAssessmentRun (Maybe ReplicationTaskAssessmentRunProgress) Source #
Indication of the completion progress for the individual assessments specified to run.
replicationTaskAssessmentRun_resultKmsKeyArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
ARN of the KMS encryption key used to encrypt the assessment run results.
replicationTaskAssessmentRun_replicationTaskArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
ARN of the migration task associated with this premigration assessment run.
replicationTaskAssessmentRun_resultLocationBucket :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
Amazon S3 bucket where DMS stores the results of this assessment run.
replicationTaskAssessmentRun_resultLocationFolder :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.
replicationTaskAssessmentRun_resultEncryptionMode :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
Encryption mode used to encrypt the assessment run results.
replicationTaskAssessmentRun_assessmentRunName :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
Unique name of the assessment run.
replicationTaskAssessmentRun_replicationTaskAssessmentRunArn :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
Amazon Resource Name (ARN) of this assessment run.
replicationTaskAssessmentRun_lastFailureMessage :: Lens' ReplicationTaskAssessmentRun (Maybe Text) Source #
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' | |
Fields
| |
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.
replicationTaskAssessmentRunProgress_individualAssessmentCount :: Lens' ReplicationTaskAssessmentRunProgress (Maybe Int) Source #
The number of individual assessments that are specified to run.
replicationTaskAssessmentRunProgress_individualAssessmentCompletedCount :: Lens' ReplicationTaskAssessmentRunProgress (Maybe Int) Source #
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' | |
Fields
| |
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.
replicationTaskIndividualAssessment_status :: Lens' ReplicationTaskIndividualAssessment (Maybe Text) Source #
Individual assessment status.
This status can have one of the following values:
"cancelled"
"error"
"failed"
"passed"
"pending"
"running"
replicationTaskIndividualAssessment_replicationTaskIndividualAssessmentStartDate :: Lens' ReplicationTaskIndividualAssessment (Maybe UTCTime) Source #
Date when this individual assessment was started as part of running the
StartReplicationTaskAssessmentRun operation.
replicationTaskIndividualAssessment_individualAssessmentName :: Lens' ReplicationTaskIndividualAssessment (Maybe Text) Source #
Name of this individual assessment.
replicationTaskIndividualAssessment_replicationTaskIndividualAssessmentArn :: Lens' ReplicationTaskIndividualAssessment (Maybe Text) Source #
Amazon Resource Name (ARN) of this individual assessment.
replicationTaskIndividualAssessment_replicationTaskAssessmentRunArn :: Lens' ReplicationTaskIndividualAssessment (Maybe Text) Source #
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' | |
Fields
| |
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.
replicationTaskStats_stopDate :: Lens' ReplicationTaskStats (Maybe UTCTime) Source #
The date the replication task was stopped.
replicationTaskStats_fullLoadProgressPercent :: Lens' ReplicationTaskStats (Maybe Int) Source #
The percent complete for the full load migration task.
replicationTaskStats_fullLoadStartDate :: Lens' ReplicationTaskStats (Maybe UTCTime) Source #
The date the replication task full load was started.
replicationTaskStats_elapsedTimeMillis :: Lens' ReplicationTaskStats (Maybe Integer) Source #
The elapsed time of the task, in milliseconds.
replicationTaskStats_startDate :: Lens' ReplicationTaskStats (Maybe UTCTime) Source #
The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType.
replicationTaskStats_tablesErrored :: Lens' ReplicationTaskStats (Maybe Int) Source #
The number of errors that have occurred during this task.
replicationTaskStats_fullLoadFinishDate :: Lens' ReplicationTaskStats (Maybe UTCTime) Source #
The date the replication task full load was completed.
replicationTaskStats_tablesLoaded :: Lens' ReplicationTaskStats (Maybe Int) Source #
The number of tables loaded for this task.
replicationTaskStats_tablesQueued :: Lens' ReplicationTaskStats (Maybe Int) Source #
The number of tables queued for this task.
replicationTaskStats_tablesLoading :: Lens' ReplicationTaskStats (Maybe Int) Source #
The number of tables currently loading for this task.
replicationTaskStats_freshStartDate :: Lens' ReplicationTaskStats (Maybe UTCTime) Source #
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' | |
Fields
| |
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.
resourcePendingMaintenanceActions_pendingMaintenanceActionDetails :: Lens' ResourcePendingMaintenanceActions (Maybe [PendingMaintenanceAction]) Source #
Detailed information about the pending maintenance action.
resourcePendingMaintenanceActions_resourceIdentifier :: Lens' ResourcePendingMaintenanceActions (Maybe Text) Source #
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' | |
Fields
| |
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_DICTIONARYuses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.PLAINdoesn't use encoding at all. Values are stored as they are.PLAIN_DICTIONARYbuilds 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.
s3Settings_parquetVersion :: Lens' S3Settings (Maybe ParquetVersionValue) Source #
The version of the Apache Parquet format that you want to use:
parquet_1_0 (the default) or parquet_2_0.
s3Settings_preserveTransactions :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_maxFileSize :: Lens' S3Settings (Maybe Int) Source #
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.
s3Settings_csvNoSupValue :: Lens' S3Settings (Maybe Text) Source #
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.
s3Settings_rfc4180 :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_parquetTimestampInMillisecond :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_includeOpForFullLoad :: Lens' S3Settings (Maybe Bool) Source #
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..
s3Settings_cdcMinFileSize :: Lens' S3Settings (Maybe Int) Source #
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.
s3Settings_csvDelimiter :: Lens' S3Settings (Maybe Text) Source #
The delimiter used to separate columns in the .csv file for both source and target. The default is a comma.
s3Settings_serviceAccessRoleArn :: Lens' S3Settings (Maybe Text) Source #
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.
s3Settings_bucketFolder :: Lens' S3Settings (Maybe Text) Source #
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/.
s3Settings_dataFormat :: Lens' S3Settings (Maybe DataFormatValue) Source #
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.
s3Settings_datePartitionEnabled :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_encodingType :: Lens' S3Settings (Maybe EncodingTypeValue) Source #
The type of encoding you are using:
RLE_DICTIONARYuses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.PLAINdoesn't use encoding at all. Values are stored as they are.PLAIN_DICTIONARYbuilds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.
s3Settings_cdcMaxBatchInterval :: Lens' S3Settings (Maybe Int) Source #
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.
s3Settings_ignoreHeaderRows :: Lens' S3Settings (Maybe Int) Source #
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.
s3Settings_externalTableDefinition :: Lens' S3Settings (Maybe Text) Source #
Specifies how tables are defined in the S3 source files only.
s3Settings_dictPageSizeLimit :: Lens' S3Settings (Maybe Int) Source #
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.
s3Settings_bucketName :: Lens' S3Settings (Maybe Text) Source #
The name of the S3 bucket.
s3Settings_encryptionMode :: Lens' S3Settings (Maybe EncryptionModeValue) Source #
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
s3Settings_enableStatistics :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_cdcInsertsOnly :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_timestampColumnName :: Lens' S3Settings (Maybe Text) Source #
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.
s3Settings_csvRowDelimiter :: Lens' S3Settings (Maybe Text) Source #
The delimiter used to separate rows in the .csv file for both source and
target. The default is a carriage return (\n).
s3Settings_datePartitionDelimiter :: Lens' S3Settings (Maybe DatePartitionDelimiterValue) Source #
Specifies a date separating delimiter to use during folder partitioning.
The default value is SLASH. Use this parameter when
DatePartitionedEnabled is set to true.
s3Settings_addColumnName :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_cannedAclForObjects :: Lens' S3Settings (Maybe CannedAclForObjectsValue) Source #
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.
s3Settings_compressionType :: Lens' S3Settings (Maybe CompressionTypeValue) Source #
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.
s3Settings_csvNullValue :: Lens' S3Settings (Maybe Text) Source #
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.
s3Settings_serverSideEncryptionKmsKeyId :: Lens' S3Settings (Maybe Text) Source #
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
s3Settings_dataPageSize :: Lens' S3Settings (Maybe Int) Source #
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.
s3Settings_useCsvNoSupValue :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_cdcInsertsAndUpdates :: Lens' S3Settings (Maybe Bool) Source #
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.
s3Settings_datePartitionSequence :: Lens' S3Settings (Maybe DatePartitionSequenceValue) Source #
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.
s3Settings_rowGroupLength :: Lens' S3Settings (Maybe Int) Source #
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).
s3Settings_cdcPath :: Lens' S3Settings (Maybe Text) Source #
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.
Constructors
| Subnet' | |
Fields
| |
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.
subnet_subnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source #
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' | |
Fields
| |
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.
supportedEndpointType_engineDisplayName :: Lens' SupportedEndpointType (Maybe Text) Source #
The expanded name for the engine name. For example, if the EngineName
parameter is "aurora," this value would be "Amazon Aurora MySQL."
supportedEndpointType_endpointType :: Lens' SupportedEndpointType (Maybe ReplicationEndpointTypeValue) Source #
The type of endpoint. Valid values are source and target.
supportedEndpointType_engineName :: Lens' SupportedEndpointType (Maybe Text) Source #
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".
supportedEndpointType_replicationInstanceEngineMinimumVersion :: Lens' SupportedEndpointType (Maybe Text) Source #
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.
supportedEndpointType_supportsCDC :: Lens' SupportedEndpointType (Maybe Bool) Source #
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' | |
Fields
| |
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.
sybaseSettings_serverName :: Lens' SybaseSettings (Maybe Text) Source #
Fully qualified domain name of the endpoint.
sybaseSettings_secretsManagerAccessRoleArn :: Lens' SybaseSettings (Maybe Text) Source #
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.
sybaseSettings_username :: Lens' SybaseSettings (Maybe Text) Source #
Endpoint connection user name.
sybaseSettings_password :: Lens' SybaseSettings (Maybe Text) Source #
Endpoint connection password.
sybaseSettings_databaseName :: Lens' SybaseSettings (Maybe Text) Source #
Database name for the endpoint.
sybaseSettings_secretsManagerSecretId :: Lens' SybaseSettings (Maybe Text) Source #
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the SAP SAE endpoint connection
details.
sybaseSettings_port :: Lens' SybaseSettings (Maybe Int) Source #
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' | |
Fields
| |
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.
tableStatistics_validationState :: Lens' TableStatistics (Maybe Text) Source #
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.
tableStatistics_fullLoadRows :: Lens' TableStatistics (Maybe Integer) Source #
The number of rows added during the full load operation.
tableStatistics_inserts :: Lens' TableStatistics (Maybe Integer) Source #
The number of insert actions performed on a table.
tableStatistics_fullLoadEndTime :: Lens' TableStatistics (Maybe UTCTime) Source #
The time when the full load operation completed.
tableStatistics_fullLoadCondtnlChkFailedRows :: Lens' TableStatistics (Maybe Integer) Source #
The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).
tableStatistics_fullLoadReloaded :: Lens' TableStatistics (Maybe Bool) Source #
A value that indicates if the table was reloaded (true) or loaded as
part of a new full load operation (false).
tableStatistics_validationFailedRecords :: Lens' TableStatistics (Maybe Integer) Source #
The number of records that failed validation.
tableStatistics_validationSuspendedRecords :: Lens' TableStatistics (Maybe Integer) Source #
The number of records that couldn't be validated.
tableStatistics_schemaName :: Lens' TableStatistics (Maybe Text) Source #
The schema name.
tableStatistics_validationStateDetails :: Lens' TableStatistics (Maybe Text) Source #
Additional details about the state of validation.
tableStatistics_tableState :: Lens' TableStatistics (Maybe Text) Source #
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
tableStatistics_fullLoadErrorRows :: Lens' TableStatistics (Maybe Integer) Source #
The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).
tableStatistics_ddls :: Lens' TableStatistics (Maybe Integer) Source #
The data definition language (DDL) used to build and modify the structure of your tables.
tableStatistics_deletes :: Lens' TableStatistics (Maybe Integer) Source #
The number of delete actions performed on a table.
tableStatistics_updates :: Lens' TableStatistics (Maybe Integer) Source #
The number of update actions performed on a table.
tableStatistics_validationPendingRecords :: Lens' TableStatistics (Maybe Integer) Source #
The number of records that have yet to be validated.
tableStatistics_fullLoadStartTime :: Lens' TableStatistics (Maybe UTCTime) Source #
The time when the full load operation started.
tableStatistics_lastUpdateTime :: Lens' TableStatistics (Maybe UTCTime) Source #
The last time a table was updated.
tableStatistics_tableName :: Lens' TableStatistics (Maybe Text) Source #
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' | |
Fields
| |
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.
tableToReload_schemaName :: Lens' TableToReload Text Source #
The schema name of the table to be reloaded.
tableToReload_tableName :: Lens' TableToReload Text Source #
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.
Constructors
| Tag' | |
Fields
| |
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}_.:/=+\\-]*)$").
tag_value :: Lens' Tag (Maybe Text) Source #
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}_.:/=+\\-]*)$").
tag_resourceArn :: Lens' Tag (Maybe Text) Source #
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.
tag_key :: Lens' Tag (Maybe Text) Source #
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' | |
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.
vpcSecurityGroupMembership_status :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #
The status of the VPC security group.
vpcSecurityGroupMembership_vpcSecurityGroupId :: Lens' VpcSecurityGroupMembership (Maybe Text) Source #
The VPC security group ID.