Class AbstractAWSDatabaseMigrationService
- java.lang.Object
-
- com.amazonaws.services.databasemigrationservice.AbstractAWSDatabaseMigrationService
-
- All Implemented Interfaces:
AWSDatabaseMigrationService
- Direct Known Subclasses:
AbstractAWSDatabaseMigrationServiceAsync
public class AbstractAWSDatabaseMigrationService extends Object implements AWSDatabaseMigrationService
Abstract implementation ofAWSDatabaseMigrationService
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAWSDatabaseMigrationService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddTagsToResourceResult
addTagsToResource(AddTagsToResourceRequest request)
Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task.CreateEndpointResult
createEndpoint(CreateEndpointRequest request)
Creates an endpoint using the provided settings.CreateReplicationInstanceResult
createReplicationInstance(CreateReplicationInstanceRequest request)
Creates the replication instance using the specified parameters.CreateReplicationSubnetGroupResult
createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)
Creates a replication subnet group given a list of the subnet IDs in a VPC.CreateReplicationTaskResult
createReplicationTask(CreateReplicationTaskRequest request)
Creates a replication task using the specified parameters.DeleteEndpointResult
deleteEndpoint(DeleteEndpointRequest request)
Deletes the specified endpoint.DeleteReplicationInstanceResult
deleteReplicationInstance(DeleteReplicationInstanceRequest request)
Deletes the specified replication instance.DeleteReplicationSubnetGroupResult
deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)
Deletes a subnet group.DeleteReplicationTaskResult
deleteReplicationTask(DeleteReplicationTaskRequest request)
Deletes the specified replication task.DescribeAccountAttributesResult
describeAccountAttributes(DescribeAccountAttributesRequest request)
Lists all of the AWS DMS attributes for a customer account.DescribeConnectionsResult
describeConnections(DescribeConnectionsRequest request)
Describes the status of the connections that have been made between the replication instance and an endpoint.DescribeEndpointsResult
describeEndpoints(DescribeEndpointsRequest request)
Returns information about the endpoints for your account in the current region.DescribeEndpointTypesResult
describeEndpointTypes(DescribeEndpointTypesRequest request)
Returns information about the type of endpoints available.DescribeOrderableReplicationInstancesResult
describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)
Returns information about the replication instance types that can be created in the specified region.DescribeRefreshSchemasStatusResult
describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)
Returns the status of the RefreshSchemas operation.DescribeReplicationInstancesResult
describeReplicationInstances(DescribeReplicationInstancesRequest request)
Returns information about replication instances for your account in the current region.DescribeReplicationSubnetGroupsResult
describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)
Returns information about the replication subnet groups.DescribeReplicationTasksResult
describeReplicationTasks(DescribeReplicationTasksRequest request)
Returns information about replication tasks for your account in the current region.DescribeSchemasResult
describeSchemas(DescribeSchemasRequest request)
Returns information about the schema for the specified endpoint.DescribeTableStatisticsResult
describeTableStatistics(DescribeTableStatisticsRequest request)
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.ResponseMetadata
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.ListTagsForResourceResult
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags for an AWS DMS resource.ModifyEndpointResult
modifyEndpoint(ModifyEndpointRequest request)
Modifies the specified endpoint.ModifyReplicationInstanceResult
modifyReplicationInstance(ModifyReplicationInstanceRequest request)
Modifies the replication instance to apply new settings.ModifyReplicationSubnetGroupResult
modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)
Modifies the settings for the specified replication subnet group.RefreshSchemasResult
refreshSchemas(RefreshSchemasRequest request)
Populates the schema for the specified endpoint.RemoveTagsFromResourceResult
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes metadata tags from a DMS resource.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com").void
setRegion(Region region)
An alternative toAWSDatabaseMigrationService.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.StartReplicationTaskResult
startReplicationTask(StartReplicationTaskRequest request)
Starts the replication task.StopReplicationTaskResult
stopReplicationTask(StopReplicationTaskRequest request)
Stops the replication task.TestConnectionResult
testConnection(TestConnectionRequest request)
Tests the connection between the replication instance and the endpoint.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AWSDatabaseMigrationService
Overrides the default endpoint for this client ("dms.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "dms.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAWSDatabaseMigrationService
- Parameters:
endpoint
- The endpoint (ex: "dms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "dms.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
public void setRegion(Region region)
Description copied from interface:AWSDatabaseMigrationService
An alternative toAWSDatabaseMigrationService.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAWSDatabaseMigrationService
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
addTagsToResource
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
Description copied from interface:AWSDatabaseMigrationService
Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.
- Specified by:
addTagsToResource
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the AddTagsToResource operation returned by the service.
-
createEndpoint
public CreateEndpointResult createEndpoint(CreateEndpointRequest request)
Description copied from interface:AWSDatabaseMigrationService
Creates an endpoint using the provided settings.
- Specified by:
createEndpoint
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the CreateEndpoint operation returned by the service.
-
createReplicationInstance
public CreateReplicationInstanceResult createReplicationInstance(CreateReplicationInstanceRequest request)
Description copied from interface:AWSDatabaseMigrationService
Creates the replication instance using the specified parameters.
- Specified by:
createReplicationInstance
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the CreateReplicationInstance operation returned by the service.
-
createReplicationSubnetGroup
public CreateReplicationSubnetGroupResult createReplicationSubnetGroup(CreateReplicationSubnetGroupRequest request)
Description copied from interface:AWSDatabaseMigrationService
Creates a replication subnet group given a list of the subnet IDs in a VPC.
- Specified by:
createReplicationSubnetGroup
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the CreateReplicationSubnetGroup operation returned by the service.
-
createReplicationTask
public CreateReplicationTaskResult createReplicationTask(CreateReplicationTaskRequest request)
Description copied from interface:AWSDatabaseMigrationService
Creates a replication task using the specified parameters.
- Specified by:
createReplicationTask
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the CreateReplicationTask operation returned by the service.
-
deleteEndpoint
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
Description copied from interface:AWSDatabaseMigrationService
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint. - Specified by:
deleteEndpoint
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DeleteEndpoint operation returned by the service.
-
deleteReplicationInstance
public DeleteReplicationInstanceResult deleteReplicationInstance(DeleteReplicationInstanceRequest request)
Description copied from interface:AWSDatabaseMigrationService
Deletes the specified replication instance.
You must delete any migration tasks that are associated with the replication instance before you can delete it. - Specified by:
deleteReplicationInstance
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DeleteReplicationInstance operation returned by the service.
-
deleteReplicationSubnetGroup
public DeleteReplicationSubnetGroupResult deleteReplicationSubnetGroup(DeleteReplicationSubnetGroupRequest request)
Description copied from interface:AWSDatabaseMigrationService
Deletes a subnet group.
- Specified by:
deleteReplicationSubnetGroup
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DeleteReplicationSubnetGroup operation returned by the service.
-
deleteReplicationTask
public DeleteReplicationTaskResult deleteReplicationTask(DeleteReplicationTaskRequest request)
Description copied from interface:AWSDatabaseMigrationService
Deletes the specified replication task.
- Specified by:
deleteReplicationTask
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DeleteReplicationTask operation returned by the service.
-
describeAccountAttributes
public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
Description copied from interface:AWSDatabaseMigrationService
Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command does not take any parameters.
- Specified by:
describeAccountAttributes
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
-
describeConnections
public DescribeConnectionsResult describeConnections(DescribeConnectionsRequest request)
Description copied from interface:AWSDatabaseMigrationService
Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.
- Specified by:
describeConnections
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeConnections operation returned by the service.
-
describeEndpointTypes
public DescribeEndpointTypesResult describeEndpointTypes(DescribeEndpointTypesRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns information about the type of endpoints available.
- Specified by:
describeEndpointTypes
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeEndpointTypes operation returned by the service.
-
describeEndpoints
public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns information about the endpoints for your account in the current region.
- Specified by:
describeEndpoints
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeEndpoints operation returned by the service.
-
describeOrderableReplicationInstances
public DescribeOrderableReplicationInstancesResult describeOrderableReplicationInstances(DescribeOrderableReplicationInstancesRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns information about the replication instance types that can be created in the specified region.
- Specified by:
describeOrderableReplicationInstances
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeOrderableReplicationInstances operation returned by the service.
-
describeRefreshSchemasStatus
public DescribeRefreshSchemasStatusResult describeRefreshSchemasStatus(DescribeRefreshSchemasStatusRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns the status of the RefreshSchemas operation.
- Specified by:
describeRefreshSchemasStatus
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeRefreshSchemasStatus operation returned by the service.
-
describeReplicationInstances
public DescribeReplicationInstancesResult describeReplicationInstances(DescribeReplicationInstancesRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns information about replication instances for your account in the current region.
- Specified by:
describeReplicationInstances
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeReplicationInstances operation returned by the service.
-
describeReplicationSubnetGroups
public DescribeReplicationSubnetGroupsResult describeReplicationSubnetGroups(DescribeReplicationSubnetGroupsRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns information about the replication subnet groups.
- Specified by:
describeReplicationSubnetGroups
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeReplicationSubnetGroups operation returned by the service.
-
describeReplicationTasks
public DescribeReplicationTasksResult describeReplicationTasks(DescribeReplicationTasksRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns information about replication tasks for your account in the current region.
- Specified by:
describeReplicationTasks
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeReplicationTasks operation returned by the service.
-
describeSchemas
public DescribeSchemasResult describeSchemas(DescribeSchemasRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns information about the schema for the specified endpoint.
- Specified by:
describeSchemas
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeSchemas operation returned by the service.
-
describeTableStatistics
public DescribeTableStatisticsResult describeTableStatistics(DescribeTableStatisticsRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.
- Specified by:
describeTableStatistics
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the DescribeTableStatistics operation returned by the service.
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Description copied from interface:AWSDatabaseMigrationService
Lists all tags for an AWS DMS resource.
- Specified by:
listTagsForResource
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the ListTagsForResource operation returned by the service.
-
modifyEndpoint
public ModifyEndpointResult modifyEndpoint(ModifyEndpointRequest request)
Description copied from interface:AWSDatabaseMigrationService
Modifies the specified endpoint.
- Specified by:
modifyEndpoint
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the ModifyEndpoint operation returned by the service.
-
modifyReplicationInstance
public ModifyReplicationInstanceResult modifyReplicationInstance(ModifyReplicationInstanceRequest request)
Description copied from interface:AWSDatabaseMigrationService
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window. - Specified by:
modifyReplicationInstance
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the ModifyReplicationInstance operation returned by the service.
-
modifyReplicationSubnetGroup
public ModifyReplicationSubnetGroupResult modifyReplicationSubnetGroup(ModifyReplicationSubnetGroupRequest request)
Description copied from interface:AWSDatabaseMigrationService
Modifies the settings for the specified replication subnet group.
- Specified by:
modifyReplicationSubnetGroup
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the ModifyReplicationSubnetGroup operation returned by the service.
-
refreshSchemas
public RefreshSchemasResult refreshSchemas(RefreshSchemasRequest request)
Description copied from interface:AWSDatabaseMigrationService
Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.
- Specified by:
refreshSchemas
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the RefreshSchemas operation returned by the service.
-
removeTagsFromResource
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Description copied from interface:AWSDatabaseMigrationService
Removes metadata tags from a DMS resource.
- Specified by:
removeTagsFromResource
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
-
startReplicationTask
public StartReplicationTaskResult startReplicationTask(StartReplicationTaskRequest request)
Description copied from interface:AWSDatabaseMigrationService
Starts the replication task.
- Specified by:
startReplicationTask
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the StartReplicationTask operation returned by the service.
-
stopReplicationTask
public StopReplicationTaskResult stopReplicationTask(StopReplicationTaskRequest request)
Description copied from interface:AWSDatabaseMigrationService
Stops the replication task.
- Specified by:
stopReplicationTask
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the StopReplicationTask operation returned by the service.
-
testConnection
public TestConnectionResult testConnection(TestConnectionRequest request)
Description copied from interface:AWSDatabaseMigrationService
Tests the connection between the replication instance and the endpoint.
- Specified by:
testConnection
in interfaceAWSDatabaseMigrationService
- Returns:
- Result of the TestConnection operation returned by the service.
-
shutdown
public void shutdown()
Description copied from interface:AWSDatabaseMigrationService
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAWSDatabaseMigrationService
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AWSDatabaseMigrationService
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSDatabaseMigrationService
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-