amazonka-dms-1.4.0: Amazon Database Migration Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DMS.Types

Contents

Description

 

Synopsis

Service Configuration

dms :: Service Source

API version '2016-01-01' of the Amazon Database Migration Service SDK configuration.

Errors

_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidSubnet' errors.

_KMSKeyNotAccessibleFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for KMSKeyNotAccessibleFault' errors.

_ReplicationSubnetGroupDoesNotCoverEnoughAZs :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for ReplicationSubnetGroupDoesNotCoverEnoughAZs' errors.

_InvalidResourceStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InvalidResourceStateFault' errors.

_ResourceAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for ResourceAlreadyExistsFault' errors.

_InsufficientResourceCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for InsufficientResourceCapacityFault' errors.

_ResourceQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for ResourceQuotaExceededFault' errors.

_UpgradeDependencyFailureFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for UpgradeDependencyFailureFault' errors.

_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for ResourceNotFoundFault' errors.

_StorageQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for StorageQuotaExceededFault' errors.

_AccessDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for AccessDeniedFault' errors.

_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for SubnetAlreadyInUse' errors.

MigrationTypeValue

data MigrationTypeValue Source

Constructors

Cdc 
FullLoad 
FullLoadAndCdc 

Instances

RefreshSchemasStatusTypeValue

data RefreshSchemasStatusTypeValue Source

Constructors

Failed 
Refreshing 
Successful 

Instances

ReplicationEndpointTypeValue

data ReplicationEndpointTypeValue Source

Constructors

Source 
Target 

Instances

StartReplicationTaskTypeValue

data StartReplicationTaskTypeValue Source

Constructors

ReloadTarget 
ResumeProcessing 
StartReplication 

Instances

AccountQuota

data AccountQuota Source

Describes a quota for an AWS account, for example, the number of replication instances allowed.

See: accountQuota smart constructor.

Instances

accountQuota :: AccountQuota Source

Creates a value of AccountQuota with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aqMax :: Lens' AccountQuota (Maybe Integer) Source

The maximum allowed value for the quota.

aqUsed :: Lens' AccountQuota (Maybe Integer) Source

The amount currently used toward the quota maximum.

aqAccountQuotaName :: Lens' AccountQuota (Maybe Text) Source

The name of the AWS DMS quota for this AWS account.

AvailabilityZone

data AvailabilityZone Source

See: availabilityZone smart constructor.

Instances

availabilityZone :: AvailabilityZone Source

Creates a value of AvailabilityZone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

azName :: Lens' AvailabilityZone (Maybe Text) Source

The name of the availability zone.

Connection

data Connection Source

See: connection smart constructor.

Instances

connection :: Connection Source

Creates a value of Connection with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cStatus :: Lens' Connection (Maybe Text) Source

The connection status.

cReplicationInstanceARN :: Lens' Connection (Maybe Text) Source

The Amazon Resource Name (ARN) of the replication instance.

cEndpointIdentifier :: Lens' Connection (Maybe Text) Source

The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

cReplicationInstanceIdentifier :: Lens' Connection (Maybe Text) Source

The replication instance identifier. This parameter is stored as a lowercase string.

cEndpointARN :: Lens' Connection (Maybe Text) Source

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

cLastFailureMessage :: Lens' Connection (Maybe Text) Source

The error message when the connection last failed.

Endpoint

data Endpoint Source

See: endpoint smart constructor.

Instances

endpoint :: Endpoint Source

Creates a value of Endpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

eStatus :: Lens' Endpoint (Maybe Text) Source

The status of the endpoint.

eServerName :: Lens' Endpoint (Maybe Text) Source

The name of the server at the endpoint.

eExtraConnectionAttributes :: Lens' Endpoint (Maybe Text) Source

Additional connection attributes used to connect to the endpoint.

eEndpointType :: Lens' Endpoint (Maybe ReplicationEndpointTypeValue) Source

The type of endpoint.

eUsername :: Lens' Endpoint (Maybe Text) Source

The user name used to connect to the endpoint.

eEngineName :: Lens' Endpoint (Maybe Text) Source

The database engine name.

eKMSKeyId :: Lens' Endpoint (Maybe Text) Source

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

eDatabaseName :: Lens' Endpoint (Maybe Text) Source

The name of the database at the endpoint.

eEndpointIdentifier :: Lens' Endpoint (Maybe Text) Source

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

eEndpointARN :: Lens' Endpoint (Maybe Text) Source

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

ePort :: Lens' Endpoint (Maybe Int) Source

The port value used to access the endpoint.

Filter

data Filter Source

See: filter' smart constructor.

Instances

filter' Source

Arguments

:: Text

fName

-> Filter 

Creates a value of Filter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

fName :: Lens' Filter Text Source

The name of the filter.

fValues :: Lens' Filter [Text] Source

The filter value.

OrderableReplicationInstance

data OrderableReplicationInstance Source

See: orderableReplicationInstance smart constructor.

Instances

orderableReplicationInstance :: OrderableReplicationInstance Source

Creates a value of OrderableReplicationInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

oriEngineVersion :: Lens' OrderableReplicationInstance (Maybe Text) Source

The version of the replication engine.

oriMinAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

oriIncludedAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source

The amount of storage (in gigabytes) that is allocated for the replication instance.

oriMaxAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

oriReplicationInstanceClass :: Lens' OrderableReplicationInstance (Maybe Text) Source

The compute and memory capacity of the replication instance.

Valid Values: 'dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge '

oriDefaultAllocatedStorage :: Lens' OrderableReplicationInstance (Maybe Int) Source

The default amount of storage (in gigabytes) that is allocated for the replication instance.

oriStorageType :: Lens' OrderableReplicationInstance (Maybe Text) Source

The type of storage used by the replication instance.

RefreshSchemasStatus

data RefreshSchemasStatus Source

See: refreshSchemasStatus smart constructor.

Instances

refreshSchemasStatus :: RefreshSchemasStatus Source

Creates a value of RefreshSchemasStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rssStatus :: Lens' RefreshSchemasStatus (Maybe RefreshSchemasStatusTypeValue) Source

The status of the schema.

rssLastRefreshDate :: Lens' RefreshSchemasStatus (Maybe UTCTime) Source

The date the schema was last refreshed.

rssReplicationInstanceARN :: Lens' RefreshSchemasStatus (Maybe Text) Source

The Amazon Resource Name (ARN) of the replication instance.

rssEndpointARN :: Lens' RefreshSchemasStatus (Maybe Text) Source

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

rssLastFailureMessage :: Lens' RefreshSchemasStatus (Maybe Text) Source

The last failure message for the schema.

ReplicationInstance

data ReplicationInstance Source

See: replicationInstance smart constructor.

Instances

replicationInstance :: ReplicationInstance Source

Creates a value of ReplicationInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

riEngineVersion :: Lens' ReplicationInstance (Maybe Text) Source

The engine version number of the replication instance.

riPubliclyAccessible :: 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.

riAutoMinorVersionUpgrade :: Lens' ReplicationInstance (Maybe Bool) Source

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

riReplicationSubnetGroup :: Lens' ReplicationInstance (Maybe ReplicationSubnetGroup) Source

The subnet group for the replication instance.

riInstanceCreateTime :: Lens' ReplicationInstance (Maybe UTCTime) Source

The time the replication instance was created.

riReplicationInstanceStatus :: Lens' ReplicationInstance (Maybe Text) Source

The status of the replication instance.

riPreferredMaintenanceWindow :: Lens' ReplicationInstance (Maybe Text) Source

The maintenance window times for the replication instance.

riReplicationInstancePrivateIPAddress :: Lens' ReplicationInstance (Maybe Text) Source

The private IP address of the replication instance.

riKMSKeyId :: Lens' ReplicationInstance (Maybe Text) Source

The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

riAvailabilityZone :: Lens' ReplicationInstance (Maybe Text) Source

The Availability Zone for the instance.

riReplicationInstanceARN :: Lens' ReplicationInstance (Maybe Text) Source

The Amazon Resource Name (ARN) of the replication instance.

riAllocatedStorage :: Lens' ReplicationInstance (Maybe Int) Source

The amount of storage (in gigabytes) that is allocated for the replication instance.

riReplicationInstancePublicIPAddress :: Lens' ReplicationInstance (Maybe Text) Source

The public IP address of the replication instance.

riReplicationInstanceClass :: Lens' ReplicationInstance (Maybe Text) Source

The compute and memory capacity of the replication instance.

Valid Values: 'dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge '

riReplicationInstanceIdentifier :: Lens' ReplicationInstance (Maybe Text) Source

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

riPendingModifiedValues :: Lens' ReplicationInstance (Maybe ReplicationPendingModifiedValues) Source

The pending modification values.

ReplicationPendingModifiedValues

data ReplicationPendingModifiedValues Source

See: replicationPendingModifiedValues smart constructor.

Instances

replicationPendingModifiedValues :: ReplicationPendingModifiedValues Source

Creates a value of ReplicationPendingModifiedValues with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rpmvEngineVersion :: Lens' ReplicationPendingModifiedValues (Maybe Text) Source

The engine version number of the replication instance.

rpmvAllocatedStorage :: Lens' ReplicationPendingModifiedValues (Maybe Int) Source

The amount of storage (in gigabytes) that is allocated for the replication instance.

rpmvReplicationInstanceClass :: Lens' ReplicationPendingModifiedValues (Maybe Text) Source

The compute and memory capacity of the replication instance.

Valid Values: 'dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge '

ReplicationSubnetGroup

data ReplicationSubnetGroup Source

See: replicationSubnetGroup smart constructor.

Instances

replicationSubnetGroup :: ReplicationSubnetGroup Source

Creates a value of ReplicationSubnetGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rsgVPCId :: Lens' ReplicationSubnetGroup (Maybe Text) Source

The ID of the VPC.

rsgSubnets :: Lens' ReplicationSubnetGroup [Subnet] Source

The subnets that are in the subnet group.

rsgReplicationSubnetGroupIdentifier :: Lens' ReplicationSubnetGroup (Maybe Text) Source

The identifier of the replication instance subnet group.

rsgSubnetGroupStatus :: Lens' ReplicationSubnetGroup (Maybe Text) Source

The status of the subnet group.

rsgReplicationSubnetGroupDescription :: Lens' ReplicationSubnetGroup (Maybe Text) Source

The description of the replication subnet group.

ReplicationTask

data ReplicationTask Source

See: replicationTask smart constructor.

Instances

replicationTask :: ReplicationTask Source

Creates a value of ReplicationTask with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rtReplicationTaskSettings :: Lens' ReplicationTask (Maybe Text) Source

The settings for the replication task.

rtStatus :: Lens' ReplicationTask (Maybe Text) Source

The status of the replication task.

rtTargetEndpointARN :: Lens' ReplicationTask (Maybe Text) Source

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

rtReplicationTaskIdentifier :: Lens' ReplicationTask (Maybe Text) Source

The replication task identifier.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

rtReplicationTaskStartDate :: Lens' ReplicationTask (Maybe UTCTime) Source

The date the replication task is scheduled to start.

rtSourceEndpointARN :: Lens' ReplicationTask (Maybe Text) Source

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

rtTableMappings :: Lens' ReplicationTask (Maybe Text) Source

Table mappings specified in the task.

rtReplicationTaskCreationDate :: Lens' ReplicationTask (Maybe UTCTime) Source

The date the replication task was created.

rtMigrationType :: Lens' ReplicationTask (Maybe MigrationTypeValue) Source

The type of migration.

rtReplicationTaskARN :: Lens' ReplicationTask (Maybe Text) Source

The Amazon Resource Name (ARN) of the replication task.

rtReplicationTaskStats :: Lens' ReplicationTask (Maybe ReplicationTaskStats) Source

The statistics for the task, including elapsed time, tables loaded, and table errors.

rtReplicationInstanceARN :: Lens' ReplicationTask (Maybe Text) Source

The Amazon Resource Name (ARN) of the replication instance.

rtLastFailureMessage :: Lens' ReplicationTask (Maybe Text) Source

The last error (failure) message generated for the replication instance.

ReplicationTaskStats

data ReplicationTaskStats Source

See: replicationTaskStats smart constructor.

Instances

replicationTaskStats :: ReplicationTaskStats Source

Creates a value of ReplicationTaskStats with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rtsFullLoadProgressPercent :: Lens' ReplicationTaskStats (Maybe Int) Source

The percent complete for the full load migration task.

rtsElapsedTimeMillis :: Lens' ReplicationTaskStats (Maybe Integer) Source

The elapsed time of the task, in milliseconds.

rtsTablesErrored :: Lens' ReplicationTaskStats (Maybe Int) Source

The number of errors that have occurred during this task.

rtsTablesLoaded :: Lens' ReplicationTaskStats (Maybe Int) Source

The number of tables loaded for this task.

rtsTablesQueued :: Lens' ReplicationTaskStats (Maybe Int) Source

The number of tables queued for this task.

rtsTablesLoading :: Lens' ReplicationTaskStats (Maybe Int) Source

The number of tables currently loading for this task.

Subnet

data Subnet Source

See: subnet smart constructor.

Instances

subnet :: Subnet Source

Creates a value of Subnet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sSubnetStatus :: Lens' Subnet (Maybe Text) Source

The status of the subnet.

sSubnetIdentifier :: Lens' Subnet (Maybe Text) Source

The subnet identifier.

sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone) Source

The Availability Zone of the subnet.

SupportedEndpointType

data SupportedEndpointType Source

See: supportedEndpointType smart constructor.

Instances

supportedEndpointType :: SupportedEndpointType Source

Creates a value of SupportedEndpointType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

setEndpointType :: Lens' SupportedEndpointType (Maybe ReplicationEndpointTypeValue) Source

The type of endpoint.

setEngineName :: Lens' SupportedEndpointType (Maybe Text) Source

The database engine name.

setSupportsCDC :: Lens' SupportedEndpointType (Maybe Bool) Source

Indicates if Change Data Capture (CDC) is supported.

TableStatistics

data TableStatistics Source

See: tableStatistics smart constructor.

Instances

tableStatistics :: TableStatistics Source

Creates a value of TableStatistics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tsFullLoadRows :: Lens' TableStatistics (Maybe Integer) Source

The number of rows added during the Full Load operation.

tsInserts :: Lens' TableStatistics (Maybe Integer) Source

The number of insert actions performed on a table.

tsSchemaName :: Lens' TableStatistics (Maybe Text) Source

The schema name.

tsTableState :: Lens' TableStatistics (Maybe Text) Source

The state of the table.

tsDdls :: Lens' TableStatistics (Maybe Integer) Source

The Data Definition Language (DDL) used to build and modify the structure of your tables.

tsDeletes :: Lens' TableStatistics (Maybe Integer) Source

The number of delete actions performed on a table.

tsUpdates :: Lens' TableStatistics (Maybe Integer) Source

The number of update actions performed on a table.

tsLastUpdateTime :: Lens' TableStatistics (Maybe UTCTime) Source

The last time the table was updated.

tsTableName :: Lens' TableStatistics (Maybe Text) Source

The name of the table.

Tag

data Tag Source

See: tag smart constructor.

Instances

tag :: Tag Source

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tagValue :: Lens' Tag (Maybe Text) Source

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

tagKey :: Lens' Tag (Maybe Text) Source

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").