@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
126 lines (125 loc) • 4.57 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Data source for managing an AWS DMS (Database Migration) Replication Task.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.dms.getReplicationTask({
* replicationTaskId: testAwsDmsReplicationTask.replicationTaskId,
* });
* ```
*/
export declare function getReplicationTask(args: GetReplicationTaskArgs, opts?: pulumi.InvokeOptions): Promise<GetReplicationTaskResult>;
/**
* A collection of arguments for invoking getReplicationTask.
*/
export interface GetReplicationTaskArgs {
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* The replication task identifier.
*/
replicationTaskId: string;
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getReplicationTask.
*/
export interface GetReplicationTaskResult {
/**
* (Conflicts with `cdcStartTime`) Indicates when you want a change data capture (CDC) operation to start. The value can be in date, checkpoint, or LSN/SCN format depending on the source engine. For more information, see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native).
*/
readonly cdcStartPosition: string;
/**
* (Conflicts with `cdcStartPosition`) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation.
*/
readonly cdcStartTime: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The migration type. Can be one of `full-load | cdc | full-load-and-cdc`.
*/
readonly migrationType: string;
readonly region: string;
/**
* The Amazon Resource Name (ARN) of the replication instance.
*/
readonly replicationInstanceArn: string;
/**
* The Amazon Resource Name (ARN) for the replication task.
*/
readonly replicationTaskArn: string;
readonly replicationTaskId: string;
/**
* An escaped JSON string that contains the task settings. For a complete list of task settings, see [Task Settings for AWS Database Migration Service Tasks](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html).
*/
readonly replicationTaskSettings: string;
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint.
*/
readonly sourceEndpointArn: string;
/**
* Whether to run or stop the replication task.
*/
readonly startReplicationTask: boolean;
/**
* Replication Task status.
*/
readonly status: string;
/**
* An escaped JSON string that contains the table mappings. For information on table mapping see [Using Table Mapping with an AWS Database Migration Service Task to Select and Filter Data](http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html)
*/
readonly tableMappings: string;
readonly tags: {
[key: string]: string;
};
/**
* The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint.
*/
readonly targetEndpointArn: string;
}
/**
* Data source for managing an AWS DMS (Database Migration) Replication Task.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = aws.dms.getReplicationTask({
* replicationTaskId: testAwsDmsReplicationTask.replicationTaskId,
* });
* ```
*/
export declare function getReplicationTaskOutput(args: GetReplicationTaskOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetReplicationTaskResult>;
/**
* A collection of arguments for invoking getReplicationTask.
*/
export interface GetReplicationTaskOutputArgs {
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The replication task identifier.
*/
replicationTaskId: pulumi.Input<string>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}