github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/dms/getReplicationTask.go (about) 1 // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT. 2 // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! *** 3 4 package dms 5 6 import ( 7 "context" 8 "reflect" 9 10 "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal" 11 "github.com/pulumi/pulumi/sdk/v3/go/pulumi" 12 ) 13 14 // Data source for managing an AWS DMS (Database Migration) Replication Task. 15 // 16 // ## Example Usage 17 // 18 // ### Basic Usage 19 // 20 // <!--Start PulumiCodeChooser --> 21 // ```go 22 // package main 23 // 24 // import ( 25 // 26 // "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/dms" 27 // "github.com/pulumi/pulumi/sdk/v3/go/pulumi" 28 // 29 // ) 30 // 31 // func main() { 32 // pulumi.Run(func(ctx *pulumi.Context) error { 33 // _, err := dms.LookupReplicationTask(ctx, &dms.LookupReplicationTaskArgs{ 34 // ReplicationTaskId: testAwsDmsReplicationTask.ReplicationTaskId, 35 // }, nil) 36 // if err != nil { 37 // return err 38 // } 39 // return nil 40 // }) 41 // } 42 // 43 // ``` 44 // <!--End PulumiCodeChooser --> 45 func LookupReplicationTask(ctx *pulumi.Context, args *LookupReplicationTaskArgs, opts ...pulumi.InvokeOption) (*LookupReplicationTaskResult, error) { 46 opts = internal.PkgInvokeDefaultOpts(opts) 47 var rv LookupReplicationTaskResult 48 err := ctx.Invoke("aws:dms/getReplicationTask:getReplicationTask", args, &rv, opts...) 49 if err != nil { 50 return nil, err 51 } 52 return &rv, nil 53 } 54 55 // A collection of arguments for invoking getReplicationTask. 56 type LookupReplicationTaskArgs struct { 57 // The replication task identifier. 58 // 59 // - Must contain from 1 to 255 alphanumeric characters or hyphens. 60 // - First character must be a letter. 61 // - Cannot end with a hyphen. 62 // - Cannot contain two consecutive hyphens. 63 ReplicationTaskId string `pulumi:"replicationTaskId"` 64 Tags map[string]string `pulumi:"tags"` 65 } 66 67 // A collection of values returned by getReplicationTask. 68 type LookupReplicationTaskResult struct { 69 // (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). 70 CdcStartPosition string `pulumi:"cdcStartPosition"` 71 // (Conflicts with `cdcStartPosition`) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation. 72 CdcStartTime string `pulumi:"cdcStartTime"` 73 // The provider-assigned unique ID for this managed resource. 74 Id string `pulumi:"id"` 75 // The migration type. Can be one of `full-load | cdc | full-load-and-cdc`. 76 MigrationType string `pulumi:"migrationType"` 77 // The Amazon Resource Name (ARN) of the replication instance. 78 ReplicationInstanceArn string `pulumi:"replicationInstanceArn"` 79 // The Amazon Resource Name (ARN) for the replication task. 80 ReplicationTaskArn string `pulumi:"replicationTaskArn"` 81 ReplicationTaskId string `pulumi:"replicationTaskId"` 82 // 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). 83 ReplicationTaskSettings string `pulumi:"replicationTaskSettings"` 84 // The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint. 85 SourceEndpointArn string `pulumi:"sourceEndpointArn"` 86 // Whether to run or stop the replication task. 87 StartReplicationTask bool `pulumi:"startReplicationTask"` 88 // Replication Task status. 89 Status string `pulumi:"status"` 90 // 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) 91 TableMappings string `pulumi:"tableMappings"` 92 Tags map[string]string `pulumi:"tags"` 93 // The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint. 94 TargetEndpointArn string `pulumi:"targetEndpointArn"` 95 } 96 97 func LookupReplicationTaskOutput(ctx *pulumi.Context, args LookupReplicationTaskOutputArgs, opts ...pulumi.InvokeOption) LookupReplicationTaskResultOutput { 98 return pulumi.ToOutputWithContext(context.Background(), args). 99 ApplyT(func(v interface{}) (LookupReplicationTaskResult, error) { 100 args := v.(LookupReplicationTaskArgs) 101 r, err := LookupReplicationTask(ctx, &args, opts...) 102 var s LookupReplicationTaskResult 103 if r != nil { 104 s = *r 105 } 106 return s, err 107 }).(LookupReplicationTaskResultOutput) 108 } 109 110 // A collection of arguments for invoking getReplicationTask. 111 type LookupReplicationTaskOutputArgs struct { 112 // The replication task identifier. 113 // 114 // - Must contain from 1 to 255 alphanumeric characters or hyphens. 115 // - First character must be a letter. 116 // - Cannot end with a hyphen. 117 // - Cannot contain two consecutive hyphens. 118 ReplicationTaskId pulumi.StringInput `pulumi:"replicationTaskId"` 119 Tags pulumi.StringMapInput `pulumi:"tags"` 120 } 121 122 func (LookupReplicationTaskOutputArgs) ElementType() reflect.Type { 123 return reflect.TypeOf((*LookupReplicationTaskArgs)(nil)).Elem() 124 } 125 126 // A collection of values returned by getReplicationTask. 127 type LookupReplicationTaskResultOutput struct{ *pulumi.OutputState } 128 129 func (LookupReplicationTaskResultOutput) ElementType() reflect.Type { 130 return reflect.TypeOf((*LookupReplicationTaskResult)(nil)).Elem() 131 } 132 133 func (o LookupReplicationTaskResultOutput) ToLookupReplicationTaskResultOutput() LookupReplicationTaskResultOutput { 134 return o 135 } 136 137 func (o LookupReplicationTaskResultOutput) ToLookupReplicationTaskResultOutputWithContext(ctx context.Context) LookupReplicationTaskResultOutput { 138 return o 139 } 140 141 // (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). 142 func (o LookupReplicationTaskResultOutput) CdcStartPosition() pulumi.StringOutput { 143 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.CdcStartPosition }).(pulumi.StringOutput) 144 } 145 146 // (Conflicts with `cdcStartPosition`) The Unix timestamp integer for the start of the Change Data Capture (CDC) operation. 147 func (o LookupReplicationTaskResultOutput) CdcStartTime() pulumi.StringOutput { 148 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.CdcStartTime }).(pulumi.StringOutput) 149 } 150 151 // The provider-assigned unique ID for this managed resource. 152 func (o LookupReplicationTaskResultOutput) Id() pulumi.StringOutput { 153 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.Id }).(pulumi.StringOutput) 154 } 155 156 // The migration type. Can be one of `full-load | cdc | full-load-and-cdc`. 157 func (o LookupReplicationTaskResultOutput) MigrationType() pulumi.StringOutput { 158 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.MigrationType }).(pulumi.StringOutput) 159 } 160 161 // The Amazon Resource Name (ARN) of the replication instance. 162 func (o LookupReplicationTaskResultOutput) ReplicationInstanceArn() pulumi.StringOutput { 163 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.ReplicationInstanceArn }).(pulumi.StringOutput) 164 } 165 166 // The Amazon Resource Name (ARN) for the replication task. 167 func (o LookupReplicationTaskResultOutput) ReplicationTaskArn() pulumi.StringOutput { 168 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.ReplicationTaskArn }).(pulumi.StringOutput) 169 } 170 171 func (o LookupReplicationTaskResultOutput) ReplicationTaskId() pulumi.StringOutput { 172 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.ReplicationTaskId }).(pulumi.StringOutput) 173 } 174 175 // 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). 176 func (o LookupReplicationTaskResultOutput) ReplicationTaskSettings() pulumi.StringOutput { 177 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.ReplicationTaskSettings }).(pulumi.StringOutput) 178 } 179 180 // The Amazon Resource Name (ARN) string that uniquely identifies the source endpoint. 181 func (o LookupReplicationTaskResultOutput) SourceEndpointArn() pulumi.StringOutput { 182 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.SourceEndpointArn }).(pulumi.StringOutput) 183 } 184 185 // Whether to run or stop the replication task. 186 func (o LookupReplicationTaskResultOutput) StartReplicationTask() pulumi.BoolOutput { 187 return o.ApplyT(func(v LookupReplicationTaskResult) bool { return v.StartReplicationTask }).(pulumi.BoolOutput) 188 } 189 190 // Replication Task status. 191 func (o LookupReplicationTaskResultOutput) Status() pulumi.StringOutput { 192 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.Status }).(pulumi.StringOutput) 193 } 194 195 // 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) 196 func (o LookupReplicationTaskResultOutput) TableMappings() pulumi.StringOutput { 197 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.TableMappings }).(pulumi.StringOutput) 198 } 199 200 func (o LookupReplicationTaskResultOutput) Tags() pulumi.StringMapOutput { 201 return o.ApplyT(func(v LookupReplicationTaskResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput) 202 } 203 204 // The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint. 205 func (o LookupReplicationTaskResultOutput) TargetEndpointArn() pulumi.StringOutput { 206 return o.ApplyT(func(v LookupReplicationTaskResult) string { return v.TargetEndpointArn }).(pulumi.StringOutput) 207 } 208 209 func init() { 210 pulumi.RegisterOutputType(LookupReplicationTaskResultOutput{}) 211 }