dts

package
v3.54.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConsumerChannel added in v3.11.0

type ConsumerChannel struct {
	pulumi.CustomResourceState

	// The ID of the consumer group.
	ConsumerGroupId pulumi.StringOutput `pulumi:"consumerGroupId"`
	// The name of the consumer group.
	ConsumerGroupName pulumi.StringOutput `pulumi:"consumerGroupName"`
	// The password of the consumer group account. The length of the `consumerGroupPassword` is limited to `8` to `32` characters. It can contain two or more of the following characters: uppercase letters, lowercase letters, digits, and special characters.
	ConsumerGroupPassword pulumi.StringOutput `pulumi:"consumerGroupPassword"`
	// The username of the consumer group. The length of the `consumerGroupUserName` is limited to `1` to `16` characters. It can contain one or more of the following characters: uppercase letters, lowercase letters, digits, and underscores (_).
	ConsumerGroupUserName pulumi.StringOutput `pulumi:"consumerGroupUserName"`
	// The ID of the subscription instance.
	DtsInstanceId pulumi.StringOutput `pulumi:"dtsInstanceId"`
}

Provides a DTS Consumer Channel resource.

For information about DTS Consumer Channel and how to use it, see [What is Consumer Channel](https://www.alibabacloud.com/help/en/doc-detail/264593.htm).

> **NOTE:** Available since v1.146.0.

## Example Usage

Basic Usage

```go package main

import (

"fmt"

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		example, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetZones, err := rds.GetZones(ctx, &rds.GetZonesArgs{
			Engine:                pulumi.StringRef("MySQL"),
			EngineVersion:         pulumi.StringRef("8.0"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
			Category:              pulumi.StringRef("Basic"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetInstanceClasses, err := rds.GetInstanceClasses(ctx, &rds.GetInstanceClassesArgs{
			ZoneId:                pulumi.StringRef(exampleGetZones.Zones[0].Id),
			Engine:                pulumi.StringRef("MySQL"),
			EngineVersion:         pulumi.StringRef("8.0"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
			Category:              pulumi.StringRef("Basic"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
		}, nil)
		if err != nil {
			return err
		}
		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
			VpcId:       exampleNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(exampleGetZones.Zones[0].Id),
			VswitchName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		exampleSecurityGroup, err := ecs.NewSecurityGroup(ctx, "example", &ecs.SecurityGroupArgs{
			Name:  pulumi.String(name),
			VpcId: exampleNetwork.ID(),
		})
		if err != nil {
			return err
		}
		exampleInstance, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			Engine:                pulumi.String("MySQL"),
			EngineVersion:         pulumi.String("8.0"),
			InstanceType:          pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].InstanceClass),
			InstanceStorage:       pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].StorageRange.Min),
			InstanceChargeType:    pulumi.String("Postpaid"),
			InstanceName:          pulumi.String(name),
			VswitchId:             exampleSwitch.ID(),
			MonitoringPeriod:      pulumi.Int(60),
			DbInstanceStorageType: pulumi.String("cloud_essd"),
			SecurityGroupIds: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
		})
		if err != nil {
			return err
		}
		exampleRdsAccount, err := rds.NewRdsAccount(ctx, "example", &rds.RdsAccountArgs{
			DbInstanceId:    exampleInstance.ID(),
			AccountName:     pulumi.String("example_name"),
			AccountPassword: pulumi.String("example_1234"),
		})
		if err != nil {
			return err
		}
		exampleDatabase, err := rds.NewDatabase(ctx, "example", &rds.DatabaseArgs{
			InstanceId: exampleInstance.ID(),
			Name:       pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewAccountPrivilege(ctx, "example", &rds.AccountPrivilegeArgs{
			InstanceId:  exampleInstance.ID(),
			AccountName: exampleRdsAccount.Name,
			Privilege:   pulumi.String("ReadWrite"),
			DbNames: pulumi.StringArray{
				exampleDatabase.Name,
			},
		})
		if err != nil {
			return err
		}
		exampleSubscriptionJob, err := dts.NewSubscriptionJob(ctx, "example", &dts.SubscriptionJobArgs{
			DtsJobName:                 pulumi.String(name),
			PaymentType:                pulumi.String("PayAsYouGo"),
			SourceEndpointEngineName:   pulumi.String("MySQL"),
			SourceEndpointRegion:       pulumi.String(example.Regions[0].Id),
			SourceEndpointInstanceType: pulumi.String("RDS"),
			SourceEndpointInstanceId:   exampleInstance.ID(),
			SourceEndpointDatabaseName: exampleDatabase.Name,
			SourceEndpointUserName:     exampleRdsAccount.AccountName,
			SourceEndpointPassword:     exampleRdsAccount.AccountPassword,
			DbList: pulumi.All(exampleDatabase.Name, exampleDatabase.Name).ApplyT(func(_args []interface{}) (string, error) {
				exampleDatabaseName := _args[0].(string)
				exampleDatabaseName1 := _args[1].(string)
				return fmt.Sprintf("{\"%v\":{\"name\":\"%v\",\"all\":true}}", exampleDatabaseName, exampleDatabaseName1), nil
			}).(pulumi.StringOutput),
			SubscriptionInstanceNetworkType: pulumi.String("vpc"),
			SubscriptionInstanceVpcId:       exampleNetwork.ID(),
			SubscriptionInstanceVswitchId:   exampleSwitch.ID(),
			Status:                          pulumi.String("Normal"),
		})
		if err != nil {
			return err
		}
		_, err = dts.NewConsumerChannel(ctx, "example", &dts.ConsumerChannelArgs{
			DtsInstanceId:         exampleSubscriptionJob.DtsInstanceId,
			ConsumerGroupName:     pulumi.String(name),
			ConsumerGroupUserName: pulumi.String("example"),
			ConsumerGroupPassword: pulumi.String("example1234"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

DTS Consumer Channel can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/consumerChannel:ConsumerChannel example <dts_instance_id>:<consumer_group_id> ```

func GetConsumerChannel added in v3.11.0

func GetConsumerChannel(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ConsumerChannelState, opts ...pulumi.ResourceOption) (*ConsumerChannel, error)

GetConsumerChannel gets an existing ConsumerChannel resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewConsumerChannel added in v3.11.0

func NewConsumerChannel(ctx *pulumi.Context,
	name string, args *ConsumerChannelArgs, opts ...pulumi.ResourceOption) (*ConsumerChannel, error)

NewConsumerChannel registers a new resource with the given unique name, arguments, and options.

func (*ConsumerChannel) ElementType added in v3.11.0

func (*ConsumerChannel) ElementType() reflect.Type

func (*ConsumerChannel) ToConsumerChannelOutput added in v3.11.0

func (i *ConsumerChannel) ToConsumerChannelOutput() ConsumerChannelOutput

func (*ConsumerChannel) ToConsumerChannelOutputWithContext added in v3.11.0

func (i *ConsumerChannel) ToConsumerChannelOutputWithContext(ctx context.Context) ConsumerChannelOutput

type ConsumerChannelArgs added in v3.11.0

type ConsumerChannelArgs struct {
	// The name of the consumer group.
	ConsumerGroupName pulumi.StringInput
	// The password of the consumer group account. The length of the `consumerGroupPassword` is limited to `8` to `32` characters. It can contain two or more of the following characters: uppercase letters, lowercase letters, digits, and special characters.
	ConsumerGroupPassword pulumi.StringInput
	// The username of the consumer group. The length of the `consumerGroupUserName` is limited to `1` to `16` characters. It can contain one or more of the following characters: uppercase letters, lowercase letters, digits, and underscores (_).
	ConsumerGroupUserName pulumi.StringInput
	// The ID of the subscription instance.
	DtsInstanceId pulumi.StringInput
}

The set of arguments for constructing a ConsumerChannel resource.

func (ConsumerChannelArgs) ElementType added in v3.11.0

func (ConsumerChannelArgs) ElementType() reflect.Type

type ConsumerChannelArray added in v3.11.0

type ConsumerChannelArray []ConsumerChannelInput

func (ConsumerChannelArray) ElementType added in v3.11.0

func (ConsumerChannelArray) ElementType() reflect.Type

func (ConsumerChannelArray) ToConsumerChannelArrayOutput added in v3.11.0

func (i ConsumerChannelArray) ToConsumerChannelArrayOutput() ConsumerChannelArrayOutput

func (ConsumerChannelArray) ToConsumerChannelArrayOutputWithContext added in v3.11.0

func (i ConsumerChannelArray) ToConsumerChannelArrayOutputWithContext(ctx context.Context) ConsumerChannelArrayOutput

type ConsumerChannelArrayInput added in v3.11.0

type ConsumerChannelArrayInput interface {
	pulumi.Input

	ToConsumerChannelArrayOutput() ConsumerChannelArrayOutput
	ToConsumerChannelArrayOutputWithContext(context.Context) ConsumerChannelArrayOutput
}

ConsumerChannelArrayInput is an input type that accepts ConsumerChannelArray and ConsumerChannelArrayOutput values. You can construct a concrete instance of `ConsumerChannelArrayInput` via:

ConsumerChannelArray{ ConsumerChannelArgs{...} }

type ConsumerChannelArrayOutput added in v3.11.0

type ConsumerChannelArrayOutput struct{ *pulumi.OutputState }

func (ConsumerChannelArrayOutput) ElementType added in v3.11.0

func (ConsumerChannelArrayOutput) ElementType() reflect.Type

func (ConsumerChannelArrayOutput) Index added in v3.11.0

func (ConsumerChannelArrayOutput) ToConsumerChannelArrayOutput added in v3.11.0

func (o ConsumerChannelArrayOutput) ToConsumerChannelArrayOutput() ConsumerChannelArrayOutput

func (ConsumerChannelArrayOutput) ToConsumerChannelArrayOutputWithContext added in v3.11.0

func (o ConsumerChannelArrayOutput) ToConsumerChannelArrayOutputWithContext(ctx context.Context) ConsumerChannelArrayOutput

type ConsumerChannelInput added in v3.11.0

type ConsumerChannelInput interface {
	pulumi.Input

	ToConsumerChannelOutput() ConsumerChannelOutput
	ToConsumerChannelOutputWithContext(ctx context.Context) ConsumerChannelOutput
}

type ConsumerChannelMap added in v3.11.0

type ConsumerChannelMap map[string]ConsumerChannelInput

func (ConsumerChannelMap) ElementType added in v3.11.0

func (ConsumerChannelMap) ElementType() reflect.Type

func (ConsumerChannelMap) ToConsumerChannelMapOutput added in v3.11.0

func (i ConsumerChannelMap) ToConsumerChannelMapOutput() ConsumerChannelMapOutput

func (ConsumerChannelMap) ToConsumerChannelMapOutputWithContext added in v3.11.0

func (i ConsumerChannelMap) ToConsumerChannelMapOutputWithContext(ctx context.Context) ConsumerChannelMapOutput

type ConsumerChannelMapInput added in v3.11.0

type ConsumerChannelMapInput interface {
	pulumi.Input

	ToConsumerChannelMapOutput() ConsumerChannelMapOutput
	ToConsumerChannelMapOutputWithContext(context.Context) ConsumerChannelMapOutput
}

ConsumerChannelMapInput is an input type that accepts ConsumerChannelMap and ConsumerChannelMapOutput values. You can construct a concrete instance of `ConsumerChannelMapInput` via:

ConsumerChannelMap{ "key": ConsumerChannelArgs{...} }

type ConsumerChannelMapOutput added in v3.11.0

type ConsumerChannelMapOutput struct{ *pulumi.OutputState }

func (ConsumerChannelMapOutput) ElementType added in v3.11.0

func (ConsumerChannelMapOutput) ElementType() reflect.Type

func (ConsumerChannelMapOutput) MapIndex added in v3.11.0

func (ConsumerChannelMapOutput) ToConsumerChannelMapOutput added in v3.11.0

func (o ConsumerChannelMapOutput) ToConsumerChannelMapOutput() ConsumerChannelMapOutput

func (ConsumerChannelMapOutput) ToConsumerChannelMapOutputWithContext added in v3.11.0

func (o ConsumerChannelMapOutput) ToConsumerChannelMapOutputWithContext(ctx context.Context) ConsumerChannelMapOutput

type ConsumerChannelOutput added in v3.11.0

type ConsumerChannelOutput struct{ *pulumi.OutputState }

func (ConsumerChannelOutput) ConsumerGroupId added in v3.27.0

func (o ConsumerChannelOutput) ConsumerGroupId() pulumi.StringOutput

The ID of the consumer group.

func (ConsumerChannelOutput) ConsumerGroupName added in v3.27.0

func (o ConsumerChannelOutput) ConsumerGroupName() pulumi.StringOutput

The name of the consumer group.

func (ConsumerChannelOutput) ConsumerGroupPassword added in v3.27.0

func (o ConsumerChannelOutput) ConsumerGroupPassword() pulumi.StringOutput

The password of the consumer group account. The length of the `consumerGroupPassword` is limited to `8` to `32` characters. It can contain two or more of the following characters: uppercase letters, lowercase letters, digits, and special characters.

func (ConsumerChannelOutput) ConsumerGroupUserName added in v3.27.0

func (o ConsumerChannelOutput) ConsumerGroupUserName() pulumi.StringOutput

The username of the consumer group. The length of the `consumerGroupUserName` is limited to `1` to `16` characters. It can contain one or more of the following characters: uppercase letters, lowercase letters, digits, and underscores (_).

func (ConsumerChannelOutput) DtsInstanceId added in v3.27.0

func (o ConsumerChannelOutput) DtsInstanceId() pulumi.StringOutput

The ID of the subscription instance.

func (ConsumerChannelOutput) ElementType added in v3.11.0

func (ConsumerChannelOutput) ElementType() reflect.Type

func (ConsumerChannelOutput) ToConsumerChannelOutput added in v3.11.0

func (o ConsumerChannelOutput) ToConsumerChannelOutput() ConsumerChannelOutput

func (ConsumerChannelOutput) ToConsumerChannelOutputWithContext added in v3.11.0

func (o ConsumerChannelOutput) ToConsumerChannelOutputWithContext(ctx context.Context) ConsumerChannelOutput

type ConsumerChannelState added in v3.11.0

type ConsumerChannelState struct {
	// The ID of the consumer group.
	ConsumerGroupId pulumi.StringPtrInput
	// The name of the consumer group.
	ConsumerGroupName pulumi.StringPtrInput
	// The password of the consumer group account. The length of the `consumerGroupPassword` is limited to `8` to `32` characters. It can contain two or more of the following characters: uppercase letters, lowercase letters, digits, and special characters.
	ConsumerGroupPassword pulumi.StringPtrInput
	// The username of the consumer group. The length of the `consumerGroupUserName` is limited to `1` to `16` characters. It can contain one or more of the following characters: uppercase letters, lowercase letters, digits, and underscores (_).
	ConsumerGroupUserName pulumi.StringPtrInput
	// The ID of the subscription instance.
	DtsInstanceId pulumi.StringPtrInput
}

func (ConsumerChannelState) ElementType added in v3.11.0

func (ConsumerChannelState) ElementType() reflect.Type

type GetConsumerChannelsArgs added in v3.11.0

type GetConsumerChannelsArgs struct {
	// Subscription instance ID.
	DtsInstanceId string `pulumi:"dtsInstanceId"`
	// A list of Consumer Channel IDs.
	Ids []string `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
}

A collection of arguments for invoking getConsumerChannels.

type GetConsumerChannelsChannel added in v3.11.0

type GetConsumerChannelsChannel struct {
	// The ID of the consumer group.
	ConsumerGroupId string `pulumi:"consumerGroupId"`
	// The name of the consumer group.
	ConsumerGroupName string `pulumi:"consumerGroupName"`
	// The username of the consumer group.
	ConsumerGroupUserName string `pulumi:"consumerGroupUserName"`
	// The time point when the client consumed the last message in the subscription channel.
	ConsumptionCheckpoint string `pulumi:"consumptionCheckpoint"`
	// The ID of the Consumer Channel.
	Id string `pulumi:"id"`
	// The message delay time, for the current time data subscription channel in the earliest time of unconsumed messages of the difference, in Unix timestamp format, which is measured in seconds.
	MessageDelay int `pulumi:"messageDelay"`
	// The total number of unconsumed messages.
	UnconsumedData int `pulumi:"unconsumedData"`
}

type GetConsumerChannelsChannelArgs added in v3.11.0

type GetConsumerChannelsChannelArgs struct {
	// The ID of the consumer group.
	ConsumerGroupId pulumi.StringInput `pulumi:"consumerGroupId"`
	// The name of the consumer group.
	ConsumerGroupName pulumi.StringInput `pulumi:"consumerGroupName"`
	// The username of the consumer group.
	ConsumerGroupUserName pulumi.StringInput `pulumi:"consumerGroupUserName"`
	// The time point when the client consumed the last message in the subscription channel.
	ConsumptionCheckpoint pulumi.StringInput `pulumi:"consumptionCheckpoint"`
	// The ID of the Consumer Channel.
	Id pulumi.StringInput `pulumi:"id"`
	// The message delay time, for the current time data subscription channel in the earliest time of unconsumed messages of the difference, in Unix timestamp format, which is measured in seconds.
	MessageDelay pulumi.IntInput `pulumi:"messageDelay"`
	// The total number of unconsumed messages.
	UnconsumedData pulumi.IntInput `pulumi:"unconsumedData"`
}

func (GetConsumerChannelsChannelArgs) ElementType added in v3.11.0

func (GetConsumerChannelsChannelArgs) ToGetConsumerChannelsChannelOutput added in v3.11.0

func (i GetConsumerChannelsChannelArgs) ToGetConsumerChannelsChannelOutput() GetConsumerChannelsChannelOutput

func (GetConsumerChannelsChannelArgs) ToGetConsumerChannelsChannelOutputWithContext added in v3.11.0

func (i GetConsumerChannelsChannelArgs) ToGetConsumerChannelsChannelOutputWithContext(ctx context.Context) GetConsumerChannelsChannelOutput

type GetConsumerChannelsChannelArray added in v3.11.0

type GetConsumerChannelsChannelArray []GetConsumerChannelsChannelInput

func (GetConsumerChannelsChannelArray) ElementType added in v3.11.0

func (GetConsumerChannelsChannelArray) ToGetConsumerChannelsChannelArrayOutput added in v3.11.0

func (i GetConsumerChannelsChannelArray) ToGetConsumerChannelsChannelArrayOutput() GetConsumerChannelsChannelArrayOutput

func (GetConsumerChannelsChannelArray) ToGetConsumerChannelsChannelArrayOutputWithContext added in v3.11.0

func (i GetConsumerChannelsChannelArray) ToGetConsumerChannelsChannelArrayOutputWithContext(ctx context.Context) GetConsumerChannelsChannelArrayOutput

type GetConsumerChannelsChannelArrayInput added in v3.11.0

type GetConsumerChannelsChannelArrayInput interface {
	pulumi.Input

	ToGetConsumerChannelsChannelArrayOutput() GetConsumerChannelsChannelArrayOutput
	ToGetConsumerChannelsChannelArrayOutputWithContext(context.Context) GetConsumerChannelsChannelArrayOutput
}

GetConsumerChannelsChannelArrayInput is an input type that accepts GetConsumerChannelsChannelArray and GetConsumerChannelsChannelArrayOutput values. You can construct a concrete instance of `GetConsumerChannelsChannelArrayInput` via:

GetConsumerChannelsChannelArray{ GetConsumerChannelsChannelArgs{...} }

type GetConsumerChannelsChannelArrayOutput added in v3.11.0

type GetConsumerChannelsChannelArrayOutput struct{ *pulumi.OutputState }

func (GetConsumerChannelsChannelArrayOutput) ElementType added in v3.11.0

func (GetConsumerChannelsChannelArrayOutput) Index added in v3.11.0

func (GetConsumerChannelsChannelArrayOutput) ToGetConsumerChannelsChannelArrayOutput added in v3.11.0

func (o GetConsumerChannelsChannelArrayOutput) ToGetConsumerChannelsChannelArrayOutput() GetConsumerChannelsChannelArrayOutput

func (GetConsumerChannelsChannelArrayOutput) ToGetConsumerChannelsChannelArrayOutputWithContext added in v3.11.0

func (o GetConsumerChannelsChannelArrayOutput) ToGetConsumerChannelsChannelArrayOutputWithContext(ctx context.Context) GetConsumerChannelsChannelArrayOutput

type GetConsumerChannelsChannelInput added in v3.11.0

type GetConsumerChannelsChannelInput interface {
	pulumi.Input

	ToGetConsumerChannelsChannelOutput() GetConsumerChannelsChannelOutput
	ToGetConsumerChannelsChannelOutputWithContext(context.Context) GetConsumerChannelsChannelOutput
}

GetConsumerChannelsChannelInput is an input type that accepts GetConsumerChannelsChannelArgs and GetConsumerChannelsChannelOutput values. You can construct a concrete instance of `GetConsumerChannelsChannelInput` via:

GetConsumerChannelsChannelArgs{...}

type GetConsumerChannelsChannelOutput added in v3.11.0

type GetConsumerChannelsChannelOutput struct{ *pulumi.OutputState }

func (GetConsumerChannelsChannelOutput) ConsumerGroupId added in v3.11.0

The ID of the consumer group.

func (GetConsumerChannelsChannelOutput) ConsumerGroupName added in v3.11.0

The name of the consumer group.

func (GetConsumerChannelsChannelOutput) ConsumerGroupUserName added in v3.11.0

func (o GetConsumerChannelsChannelOutput) ConsumerGroupUserName() pulumi.StringOutput

The username of the consumer group.

func (GetConsumerChannelsChannelOutput) ConsumptionCheckpoint added in v3.11.0

func (o GetConsumerChannelsChannelOutput) ConsumptionCheckpoint() pulumi.StringOutput

The time point when the client consumed the last message in the subscription channel.

func (GetConsumerChannelsChannelOutput) ElementType added in v3.11.0

func (GetConsumerChannelsChannelOutput) Id added in v3.11.0

The ID of the Consumer Channel.

func (GetConsumerChannelsChannelOutput) MessageDelay added in v3.11.0

The message delay time, for the current time data subscription channel in the earliest time of unconsumed messages of the difference, in Unix timestamp format, which is measured in seconds.

func (GetConsumerChannelsChannelOutput) ToGetConsumerChannelsChannelOutput added in v3.11.0

func (o GetConsumerChannelsChannelOutput) ToGetConsumerChannelsChannelOutput() GetConsumerChannelsChannelOutput

func (GetConsumerChannelsChannelOutput) ToGetConsumerChannelsChannelOutputWithContext added in v3.11.0

func (o GetConsumerChannelsChannelOutput) ToGetConsumerChannelsChannelOutputWithContext(ctx context.Context) GetConsumerChannelsChannelOutput

func (GetConsumerChannelsChannelOutput) UnconsumedData added in v3.11.0

The total number of unconsumed messages.

type GetConsumerChannelsOutputArgs added in v3.11.0

type GetConsumerChannelsOutputArgs struct {
	// Subscription instance ID.
	DtsInstanceId pulumi.StringInput `pulumi:"dtsInstanceId"`
	// A list of Consumer Channel IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
}

A collection of arguments for invoking getConsumerChannels.

func (GetConsumerChannelsOutputArgs) ElementType added in v3.11.0

type GetConsumerChannelsResult added in v3.11.0

type GetConsumerChannelsResult struct {
	Channels      []GetConsumerChannelsChannel `pulumi:"channels"`
	DtsInstanceId string                       `pulumi:"dtsInstanceId"`
	// The provider-assigned unique ID for this managed resource.
	Id         string   `pulumi:"id"`
	Ids        []string `pulumi:"ids"`
	OutputFile *string  `pulumi:"outputFile"`
}

A collection of values returned by getConsumerChannels.

func GetConsumerChannels added in v3.11.0

func GetConsumerChannels(ctx *pulumi.Context, args *GetConsumerChannelsArgs, opts ...pulumi.InvokeOption) (*GetConsumerChannelsResult, error)

This data source provides the Dts Consumer Channels of the current Alibaba Cloud user.

> **NOTE:** Available in v1.146.0+.

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := dts.GetConsumerChannels(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("dtsConsumerChannelId1", ids.Channels[0].Id)
		return nil
	})
}

```

type GetConsumerChannelsResultOutput added in v3.11.0

type GetConsumerChannelsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getConsumerChannels.

func GetConsumerChannelsOutput added in v3.11.0

func (GetConsumerChannelsResultOutput) Channels added in v3.11.0

func (GetConsumerChannelsResultOutput) DtsInstanceId added in v3.11.0

func (GetConsumerChannelsResultOutput) ElementType added in v3.11.0

func (GetConsumerChannelsResultOutput) Id added in v3.11.0

The provider-assigned unique ID for this managed resource.

func (GetConsumerChannelsResultOutput) Ids added in v3.11.0

func (GetConsumerChannelsResultOutput) OutputFile added in v3.11.0

func (GetConsumerChannelsResultOutput) ToGetConsumerChannelsResultOutput added in v3.11.0

func (o GetConsumerChannelsResultOutput) ToGetConsumerChannelsResultOutput() GetConsumerChannelsResultOutput

func (GetConsumerChannelsResultOutput) ToGetConsumerChannelsResultOutputWithContext added in v3.11.0

func (o GetConsumerChannelsResultOutput) ToGetConsumerChannelsResultOutputWithContext(ctx context.Context) GetConsumerChannelsResultOutput

type GetInstancesArgs added in v3.31.0

type GetInstancesArgs struct {
	// A list of Instance IDs.
	Ids []string `pulumi:"ids"`
	// A regex string to filter results by trail name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	PageNumber *int    `pulumi:"pageNumber"`
	PageSize   *int    `pulumi:"pageSize"`
	// Resource Group ID
	ResourceGroupId *string `pulumi:"resourceGroupId"`
}

A collection of arguments for invoking getInstances.

type GetInstancesInstance added in v3.31.0

type GetInstancesInstance struct {
	// Instance creation time
	CreateTime string `pulumi:"createTime"`
	// The target database engine type.
	DestinationEndpointEngineName string `pulumi:"destinationEndpointEngineName"`
	// The destination instance region.
	DestinationRegion string `pulumi:"destinationRegion"`
	// The ID of the subscription instance.
	DtsInstanceId string `pulumi:"dtsInstanceId"`
	// The ID of the instance.
	Id string `pulumi:"id"`
	// The type of the migration or synchronization instance.- The specifications of the migration instance: **xxlarge**, **xlarge**, **large**, **medium**, **small**.- The types of synchronization instances: **large**, **medium**, **small**, **micro**.
	InstanceClass string `pulumi:"instanceClass"`
	InstanceName  string `pulumi:"instanceName"`
	// The payment type of the resource.
	PaymentType string `pulumi:"paymentType"`
	// Resource Group ID
	ResourceGroupId string `pulumi:"resourceGroupId"`
	// Source instance database engine type.
	SourceEndpointEngineName string `pulumi:"sourceEndpointEngineName"`
	// The source instance region.
	SourceRegion string `pulumi:"sourceRegion"`
	// Instance status.
	Status string `pulumi:"status"`
	// The tag value corresponding to the tag key.
	Tags map[string]interface{} `pulumi:"tags"`
	// The instance type. Valid values: -**MIGRATION**: MIGRATION.-**SYNC**: synchronization.-**SUBSCRIBE**: SUBSCRIBE.
	Type string `pulumi:"type"`
}

type GetInstancesInstanceArgs added in v3.31.0

type GetInstancesInstanceArgs struct {
	// Instance creation time
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// The target database engine type.
	DestinationEndpointEngineName pulumi.StringInput `pulumi:"destinationEndpointEngineName"`
	// The destination instance region.
	DestinationRegion pulumi.StringInput `pulumi:"destinationRegion"`
	// The ID of the subscription instance.
	DtsInstanceId pulumi.StringInput `pulumi:"dtsInstanceId"`
	// The ID of the instance.
	Id pulumi.StringInput `pulumi:"id"`
	// The type of the migration or synchronization instance.- The specifications of the migration instance: **xxlarge**, **xlarge**, **large**, **medium**, **small**.- The types of synchronization instances: **large**, **medium**, **small**, **micro**.
	InstanceClass pulumi.StringInput `pulumi:"instanceClass"`
	InstanceName  pulumi.StringInput `pulumi:"instanceName"`
	// The payment type of the resource.
	PaymentType pulumi.StringInput `pulumi:"paymentType"`
	// Resource Group ID
	ResourceGroupId pulumi.StringInput `pulumi:"resourceGroupId"`
	// Source instance database engine type.
	SourceEndpointEngineName pulumi.StringInput `pulumi:"sourceEndpointEngineName"`
	// The source instance region.
	SourceRegion pulumi.StringInput `pulumi:"sourceRegion"`
	// Instance status.
	Status pulumi.StringInput `pulumi:"status"`
	// The tag value corresponding to the tag key.
	Tags pulumi.MapInput `pulumi:"tags"`
	// The instance type. Valid values: -**MIGRATION**: MIGRATION.-**SYNC**: synchronization.-**SUBSCRIBE**: SUBSCRIBE.
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetInstancesInstanceArgs) ElementType added in v3.31.0

func (GetInstancesInstanceArgs) ElementType() reflect.Type

func (GetInstancesInstanceArgs) ToGetInstancesInstanceOutput added in v3.31.0

func (i GetInstancesInstanceArgs) ToGetInstancesInstanceOutput() GetInstancesInstanceOutput

func (GetInstancesInstanceArgs) ToGetInstancesInstanceOutputWithContext added in v3.31.0

func (i GetInstancesInstanceArgs) ToGetInstancesInstanceOutputWithContext(ctx context.Context) GetInstancesInstanceOutput

type GetInstancesInstanceArray added in v3.31.0

type GetInstancesInstanceArray []GetInstancesInstanceInput

func (GetInstancesInstanceArray) ElementType added in v3.31.0

func (GetInstancesInstanceArray) ElementType() reflect.Type

func (GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutput added in v3.31.0

func (i GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutput() GetInstancesInstanceArrayOutput

func (GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutputWithContext added in v3.31.0

func (i GetInstancesInstanceArray) ToGetInstancesInstanceArrayOutputWithContext(ctx context.Context) GetInstancesInstanceArrayOutput

type GetInstancesInstanceArrayInput added in v3.31.0

type GetInstancesInstanceArrayInput interface {
	pulumi.Input

	ToGetInstancesInstanceArrayOutput() GetInstancesInstanceArrayOutput
	ToGetInstancesInstanceArrayOutputWithContext(context.Context) GetInstancesInstanceArrayOutput
}

GetInstancesInstanceArrayInput is an input type that accepts GetInstancesInstanceArray and GetInstancesInstanceArrayOutput values. You can construct a concrete instance of `GetInstancesInstanceArrayInput` via:

GetInstancesInstanceArray{ GetInstancesInstanceArgs{...} }

type GetInstancesInstanceArrayOutput added in v3.31.0

type GetInstancesInstanceArrayOutput struct{ *pulumi.OutputState }

func (GetInstancesInstanceArrayOutput) ElementType added in v3.31.0

func (GetInstancesInstanceArrayOutput) Index added in v3.31.0

func (GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutput added in v3.31.0

func (o GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutput() GetInstancesInstanceArrayOutput

func (GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutputWithContext added in v3.31.0

func (o GetInstancesInstanceArrayOutput) ToGetInstancesInstanceArrayOutputWithContext(ctx context.Context) GetInstancesInstanceArrayOutput

type GetInstancesInstanceInput added in v3.31.0

type GetInstancesInstanceInput interface {
	pulumi.Input

	ToGetInstancesInstanceOutput() GetInstancesInstanceOutput
	ToGetInstancesInstanceOutputWithContext(context.Context) GetInstancesInstanceOutput
}

GetInstancesInstanceInput is an input type that accepts GetInstancesInstanceArgs and GetInstancesInstanceOutput values. You can construct a concrete instance of `GetInstancesInstanceInput` via:

GetInstancesInstanceArgs{...}

type GetInstancesInstanceOutput added in v3.31.0

type GetInstancesInstanceOutput struct{ *pulumi.OutputState }

func (GetInstancesInstanceOutput) CreateTime added in v3.31.0

Instance creation time

func (GetInstancesInstanceOutput) DestinationEndpointEngineName added in v3.31.0

func (o GetInstancesInstanceOutput) DestinationEndpointEngineName() pulumi.StringOutput

The target database engine type.

func (GetInstancesInstanceOutput) DestinationRegion added in v3.31.0

func (o GetInstancesInstanceOutput) DestinationRegion() pulumi.StringOutput

The destination instance region.

func (GetInstancesInstanceOutput) DtsInstanceId added in v3.31.0

The ID of the subscription instance.

func (GetInstancesInstanceOutput) ElementType added in v3.31.0

func (GetInstancesInstanceOutput) ElementType() reflect.Type

func (GetInstancesInstanceOutput) Id added in v3.31.0

The ID of the instance.

func (GetInstancesInstanceOutput) InstanceClass added in v3.31.0

The type of the migration or synchronization instance.- The specifications of the migration instance: **xxlarge**, **xlarge**, **large**, **medium**, **small**.- The types of synchronization instances: **large**, **medium**, **small**, **micro**.

func (GetInstancesInstanceOutput) InstanceName added in v3.31.0

func (GetInstancesInstanceOutput) PaymentType added in v3.31.0

The payment type of the resource.

func (GetInstancesInstanceOutput) ResourceGroupId added in v3.31.0

func (o GetInstancesInstanceOutput) ResourceGroupId() pulumi.StringOutput

Resource Group ID

func (GetInstancesInstanceOutput) SourceEndpointEngineName added in v3.31.0

func (o GetInstancesInstanceOutput) SourceEndpointEngineName() pulumi.StringOutput

Source instance database engine type.

func (GetInstancesInstanceOutput) SourceRegion added in v3.31.0

The source instance region.

func (GetInstancesInstanceOutput) Status added in v3.31.0

Instance status.

func (GetInstancesInstanceOutput) Tags added in v3.31.0

The tag value corresponding to the tag key.

func (GetInstancesInstanceOutput) ToGetInstancesInstanceOutput added in v3.31.0

func (o GetInstancesInstanceOutput) ToGetInstancesInstanceOutput() GetInstancesInstanceOutput

func (GetInstancesInstanceOutput) ToGetInstancesInstanceOutputWithContext added in v3.31.0

func (o GetInstancesInstanceOutput) ToGetInstancesInstanceOutputWithContext(ctx context.Context) GetInstancesInstanceOutput

func (GetInstancesInstanceOutput) Type added in v3.31.0

The instance type. Valid values: -**MIGRATION**: MIGRATION.-**SYNC**: synchronization.-**SUBSCRIBE**: SUBSCRIBE.

type GetInstancesOutputArgs added in v3.31.0

type GetInstancesOutputArgs struct {
	// A list of Instance IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// A regex string to filter results by trail name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	PageNumber pulumi.IntPtrInput    `pulumi:"pageNumber"`
	PageSize   pulumi.IntPtrInput    `pulumi:"pageSize"`
	// Resource Group ID
	ResourceGroupId pulumi.StringPtrInput `pulumi:"resourceGroupId"`
}

A collection of arguments for invoking getInstances.

func (GetInstancesOutputArgs) ElementType added in v3.31.0

func (GetInstancesOutputArgs) ElementType() reflect.Type

type GetInstancesResult added in v3.31.0

type GetInstancesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// A list of Instance IDs.
	Ids []string `pulumi:"ids"`
	// A list of Instance Entries. Each element contains the following attributes:
	Instances []GetInstancesInstance `pulumi:"instances"`
	NameRegex *string                `pulumi:"nameRegex"`
	// A list of Instance names.
	Names      []string `pulumi:"names"`
	OutputFile *string  `pulumi:"outputFile"`
	PageNumber *int     `pulumi:"pageNumber"`
	PageSize   *int     `pulumi:"pageSize"`
	// Resource Group ID.
	ResourceGroupId *string `pulumi:"resourceGroupId"`
}

A collection of values returned by getInstances.

func GetInstances added in v3.31.0

func GetInstances(ctx *pulumi.Context, args *GetInstancesArgs, opts ...pulumi.InvokeOption) (*GetInstancesResult, error)

This data source provides Dts Instance available to the user.[What is Instance](https://www.alibabacloud.com/help/en/data-transmission-service/latest/createdtsinstance)

> **NOTE:** Available in 1.198.0+

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) func main() { pulumi.Run(func(ctx *pulumi.Context) error { _default, err := dts.GetInstances(ctx, &dts.GetInstancesArgs{ Ids: interface{}{ defaultAlicloudDtsInstance.Id, }, ResourceGroupId: pulumi.StringRef("example_value"), }, nil); if err != nil { return err } ctx.Export("alicloudDtsInstanceExampleId", _default.Instances[0].Id) return nil }) } ```

type GetInstancesResultOutput added in v3.31.0

type GetInstancesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getInstances.

func GetInstancesOutput added in v3.31.0

func GetInstancesOutput(ctx *pulumi.Context, args GetInstancesOutputArgs, opts ...pulumi.InvokeOption) GetInstancesResultOutput

func (GetInstancesResultOutput) ElementType added in v3.31.0

func (GetInstancesResultOutput) ElementType() reflect.Type

func (GetInstancesResultOutput) Id added in v3.31.0

The provider-assigned unique ID for this managed resource.

func (GetInstancesResultOutput) Ids added in v3.31.0

A list of Instance IDs.

func (GetInstancesResultOutput) Instances added in v3.31.0

A list of Instance Entries. Each element contains the following attributes:

func (GetInstancesResultOutput) NameRegex added in v3.31.0

func (GetInstancesResultOutput) Names added in v3.31.0

A list of Instance names.

func (GetInstancesResultOutput) OutputFile added in v3.31.0

func (GetInstancesResultOutput) PageNumber added in v3.31.0

func (GetInstancesResultOutput) PageSize added in v3.31.0

func (GetInstancesResultOutput) ResourceGroupId added in v3.31.0

func (o GetInstancesResultOutput) ResourceGroupId() pulumi.StringPtrOutput

Resource Group ID.

func (GetInstancesResultOutput) ToGetInstancesResultOutput added in v3.31.0

func (o GetInstancesResultOutput) ToGetInstancesResultOutput() GetInstancesResultOutput

func (GetInstancesResultOutput) ToGetInstancesResultOutputWithContext added in v3.31.0

func (o GetInstancesResultOutput) ToGetInstancesResultOutputWithContext(ctx context.Context) GetInstancesResultOutput

type GetMigrationJobsArgs added in v3.19.0

type GetMigrationJobsArgs struct {
	// Default to `false`. Set it to `true` can output more details about resource attributes.
	EnableDetails *bool `pulumi:"enableDetails"`
	// A list of Synchronization Job IDs.
	Ids []string `pulumi:"ids"`
	// A regex string to filter results by Migration Job name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
}

A collection of arguments for invoking getMigrationJobs.

type GetMigrationJobsJob added in v3.19.0

type GetMigrationJobsJob struct {
	// Whether or not to execute DTS supports schema migration, full data migration, or full-data initialization.
	DataInitialization bool `pulumi:"dataInitialization"`
	// Whether to perform incremental data migration for migration types or synchronization values include:
	DataSynchronization bool `pulumi:"dataSynchronization"`
	// The Migration object, in the format of JSON strings.
	DbList string `pulumi:"dbList"`
	// The name of migrate the database.
	DestinationEndpointDataBaseName string `pulumi:"destinationEndpointDataBaseName"`
	// The type of destination database.
	DestinationEndpointEngineName string `pulumi:"destinationEndpointEngineName"`
	// The ID of destination instance.
	DestinationEndpointInstanceId string `pulumi:"destinationEndpointInstanceId"`
	// The type of destination instance.
	DestinationEndpointInstanceType string `pulumi:"destinationEndpointInstanceType"`
	// The ip of source endpoint.
	DestinationEndpointIp string `pulumi:"destinationEndpointIp"`
	// The SID of Oracle database.
	DestinationEndpointOracleSid string `pulumi:"destinationEndpointOracleSid"`
	// The port of source endpoint.
	DestinationEndpointPort string `pulumi:"destinationEndpointPort"`
	// The region of destination instance.
	DestinationEndpointRegion string `pulumi:"destinationEndpointRegion"`
	// The username of database account.
	DestinationEndpointUserName string `pulumi:"destinationEndpointUserName"`
	// The Migration instance ID. The ID of `dts.MigrationInstance`.
	DtsInstanceId string `pulumi:"dtsInstanceId"`
	// The ID of the Migration Job.
	DtsJobId string `pulumi:"dtsJobId"`
	// The name of synchronization job.
	DtsJobName string `pulumi:"dtsJobName"`
	// The ID of the Migration Job. Its value is same as `dtsJobId`.
	Id string `pulumi:"id"`
	// The payment type of the Migration Instance.
	PaymentType string `pulumi:"paymentType"`
	// The name of migrate the database.
	SourceEndpointDatabaseName string `pulumi:"sourceEndpointDatabaseName"`
	// The type of source database.
	SourceEndpointEngineName string `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance.
	SourceEndpointInstanceId string `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance.
	SourceEndpointInstanceType string `pulumi:"sourceEndpointInstanceType"`
	// The ip of source endpoint.
	SourceEndpointIp string `pulumi:"sourceEndpointIp"`
	// The SID of Oracle database.
	SourceEndpointOracleSid string `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs.
	SourceEndpointOwnerId string `pulumi:"sourceEndpointOwnerId"`
	// The port of source endpoint.
	SourceEndpointPort string `pulumi:"sourceEndpointPort"`
	// The region of source instance.
	SourceEndpointRegion string `pulumi:"sourceEndpointRegion"`
	// The name of the role configured for the cloud account to which the source instance belongs.
	SourceEndpointRole string `pulumi:"sourceEndpointRole"`
	// The username of database account.
	SourceEndpointUserName string `pulumi:"sourceEndpointUserName"`
	// The status of the resource.
	Status string `pulumi:"status"`
	// Whether to perform a database table structure to migrate or initialization.
	StructureInitialization bool `pulumi:"structureInitialization"`
}

type GetMigrationJobsJobArgs added in v3.19.0

type GetMigrationJobsJobArgs struct {
	// Whether or not to execute DTS supports schema migration, full data migration, or full-data initialization.
	DataInitialization pulumi.BoolInput `pulumi:"dataInitialization"`
	// Whether to perform incremental data migration for migration types or synchronization values include:
	DataSynchronization pulumi.BoolInput `pulumi:"dataSynchronization"`
	// The Migration object, in the format of JSON strings.
	DbList pulumi.StringInput `pulumi:"dbList"`
	// The name of migrate the database.
	DestinationEndpointDataBaseName pulumi.StringInput `pulumi:"destinationEndpointDataBaseName"`
	// The type of destination database.
	DestinationEndpointEngineName pulumi.StringInput `pulumi:"destinationEndpointEngineName"`
	// The ID of destination instance.
	DestinationEndpointInstanceId pulumi.StringInput `pulumi:"destinationEndpointInstanceId"`
	// The type of destination instance.
	DestinationEndpointInstanceType pulumi.StringInput `pulumi:"destinationEndpointInstanceType"`
	// The ip of source endpoint.
	DestinationEndpointIp pulumi.StringInput `pulumi:"destinationEndpointIp"`
	// The SID of Oracle database.
	DestinationEndpointOracleSid pulumi.StringInput `pulumi:"destinationEndpointOracleSid"`
	// The port of source endpoint.
	DestinationEndpointPort pulumi.StringInput `pulumi:"destinationEndpointPort"`
	// The region of destination instance.
	DestinationEndpointRegion pulumi.StringInput `pulumi:"destinationEndpointRegion"`
	// The username of database account.
	DestinationEndpointUserName pulumi.StringInput `pulumi:"destinationEndpointUserName"`
	// The Migration instance ID. The ID of `dts.MigrationInstance`.
	DtsInstanceId pulumi.StringInput `pulumi:"dtsInstanceId"`
	// The ID of the Migration Job.
	DtsJobId pulumi.StringInput `pulumi:"dtsJobId"`
	// The name of synchronization job.
	DtsJobName pulumi.StringInput `pulumi:"dtsJobName"`
	// The ID of the Migration Job. Its value is same as `dtsJobId`.
	Id pulumi.StringInput `pulumi:"id"`
	// The payment type of the Migration Instance.
	PaymentType pulumi.StringInput `pulumi:"paymentType"`
	// The name of migrate the database.
	SourceEndpointDatabaseName pulumi.StringInput `pulumi:"sourceEndpointDatabaseName"`
	// The type of source database.
	SourceEndpointEngineName pulumi.StringInput `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance.
	SourceEndpointInstanceId pulumi.StringInput `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance.
	SourceEndpointInstanceType pulumi.StringInput `pulumi:"sourceEndpointInstanceType"`
	// The ip of source endpoint.
	SourceEndpointIp pulumi.StringInput `pulumi:"sourceEndpointIp"`
	// The SID of Oracle database.
	SourceEndpointOracleSid pulumi.StringInput `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs.
	SourceEndpointOwnerId pulumi.StringInput `pulumi:"sourceEndpointOwnerId"`
	// The port of source endpoint.
	SourceEndpointPort pulumi.StringInput `pulumi:"sourceEndpointPort"`
	// The region of source instance.
	SourceEndpointRegion pulumi.StringInput `pulumi:"sourceEndpointRegion"`
	// The name of the role configured for the cloud account to which the source instance belongs.
	SourceEndpointRole pulumi.StringInput `pulumi:"sourceEndpointRole"`
	// The username of database account.
	SourceEndpointUserName pulumi.StringInput `pulumi:"sourceEndpointUserName"`
	// The status of the resource.
	Status pulumi.StringInput `pulumi:"status"`
	// Whether to perform a database table structure to migrate or initialization.
	StructureInitialization pulumi.BoolInput `pulumi:"structureInitialization"`
}

func (GetMigrationJobsJobArgs) ElementType added in v3.19.0

func (GetMigrationJobsJobArgs) ElementType() reflect.Type

func (GetMigrationJobsJobArgs) ToGetMigrationJobsJobOutput added in v3.19.0

func (i GetMigrationJobsJobArgs) ToGetMigrationJobsJobOutput() GetMigrationJobsJobOutput

func (GetMigrationJobsJobArgs) ToGetMigrationJobsJobOutputWithContext added in v3.19.0

func (i GetMigrationJobsJobArgs) ToGetMigrationJobsJobOutputWithContext(ctx context.Context) GetMigrationJobsJobOutput

type GetMigrationJobsJobArray added in v3.19.0

type GetMigrationJobsJobArray []GetMigrationJobsJobInput

func (GetMigrationJobsJobArray) ElementType added in v3.19.0

func (GetMigrationJobsJobArray) ElementType() reflect.Type

func (GetMigrationJobsJobArray) ToGetMigrationJobsJobArrayOutput added in v3.19.0

func (i GetMigrationJobsJobArray) ToGetMigrationJobsJobArrayOutput() GetMigrationJobsJobArrayOutput

func (GetMigrationJobsJobArray) ToGetMigrationJobsJobArrayOutputWithContext added in v3.19.0

func (i GetMigrationJobsJobArray) ToGetMigrationJobsJobArrayOutputWithContext(ctx context.Context) GetMigrationJobsJobArrayOutput

type GetMigrationJobsJobArrayInput added in v3.19.0

type GetMigrationJobsJobArrayInput interface {
	pulumi.Input

	ToGetMigrationJobsJobArrayOutput() GetMigrationJobsJobArrayOutput
	ToGetMigrationJobsJobArrayOutputWithContext(context.Context) GetMigrationJobsJobArrayOutput
}

GetMigrationJobsJobArrayInput is an input type that accepts GetMigrationJobsJobArray and GetMigrationJobsJobArrayOutput values. You can construct a concrete instance of `GetMigrationJobsJobArrayInput` via:

GetMigrationJobsJobArray{ GetMigrationJobsJobArgs{...} }

type GetMigrationJobsJobArrayOutput added in v3.19.0

type GetMigrationJobsJobArrayOutput struct{ *pulumi.OutputState }

func (GetMigrationJobsJobArrayOutput) ElementType added in v3.19.0

func (GetMigrationJobsJobArrayOutput) Index added in v3.19.0

func (GetMigrationJobsJobArrayOutput) ToGetMigrationJobsJobArrayOutput added in v3.19.0

func (o GetMigrationJobsJobArrayOutput) ToGetMigrationJobsJobArrayOutput() GetMigrationJobsJobArrayOutput

func (GetMigrationJobsJobArrayOutput) ToGetMigrationJobsJobArrayOutputWithContext added in v3.19.0

func (o GetMigrationJobsJobArrayOutput) ToGetMigrationJobsJobArrayOutputWithContext(ctx context.Context) GetMigrationJobsJobArrayOutput

type GetMigrationJobsJobInput added in v3.19.0

type GetMigrationJobsJobInput interface {
	pulumi.Input

	ToGetMigrationJobsJobOutput() GetMigrationJobsJobOutput
	ToGetMigrationJobsJobOutputWithContext(context.Context) GetMigrationJobsJobOutput
}

GetMigrationJobsJobInput is an input type that accepts GetMigrationJobsJobArgs and GetMigrationJobsJobOutput values. You can construct a concrete instance of `GetMigrationJobsJobInput` via:

GetMigrationJobsJobArgs{...}

type GetMigrationJobsJobOutput added in v3.19.0

type GetMigrationJobsJobOutput struct{ *pulumi.OutputState }

func (GetMigrationJobsJobOutput) DataInitialization added in v3.19.0

func (o GetMigrationJobsJobOutput) DataInitialization() pulumi.BoolOutput

Whether or not to execute DTS supports schema migration, full data migration, or full-data initialization.

func (GetMigrationJobsJobOutput) DataSynchronization added in v3.19.0

func (o GetMigrationJobsJobOutput) DataSynchronization() pulumi.BoolOutput

Whether to perform incremental data migration for migration types or synchronization values include:

func (GetMigrationJobsJobOutput) DbList added in v3.19.0

The Migration object, in the format of JSON strings.

func (GetMigrationJobsJobOutput) DestinationEndpointDataBaseName added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointDataBaseName() pulumi.StringOutput

The name of migrate the database.

func (GetMigrationJobsJobOutput) DestinationEndpointEngineName added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointEngineName() pulumi.StringOutput

The type of destination database.

func (GetMigrationJobsJobOutput) DestinationEndpointInstanceId added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointInstanceId() pulumi.StringOutput

The ID of destination instance.

func (GetMigrationJobsJobOutput) DestinationEndpointInstanceType added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointInstanceType() pulumi.StringOutput

The type of destination instance.

func (GetMigrationJobsJobOutput) DestinationEndpointIp added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointIp() pulumi.StringOutput

The ip of source endpoint.

func (GetMigrationJobsJobOutput) DestinationEndpointOracleSid added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointOracleSid() pulumi.StringOutput

The SID of Oracle database.

func (GetMigrationJobsJobOutput) DestinationEndpointPort added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointPort() pulumi.StringOutput

The port of source endpoint.

func (GetMigrationJobsJobOutput) DestinationEndpointRegion added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointRegion() pulumi.StringOutput

The region of destination instance.

func (GetMigrationJobsJobOutput) DestinationEndpointUserName added in v3.19.0

func (o GetMigrationJobsJobOutput) DestinationEndpointUserName() pulumi.StringOutput

The username of database account.

func (GetMigrationJobsJobOutput) DtsInstanceId added in v3.19.0

func (o GetMigrationJobsJobOutput) DtsInstanceId() pulumi.StringOutput

The Migration instance ID. The ID of `dts.MigrationInstance`.

func (GetMigrationJobsJobOutput) DtsJobId added in v3.19.0

The ID of the Migration Job.

func (GetMigrationJobsJobOutput) DtsJobName added in v3.19.0

The name of synchronization job.

func (GetMigrationJobsJobOutput) ElementType added in v3.19.0

func (GetMigrationJobsJobOutput) ElementType() reflect.Type

func (GetMigrationJobsJobOutput) Id added in v3.19.0

The ID of the Migration Job. Its value is same as `dtsJobId`.

func (GetMigrationJobsJobOutput) PaymentType added in v3.19.0

The payment type of the Migration Instance.

func (GetMigrationJobsJobOutput) SourceEndpointDatabaseName added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointDatabaseName() pulumi.StringOutput

The name of migrate the database.

func (GetMigrationJobsJobOutput) SourceEndpointEngineName added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointEngineName() pulumi.StringOutput

The type of source database.

func (GetMigrationJobsJobOutput) SourceEndpointInstanceId added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointInstanceId() pulumi.StringOutput

The ID of source instance.

func (GetMigrationJobsJobOutput) SourceEndpointInstanceType added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointInstanceType() pulumi.StringOutput

The type of source instance.

func (GetMigrationJobsJobOutput) SourceEndpointIp added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointIp() pulumi.StringOutput

The ip of source endpoint.

func (GetMigrationJobsJobOutput) SourceEndpointOracleSid added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointOracleSid() pulumi.StringOutput

The SID of Oracle database.

func (GetMigrationJobsJobOutput) SourceEndpointOwnerId added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointOwnerId() pulumi.StringOutput

The Alibaba Cloud account ID to which the source instance belongs.

func (GetMigrationJobsJobOutput) SourceEndpointPort added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointPort() pulumi.StringOutput

The port of source endpoint.

func (GetMigrationJobsJobOutput) SourceEndpointRegion added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointRegion() pulumi.StringOutput

The region of source instance.

func (GetMigrationJobsJobOutput) SourceEndpointRole added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointRole() pulumi.StringOutput

The name of the role configured for the cloud account to which the source instance belongs.

func (GetMigrationJobsJobOutput) SourceEndpointUserName added in v3.19.0

func (o GetMigrationJobsJobOutput) SourceEndpointUserName() pulumi.StringOutput

The username of database account.

func (GetMigrationJobsJobOutput) Status added in v3.19.0

The status of the resource.

func (GetMigrationJobsJobOutput) StructureInitialization added in v3.19.0

func (o GetMigrationJobsJobOutput) StructureInitialization() pulumi.BoolOutput

Whether to perform a database table structure to migrate or initialization.

func (GetMigrationJobsJobOutput) ToGetMigrationJobsJobOutput added in v3.19.0

func (o GetMigrationJobsJobOutput) ToGetMigrationJobsJobOutput() GetMigrationJobsJobOutput

func (GetMigrationJobsJobOutput) ToGetMigrationJobsJobOutputWithContext added in v3.19.0

func (o GetMigrationJobsJobOutput) ToGetMigrationJobsJobOutputWithContext(ctx context.Context) GetMigrationJobsJobOutput

type GetMigrationJobsOutputArgs added in v3.19.0

type GetMigrationJobsOutputArgs struct {
	// Default to `false`. Set it to `true` can output more details about resource attributes.
	EnableDetails pulumi.BoolPtrInput `pulumi:"enableDetails"`
	// A list of Synchronization Job IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// A regex string to filter results by Migration Job name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
}

A collection of arguments for invoking getMigrationJobs.

func (GetMigrationJobsOutputArgs) ElementType added in v3.19.0

func (GetMigrationJobsOutputArgs) ElementType() reflect.Type

type GetMigrationJobsResult added in v3.19.0

type GetMigrationJobsResult struct {
	EnableDetails *bool `pulumi:"enableDetails"`
	// The provider-assigned unique ID for this managed resource.
	Id         string                `pulumi:"id"`
	Ids        []string              `pulumi:"ids"`
	Jobs       []GetMigrationJobsJob `pulumi:"jobs"`
	NameRegex  *string               `pulumi:"nameRegex"`
	Names      []string              `pulumi:"names"`
	OutputFile *string               `pulumi:"outputFile"`
}

A collection of values returned by getMigrationJobs.

func GetMigrationJobs added in v3.19.0

func GetMigrationJobs(ctx *pulumi.Context, args *GetMigrationJobsArgs, opts ...pulumi.InvokeOption) (*GetMigrationJobsResult, error)

This data source provides the Dts Migration Jobs of the current Alibaba Cloud user.

> **NOTE:** Available in v1.157.0+.

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := dts.GetMigrationJobs(ctx, &dts.GetMigrationJobsArgs{
			Ids: []string{
				"dts_job_id",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dtsMigrationJobId1", ids.Jobs[0].Id)
		return nil
	})
}

```

type GetMigrationJobsResultOutput added in v3.19.0

type GetMigrationJobsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getMigrationJobs.

func GetMigrationJobsOutput added in v3.19.0

func (GetMigrationJobsResultOutput) ElementType added in v3.19.0

func (GetMigrationJobsResultOutput) EnableDetails added in v3.19.0

func (GetMigrationJobsResultOutput) Id added in v3.19.0

The provider-assigned unique ID for this managed resource.

func (GetMigrationJobsResultOutput) Ids added in v3.19.0

func (GetMigrationJobsResultOutput) Jobs added in v3.19.0

func (GetMigrationJobsResultOutput) NameRegex added in v3.19.0

func (GetMigrationJobsResultOutput) Names added in v3.19.0

func (GetMigrationJobsResultOutput) OutputFile added in v3.19.0

func (GetMigrationJobsResultOutput) ToGetMigrationJobsResultOutput added in v3.19.0

func (o GetMigrationJobsResultOutput) ToGetMigrationJobsResultOutput() GetMigrationJobsResultOutput

func (GetMigrationJobsResultOutput) ToGetMigrationJobsResultOutputWithContext added in v3.19.0

func (o GetMigrationJobsResultOutput) ToGetMigrationJobsResultOutputWithContext(ctx context.Context) GetMigrationJobsResultOutput

type GetSubscriptionJobsArgs

type GetSubscriptionJobsArgs struct {
	EnableDetails *bool `pulumi:"enableDetails"`
	// A list of Subscription Job IDs.
	Ids []string `pulumi:"ids"`
	// A regex string to filter results by subscription job name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The status of the task. Valid values: `NotStarted`, `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state of `Normal` to start the job, and specify this state of `Abnormal` to stop the job.
	Status *string `pulumi:"status"`
	// The tag of the resource.
	Tags map[string]interface{} `pulumi:"tags"`
}

A collection of arguments for invoking getSubscriptionJobs.

type GetSubscriptionJobsJob

type GetSubscriptionJobsJob struct {
	// Subscription start time in Unix timestamp format.
	Checkpoint string `pulumi:"checkpoint"`
	// The creation time of subscription job instance.
	CreateTime string `pulumi:"createTime"`
	// Subscription object, in the format of JSON strings.
	DbList string `pulumi:"dbList"`
	// The ID of subscription job instance.
	DtsInstanceId string `pulumi:"dtsInstanceId"`
	// The ID of subscription job instance.
	DtsJobId string `pulumi:"dtsJobId"`
	// The name of subscription job instance.
	DtsJobName string `pulumi:"dtsJobName"`
	// The Expiration Time. Formatting with yyyy-MM-ddTHH:mm:ssZ(UTC time).
	ExpireTime string `pulumi:"expireTime"`
	// The ID of the Subscription Job.
	Id string `pulumi:"id"`
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType string `pulumi:"paymentType"`
	// To subscribe to the name of the database.
	SourceEndpointDatabaseName string `pulumi:"sourceEndpointDatabaseName"`
	// The source database type value is MySQL or Oracle.
	SourceEndpointEngineName string `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
	SourceEndpointInstanceId string `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance. Valid values: `RDS`, `PolarDB`, `DRDS`, `LocalInstance`, `ECS`, `Express`, `CEN`, `dg`.
	SourceEndpointInstanceType string `pulumi:"sourceEndpointInstanceType"`
	// The IP of source endpoint.
	SourceEndpointIp string `pulumi:"sourceEndpointIp"`
	// The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid string `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
	SourceEndpointOwnerId string `pulumi:"sourceEndpointOwnerId"`
	// The  port of source database.
	SourceEndpointPort string `pulumi:"sourceEndpointPort"`
	// The region of source database.
	SourceEndpointRegion string `pulumi:"sourceEndpointRegion"`
	// Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
	SourceEndpointRole string `pulumi:"sourceEndpointRole"`
	// The username of source database instance account.
	SourceEndpointUserName string `pulumi:"sourceEndpointUserName"`
	// The status of the task. Valid values: `NotStarted`, `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state of `Normal` to start the job, and specify this state of `Abnormal` to stop the job.
	Status string `pulumi:"status"`
	// Whether to subscribe the DDL type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDdl bool `pulumi:"subscriptionDataTypeDdl"`
	// Whether to subscribe the DML type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDml bool `pulumi:"subscriptionDataTypeDml"`
	// Network information.
	SubscriptionHosts []GetSubscriptionJobsJobSubscriptionHost `pulumi:"subscriptionHosts"`
	// The type of subscription instance network. Valid value: `classic`, `vpc`.
	SubscriptionInstanceNetworkType string `pulumi:"subscriptionInstanceNetworkType"`
	// The ID of subscription instance vpc.
	SubscriptionInstanceVpcId string `pulumi:"subscriptionInstanceVpcId"`
	// The ID of subscription instance vswitch.
	SubscriptionInstanceVswitchId string `pulumi:"subscriptionInstanceVswitchId"`
	// The tag of the resource.
	Tags map[string]interface{} `pulumi:"tags"`
}

type GetSubscriptionJobsJobArgs

type GetSubscriptionJobsJobArgs struct {
	// Subscription start time in Unix timestamp format.
	Checkpoint pulumi.StringInput `pulumi:"checkpoint"`
	// The creation time of subscription job instance.
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// Subscription object, in the format of JSON strings.
	DbList pulumi.StringInput `pulumi:"dbList"`
	// The ID of subscription job instance.
	DtsInstanceId pulumi.StringInput `pulumi:"dtsInstanceId"`
	// The ID of subscription job instance.
	DtsJobId pulumi.StringInput `pulumi:"dtsJobId"`
	// The name of subscription job instance.
	DtsJobName pulumi.StringInput `pulumi:"dtsJobName"`
	// The Expiration Time. Formatting with yyyy-MM-ddTHH:mm:ssZ(UTC time).
	ExpireTime pulumi.StringInput `pulumi:"expireTime"`
	// The ID of the Subscription Job.
	Id pulumi.StringInput `pulumi:"id"`
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringInput `pulumi:"paymentType"`
	// To subscribe to the name of the database.
	SourceEndpointDatabaseName pulumi.StringInput `pulumi:"sourceEndpointDatabaseName"`
	// The source database type value is MySQL or Oracle.
	SourceEndpointEngineName pulumi.StringInput `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
	SourceEndpointInstanceId pulumi.StringInput `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance. Valid values: `RDS`, `PolarDB`, `DRDS`, `LocalInstance`, `ECS`, `Express`, `CEN`, `dg`.
	SourceEndpointInstanceType pulumi.StringInput `pulumi:"sourceEndpointInstanceType"`
	// The IP of source endpoint.
	SourceEndpointIp pulumi.StringInput `pulumi:"sourceEndpointIp"`
	// The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid pulumi.StringInput `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
	SourceEndpointOwnerId pulumi.StringInput `pulumi:"sourceEndpointOwnerId"`
	// The  port of source database.
	SourceEndpointPort pulumi.StringInput `pulumi:"sourceEndpointPort"`
	// The region of source database.
	SourceEndpointRegion pulumi.StringInput `pulumi:"sourceEndpointRegion"`
	// Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
	SourceEndpointRole pulumi.StringInput `pulumi:"sourceEndpointRole"`
	// The username of source database instance account.
	SourceEndpointUserName pulumi.StringInput `pulumi:"sourceEndpointUserName"`
	// The status of the task. Valid values: `NotStarted`, `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state of `Normal` to start the job, and specify this state of `Abnormal` to stop the job.
	Status pulumi.StringInput `pulumi:"status"`
	// Whether to subscribe the DDL type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDdl pulumi.BoolInput `pulumi:"subscriptionDataTypeDdl"`
	// Whether to subscribe the DML type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDml pulumi.BoolInput `pulumi:"subscriptionDataTypeDml"`
	// Network information.
	SubscriptionHosts GetSubscriptionJobsJobSubscriptionHostArrayInput `pulumi:"subscriptionHosts"`
	// The type of subscription instance network. Valid value: `classic`, `vpc`.
	SubscriptionInstanceNetworkType pulumi.StringInput `pulumi:"subscriptionInstanceNetworkType"`
	// The ID of subscription instance vpc.
	SubscriptionInstanceVpcId pulumi.StringInput `pulumi:"subscriptionInstanceVpcId"`
	// The ID of subscription instance vswitch.
	SubscriptionInstanceVswitchId pulumi.StringInput `pulumi:"subscriptionInstanceVswitchId"`
	// The tag of the resource.
	Tags pulumi.MapInput `pulumi:"tags"`
}

func (GetSubscriptionJobsJobArgs) ElementType

func (GetSubscriptionJobsJobArgs) ElementType() reflect.Type

func (GetSubscriptionJobsJobArgs) ToGetSubscriptionJobsJobOutput

func (i GetSubscriptionJobsJobArgs) ToGetSubscriptionJobsJobOutput() GetSubscriptionJobsJobOutput

func (GetSubscriptionJobsJobArgs) ToGetSubscriptionJobsJobOutputWithContext

func (i GetSubscriptionJobsJobArgs) ToGetSubscriptionJobsJobOutputWithContext(ctx context.Context) GetSubscriptionJobsJobOutput

type GetSubscriptionJobsJobArray

type GetSubscriptionJobsJobArray []GetSubscriptionJobsJobInput

func (GetSubscriptionJobsJobArray) ElementType

func (GetSubscriptionJobsJobArray) ToGetSubscriptionJobsJobArrayOutput

func (i GetSubscriptionJobsJobArray) ToGetSubscriptionJobsJobArrayOutput() GetSubscriptionJobsJobArrayOutput

func (GetSubscriptionJobsJobArray) ToGetSubscriptionJobsJobArrayOutputWithContext

func (i GetSubscriptionJobsJobArray) ToGetSubscriptionJobsJobArrayOutputWithContext(ctx context.Context) GetSubscriptionJobsJobArrayOutput

type GetSubscriptionJobsJobArrayInput

type GetSubscriptionJobsJobArrayInput interface {
	pulumi.Input

	ToGetSubscriptionJobsJobArrayOutput() GetSubscriptionJobsJobArrayOutput
	ToGetSubscriptionJobsJobArrayOutputWithContext(context.Context) GetSubscriptionJobsJobArrayOutput
}

GetSubscriptionJobsJobArrayInput is an input type that accepts GetSubscriptionJobsJobArray and GetSubscriptionJobsJobArrayOutput values. You can construct a concrete instance of `GetSubscriptionJobsJobArrayInput` via:

GetSubscriptionJobsJobArray{ GetSubscriptionJobsJobArgs{...} }

type GetSubscriptionJobsJobArrayOutput

type GetSubscriptionJobsJobArrayOutput struct{ *pulumi.OutputState }

func (GetSubscriptionJobsJobArrayOutput) ElementType

func (GetSubscriptionJobsJobArrayOutput) Index

func (GetSubscriptionJobsJobArrayOutput) ToGetSubscriptionJobsJobArrayOutput

func (o GetSubscriptionJobsJobArrayOutput) ToGetSubscriptionJobsJobArrayOutput() GetSubscriptionJobsJobArrayOutput

func (GetSubscriptionJobsJobArrayOutput) ToGetSubscriptionJobsJobArrayOutputWithContext

func (o GetSubscriptionJobsJobArrayOutput) ToGetSubscriptionJobsJobArrayOutputWithContext(ctx context.Context) GetSubscriptionJobsJobArrayOutput

type GetSubscriptionJobsJobInput

type GetSubscriptionJobsJobInput interface {
	pulumi.Input

	ToGetSubscriptionJobsJobOutput() GetSubscriptionJobsJobOutput
	ToGetSubscriptionJobsJobOutputWithContext(context.Context) GetSubscriptionJobsJobOutput
}

GetSubscriptionJobsJobInput is an input type that accepts GetSubscriptionJobsJobArgs and GetSubscriptionJobsJobOutput values. You can construct a concrete instance of `GetSubscriptionJobsJobInput` via:

GetSubscriptionJobsJobArgs{...}

type GetSubscriptionJobsJobOutput

type GetSubscriptionJobsJobOutput struct{ *pulumi.OutputState }

func (GetSubscriptionJobsJobOutput) Checkpoint

Subscription start time in Unix timestamp format.

func (GetSubscriptionJobsJobOutput) CreateTime

The creation time of subscription job instance.

func (GetSubscriptionJobsJobOutput) DbList

Subscription object, in the format of JSON strings.

func (GetSubscriptionJobsJobOutput) DtsInstanceId

The ID of subscription job instance.

func (GetSubscriptionJobsJobOutput) DtsJobId

The ID of subscription job instance.

func (GetSubscriptionJobsJobOutput) DtsJobName

The name of subscription job instance.

func (GetSubscriptionJobsJobOutput) ElementType

func (GetSubscriptionJobsJobOutput) ExpireTime

The Expiration Time. Formatting with yyyy-MM-ddTHH:mm:ssZ(UTC time).

func (GetSubscriptionJobsJobOutput) Id

The ID of the Subscription Job.

func (GetSubscriptionJobsJobOutput) PaymentType

The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.

func (GetSubscriptionJobsJobOutput) SourceEndpointDatabaseName

func (o GetSubscriptionJobsJobOutput) SourceEndpointDatabaseName() pulumi.StringOutput

To subscribe to the name of the database.

func (GetSubscriptionJobsJobOutput) SourceEndpointEngineName

func (o GetSubscriptionJobsJobOutput) SourceEndpointEngineName() pulumi.StringOutput

The source database type value is MySQL or Oracle.

func (GetSubscriptionJobsJobOutput) SourceEndpointInstanceId

func (o GetSubscriptionJobsJobOutput) SourceEndpointInstanceId() pulumi.StringOutput

The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.

func (GetSubscriptionJobsJobOutput) SourceEndpointInstanceType

func (o GetSubscriptionJobsJobOutput) SourceEndpointInstanceType() pulumi.StringOutput

The type of source instance. Valid values: `RDS`, `PolarDB`, `DRDS`, `LocalInstance`, `ECS`, `Express`, `CEN`, `dg`.

func (GetSubscriptionJobsJobOutput) SourceEndpointIp

func (o GetSubscriptionJobsJobOutput) SourceEndpointIp() pulumi.StringOutput

The IP of source endpoint.

func (GetSubscriptionJobsJobOutput) SourceEndpointOracleSid

func (o GetSubscriptionJobsJobOutput) SourceEndpointOracleSid() pulumi.StringOutput

The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.

func (GetSubscriptionJobsJobOutput) SourceEndpointOwnerId

func (o GetSubscriptionJobsJobOutput) SourceEndpointOwnerId() pulumi.StringOutput

The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.

func (GetSubscriptionJobsJobOutput) SourceEndpointPort

func (o GetSubscriptionJobsJobOutput) SourceEndpointPort() pulumi.StringOutput

The port of source database.

func (GetSubscriptionJobsJobOutput) SourceEndpointRegion

func (o GetSubscriptionJobsJobOutput) SourceEndpointRegion() pulumi.StringOutput

The region of source database.

func (GetSubscriptionJobsJobOutput) SourceEndpointRole

func (o GetSubscriptionJobsJobOutput) SourceEndpointRole() pulumi.StringOutput

Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.

func (GetSubscriptionJobsJobOutput) SourceEndpointUserName

func (o GetSubscriptionJobsJobOutput) SourceEndpointUserName() pulumi.StringOutput

The username of source database instance account.

func (GetSubscriptionJobsJobOutput) Status

The status of the task. Valid values: `NotStarted`, `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state of `Normal` to start the job, and specify this state of `Abnormal` to stop the job.

func (GetSubscriptionJobsJobOutput) SubscriptionDataTypeDdl

func (o GetSubscriptionJobsJobOutput) SubscriptionDataTypeDdl() pulumi.BoolOutput

Whether to subscribe the DDL type of data. Valid values: `true`, `false`.

func (GetSubscriptionJobsJobOutput) SubscriptionDataTypeDml

func (o GetSubscriptionJobsJobOutput) SubscriptionDataTypeDml() pulumi.BoolOutput

Whether to subscribe the DML type of data. Valid values: `true`, `false`.

func (GetSubscriptionJobsJobOutput) SubscriptionHosts

Network information.

func (GetSubscriptionJobsJobOutput) SubscriptionInstanceNetworkType

func (o GetSubscriptionJobsJobOutput) SubscriptionInstanceNetworkType() pulumi.StringOutput

The type of subscription instance network. Valid value: `classic`, `vpc`.

func (GetSubscriptionJobsJobOutput) SubscriptionInstanceVpcId

func (o GetSubscriptionJobsJobOutput) SubscriptionInstanceVpcId() pulumi.StringOutput

The ID of subscription instance vpc.

func (GetSubscriptionJobsJobOutput) SubscriptionInstanceVswitchId

func (o GetSubscriptionJobsJobOutput) SubscriptionInstanceVswitchId() pulumi.StringOutput

The ID of subscription instance vswitch.

func (GetSubscriptionJobsJobOutput) Tags

The tag of the resource.

func (GetSubscriptionJobsJobOutput) ToGetSubscriptionJobsJobOutput

func (o GetSubscriptionJobsJobOutput) ToGetSubscriptionJobsJobOutput() GetSubscriptionJobsJobOutput

func (GetSubscriptionJobsJobOutput) ToGetSubscriptionJobsJobOutputWithContext

func (o GetSubscriptionJobsJobOutput) ToGetSubscriptionJobsJobOutputWithContext(ctx context.Context) GetSubscriptionJobsJobOutput

type GetSubscriptionJobsJobSubscriptionHost

type GetSubscriptionJobsJobSubscriptionHost struct {
	// Classic network address.
	PrivateHost string `pulumi:"privateHost"`
	// Public network address.
	PublicHost string `pulumi:"publicHost"`
	// VPC network address.
	VpcHost string `pulumi:"vpcHost"`
}

type GetSubscriptionJobsJobSubscriptionHostArgs

type GetSubscriptionJobsJobSubscriptionHostArgs struct {
	// Classic network address.
	PrivateHost pulumi.StringInput `pulumi:"privateHost"`
	// Public network address.
	PublicHost pulumi.StringInput `pulumi:"publicHost"`
	// VPC network address.
	VpcHost pulumi.StringInput `pulumi:"vpcHost"`
}

func (GetSubscriptionJobsJobSubscriptionHostArgs) ElementType

func (GetSubscriptionJobsJobSubscriptionHostArgs) ToGetSubscriptionJobsJobSubscriptionHostOutput

func (i GetSubscriptionJobsJobSubscriptionHostArgs) ToGetSubscriptionJobsJobSubscriptionHostOutput() GetSubscriptionJobsJobSubscriptionHostOutput

func (GetSubscriptionJobsJobSubscriptionHostArgs) ToGetSubscriptionJobsJobSubscriptionHostOutputWithContext

func (i GetSubscriptionJobsJobSubscriptionHostArgs) ToGetSubscriptionJobsJobSubscriptionHostOutputWithContext(ctx context.Context) GetSubscriptionJobsJobSubscriptionHostOutput

type GetSubscriptionJobsJobSubscriptionHostArray

type GetSubscriptionJobsJobSubscriptionHostArray []GetSubscriptionJobsJobSubscriptionHostInput

func (GetSubscriptionJobsJobSubscriptionHostArray) ElementType

func (GetSubscriptionJobsJobSubscriptionHostArray) ToGetSubscriptionJobsJobSubscriptionHostArrayOutput

func (i GetSubscriptionJobsJobSubscriptionHostArray) ToGetSubscriptionJobsJobSubscriptionHostArrayOutput() GetSubscriptionJobsJobSubscriptionHostArrayOutput

func (GetSubscriptionJobsJobSubscriptionHostArray) ToGetSubscriptionJobsJobSubscriptionHostArrayOutputWithContext

func (i GetSubscriptionJobsJobSubscriptionHostArray) ToGetSubscriptionJobsJobSubscriptionHostArrayOutputWithContext(ctx context.Context) GetSubscriptionJobsJobSubscriptionHostArrayOutput

type GetSubscriptionJobsJobSubscriptionHostArrayInput

type GetSubscriptionJobsJobSubscriptionHostArrayInput interface {
	pulumi.Input

	ToGetSubscriptionJobsJobSubscriptionHostArrayOutput() GetSubscriptionJobsJobSubscriptionHostArrayOutput
	ToGetSubscriptionJobsJobSubscriptionHostArrayOutputWithContext(context.Context) GetSubscriptionJobsJobSubscriptionHostArrayOutput
}

GetSubscriptionJobsJobSubscriptionHostArrayInput is an input type that accepts GetSubscriptionJobsJobSubscriptionHostArray and GetSubscriptionJobsJobSubscriptionHostArrayOutput values. You can construct a concrete instance of `GetSubscriptionJobsJobSubscriptionHostArrayInput` via:

GetSubscriptionJobsJobSubscriptionHostArray{ GetSubscriptionJobsJobSubscriptionHostArgs{...} }

type GetSubscriptionJobsJobSubscriptionHostArrayOutput

type GetSubscriptionJobsJobSubscriptionHostArrayOutput struct{ *pulumi.OutputState }

func (GetSubscriptionJobsJobSubscriptionHostArrayOutput) ElementType

func (GetSubscriptionJobsJobSubscriptionHostArrayOutput) Index

func (GetSubscriptionJobsJobSubscriptionHostArrayOutput) ToGetSubscriptionJobsJobSubscriptionHostArrayOutput

func (o GetSubscriptionJobsJobSubscriptionHostArrayOutput) ToGetSubscriptionJobsJobSubscriptionHostArrayOutput() GetSubscriptionJobsJobSubscriptionHostArrayOutput

func (GetSubscriptionJobsJobSubscriptionHostArrayOutput) ToGetSubscriptionJobsJobSubscriptionHostArrayOutputWithContext

func (o GetSubscriptionJobsJobSubscriptionHostArrayOutput) ToGetSubscriptionJobsJobSubscriptionHostArrayOutputWithContext(ctx context.Context) GetSubscriptionJobsJobSubscriptionHostArrayOutput

type GetSubscriptionJobsJobSubscriptionHostInput

type GetSubscriptionJobsJobSubscriptionHostInput interface {
	pulumi.Input

	ToGetSubscriptionJobsJobSubscriptionHostOutput() GetSubscriptionJobsJobSubscriptionHostOutput
	ToGetSubscriptionJobsJobSubscriptionHostOutputWithContext(context.Context) GetSubscriptionJobsJobSubscriptionHostOutput
}

GetSubscriptionJobsJobSubscriptionHostInput is an input type that accepts GetSubscriptionJobsJobSubscriptionHostArgs and GetSubscriptionJobsJobSubscriptionHostOutput values. You can construct a concrete instance of `GetSubscriptionJobsJobSubscriptionHostInput` via:

GetSubscriptionJobsJobSubscriptionHostArgs{...}

type GetSubscriptionJobsJobSubscriptionHostOutput

type GetSubscriptionJobsJobSubscriptionHostOutput struct{ *pulumi.OutputState }

func (GetSubscriptionJobsJobSubscriptionHostOutput) ElementType

func (GetSubscriptionJobsJobSubscriptionHostOutput) PrivateHost

Classic network address.

func (GetSubscriptionJobsJobSubscriptionHostOutput) PublicHost

Public network address.

func (GetSubscriptionJobsJobSubscriptionHostOutput) ToGetSubscriptionJobsJobSubscriptionHostOutput

func (o GetSubscriptionJobsJobSubscriptionHostOutput) ToGetSubscriptionJobsJobSubscriptionHostOutput() GetSubscriptionJobsJobSubscriptionHostOutput

func (GetSubscriptionJobsJobSubscriptionHostOutput) ToGetSubscriptionJobsJobSubscriptionHostOutputWithContext

func (o GetSubscriptionJobsJobSubscriptionHostOutput) ToGetSubscriptionJobsJobSubscriptionHostOutputWithContext(ctx context.Context) GetSubscriptionJobsJobSubscriptionHostOutput

func (GetSubscriptionJobsJobSubscriptionHostOutput) VpcHost

VPC network address.

type GetSubscriptionJobsOutputArgs added in v3.9.0

type GetSubscriptionJobsOutputArgs struct {
	EnableDetails pulumi.BoolPtrInput `pulumi:"enableDetails"`
	// A list of Subscription Job IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// A regex string to filter results by subscription job name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The status of the task. Valid values: `NotStarted`, `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state of `Normal` to start the job, and specify this state of `Abnormal` to stop the job.
	Status pulumi.StringPtrInput `pulumi:"status"`
	// The tag of the resource.
	Tags pulumi.MapInput `pulumi:"tags"`
}

A collection of arguments for invoking getSubscriptionJobs.

func (GetSubscriptionJobsOutputArgs) ElementType added in v3.9.0

type GetSubscriptionJobsResult

type GetSubscriptionJobsResult struct {
	EnableDetails *bool `pulumi:"enableDetails"`
	// The provider-assigned unique ID for this managed resource.
	Id         string                   `pulumi:"id"`
	Ids        []string                 `pulumi:"ids"`
	Jobs       []GetSubscriptionJobsJob `pulumi:"jobs"`
	NameRegex  *string                  `pulumi:"nameRegex"`
	Names      []string                 `pulumi:"names"`
	OutputFile *string                  `pulumi:"outputFile"`
	Status     *string                  `pulumi:"status"`
	Tags       map[string]interface{}   `pulumi:"tags"`
}

A collection of values returned by getSubscriptionJobs.

func GetSubscriptionJobs

func GetSubscriptionJobs(ctx *pulumi.Context, args *GetSubscriptionJobsArgs, opts ...pulumi.InvokeOption) (*GetSubscriptionJobsResult, error)

This data source provides the Dts Subscription Jobs of the current Alibaba Cloud user.

> **NOTE:** Available in v1.138.0+.

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := dts.GetSubscriptionJobs(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("dtsSubscriptionJobId1", ids.Jobs[0].Id)
		return nil
	})
}

```

type GetSubscriptionJobsResultOutput added in v3.9.0

type GetSubscriptionJobsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getSubscriptionJobs.

func GetSubscriptionJobsOutput added in v3.9.0

func (GetSubscriptionJobsResultOutput) ElementType added in v3.9.0

func (GetSubscriptionJobsResultOutput) EnableDetails added in v3.9.0

func (GetSubscriptionJobsResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetSubscriptionJobsResultOutput) Ids added in v3.9.0

func (GetSubscriptionJobsResultOutput) Jobs added in v3.9.0

func (GetSubscriptionJobsResultOutput) NameRegex added in v3.9.0

func (GetSubscriptionJobsResultOutput) Names added in v3.9.0

func (GetSubscriptionJobsResultOutput) OutputFile added in v3.9.0

func (GetSubscriptionJobsResultOutput) Status added in v3.9.0

func (GetSubscriptionJobsResultOutput) Tags added in v3.9.0

func (GetSubscriptionJobsResultOutput) ToGetSubscriptionJobsResultOutput added in v3.9.0

func (o GetSubscriptionJobsResultOutput) ToGetSubscriptionJobsResultOutput() GetSubscriptionJobsResultOutput

func (GetSubscriptionJobsResultOutput) ToGetSubscriptionJobsResultOutputWithContext added in v3.9.0

func (o GetSubscriptionJobsResultOutput) ToGetSubscriptionJobsResultOutputWithContext(ctx context.Context) GetSubscriptionJobsResultOutput

type GetSynchronizationJobsArgs

type GetSynchronizationJobsArgs struct {
	EnableDetails *bool `pulumi:"enableDetails"`
	// A list of Synchronization Job IDs.
	Ids []string `pulumi:"ids"`
	// A regex string to filter results by synchronization job name.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile *string `pulumi:"outputFile"`
	// The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.
	Status *string `pulumi:"status"`
}

A collection of arguments for invoking getSynchronizationJobs.

type GetSynchronizationJobsJob

type GetSynchronizationJobsJob struct {
	// Start time in Unix timestamp format.
	Checkpoint string `pulumi:"checkpoint"`
	CreateTime string `pulumi:"createTime"`
	// Whether to execute DTS supports schema migration, full data migration, or full-data initialization.
	DataInitialization bool `pulumi:"dataInitialization"`
	// Whether to perform incremental data migration for migration types or synchronization.
	DataSynchronization bool `pulumi:"dataSynchronization"`
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, synchronization or subscription objects](https://help.aliyun.com/document_detail/209545.html).
	DbList string `pulumi:"dbList"`
	// The name of migrate the database.
	DestinationEndpointDataBaseName string `pulumi:"destinationEndpointDataBaseName"`
	// The type of destination database. Valid values: `ADB20`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName string `pulumi:"destinationEndpointEngineName"`
	// The ID of destination instance.
	DestinationEndpointInstanceId string `pulumi:"destinationEndpointInstanceId"`
	// The type of destination instance. Valid values: `ads`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType string `pulumi:"destinationEndpointInstanceType"`
	// The ip of source endpoint.
	DestinationEndpointIp string `pulumi:"destinationEndpointIp"`
	// The SID of Oracle database.
	DestinationEndpointOracleSid string `pulumi:"destinationEndpointOracleSid"`
	// The port of source endpoint.
	DestinationEndpointPort string `pulumi:"destinationEndpointPort"`
	// The region of destination instance.
	DestinationEndpointRegion string `pulumi:"destinationEndpointRegion"`
	// The username of database account.
	DestinationEndpointUserName string `pulumi:"destinationEndpointUserName"`
	DtsInstanceId               string `pulumi:"dtsInstanceId"`
	DtsJobId                    string `pulumi:"dtsJobId"`
	// The name of synchronization job.
	DtsJobName string `pulumi:"dtsJobName"`
	ExpireTime string `pulumi:"expireTime"`
	// The ID of synchronizing instance. It's the ID of resource `dts.SynchronizationInstance`.
	Id string `pulumi:"id"`
	// The name of migrate the database.
	SourceEndpointDatabaseName string `pulumi:"sourceEndpointDatabaseName"`
	// The type of source database. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName string `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance.
	SourceEndpointInstanceId string `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance. Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType string `pulumi:"sourceEndpointInstanceType"`
	// The ip of source endpoint.
	SourceEndpointIp string `pulumi:"sourceEndpointIp"`
	// The SID of Oracle database.
	SourceEndpointOracleSid string `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs.
	SourceEndpointOwnerId string `pulumi:"sourceEndpointOwnerId"`
	// The port of source endpoint.
	SourceEndpointPort string `pulumi:"sourceEndpointPort"`
	// The region of source instance.
	SourceEndpointRegion string `pulumi:"sourceEndpointRegion"`
	// The name of the role configured for the cloud account to which the source instance belongs.
	SourceEndpointRole string `pulumi:"sourceEndpointRole"`
	// The username of database account.
	SourceEndpointUserName string `pulumi:"sourceEndpointUserName"`
	// The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.
	Status string `pulumi:"status"`
	// Whether to perform a database table structure to migrate or initialization values include:
	StructureInitialization bool `pulumi:"structureInitialization"`
	// Synchronization direction. Valid values: `Forward`, `Reverse`. Only when the property `syncArchitecture` of the `dts.SynchronizationInstance` was `bidirectional` this parameter should be passed, otherwise this parameter should not be specified.
	SynchronizationDirection string `pulumi:"synchronizationDirection"`
}

type GetSynchronizationJobsJobArgs

type GetSynchronizationJobsJobArgs struct {
	// Start time in Unix timestamp format.
	Checkpoint pulumi.StringInput `pulumi:"checkpoint"`
	CreateTime pulumi.StringInput `pulumi:"createTime"`
	// Whether to execute DTS supports schema migration, full data migration, or full-data initialization.
	DataInitialization pulumi.BoolInput `pulumi:"dataInitialization"`
	// Whether to perform incremental data migration for migration types or synchronization.
	DataSynchronization pulumi.BoolInput `pulumi:"dataSynchronization"`
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, synchronization or subscription objects](https://help.aliyun.com/document_detail/209545.html).
	DbList pulumi.StringInput `pulumi:"dbList"`
	// The name of migrate the database.
	DestinationEndpointDataBaseName pulumi.StringInput `pulumi:"destinationEndpointDataBaseName"`
	// The type of destination database. Valid values: `ADB20`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName pulumi.StringInput `pulumi:"destinationEndpointEngineName"`
	// The ID of destination instance.
	DestinationEndpointInstanceId pulumi.StringInput `pulumi:"destinationEndpointInstanceId"`
	// The type of destination instance. Valid values: `ads`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType pulumi.StringInput `pulumi:"destinationEndpointInstanceType"`
	// The ip of source endpoint.
	DestinationEndpointIp pulumi.StringInput `pulumi:"destinationEndpointIp"`
	// The SID of Oracle database.
	DestinationEndpointOracleSid pulumi.StringInput `pulumi:"destinationEndpointOracleSid"`
	// The port of source endpoint.
	DestinationEndpointPort pulumi.StringInput `pulumi:"destinationEndpointPort"`
	// The region of destination instance.
	DestinationEndpointRegion pulumi.StringInput `pulumi:"destinationEndpointRegion"`
	// The username of database account.
	DestinationEndpointUserName pulumi.StringInput `pulumi:"destinationEndpointUserName"`
	DtsInstanceId               pulumi.StringInput `pulumi:"dtsInstanceId"`
	DtsJobId                    pulumi.StringInput `pulumi:"dtsJobId"`
	// The name of synchronization job.
	DtsJobName pulumi.StringInput `pulumi:"dtsJobName"`
	ExpireTime pulumi.StringInput `pulumi:"expireTime"`
	// The ID of synchronizing instance. It's the ID of resource `dts.SynchronizationInstance`.
	Id pulumi.StringInput `pulumi:"id"`
	// The name of migrate the database.
	SourceEndpointDatabaseName pulumi.StringInput `pulumi:"sourceEndpointDatabaseName"`
	// The type of source database. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName pulumi.StringInput `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance.
	SourceEndpointInstanceId pulumi.StringInput `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance. Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType pulumi.StringInput `pulumi:"sourceEndpointInstanceType"`
	// The ip of source endpoint.
	SourceEndpointIp pulumi.StringInput `pulumi:"sourceEndpointIp"`
	// The SID of Oracle database.
	SourceEndpointOracleSid pulumi.StringInput `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs.
	SourceEndpointOwnerId pulumi.StringInput `pulumi:"sourceEndpointOwnerId"`
	// The port of source endpoint.
	SourceEndpointPort pulumi.StringInput `pulumi:"sourceEndpointPort"`
	// The region of source instance.
	SourceEndpointRegion pulumi.StringInput `pulumi:"sourceEndpointRegion"`
	// The name of the role configured for the cloud account to which the source instance belongs.
	SourceEndpointRole pulumi.StringInput `pulumi:"sourceEndpointRole"`
	// The username of database account.
	SourceEndpointUserName pulumi.StringInput `pulumi:"sourceEndpointUserName"`
	// The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.
	Status pulumi.StringInput `pulumi:"status"`
	// Whether to perform a database table structure to migrate or initialization values include:
	StructureInitialization pulumi.BoolInput `pulumi:"structureInitialization"`
	// Synchronization direction. Valid values: `Forward`, `Reverse`. Only when the property `syncArchitecture` of the `dts.SynchronizationInstance` was `bidirectional` this parameter should be passed, otherwise this parameter should not be specified.
	SynchronizationDirection pulumi.StringInput `pulumi:"synchronizationDirection"`
}

func (GetSynchronizationJobsJobArgs) ElementType

func (GetSynchronizationJobsJobArgs) ToGetSynchronizationJobsJobOutput

func (i GetSynchronizationJobsJobArgs) ToGetSynchronizationJobsJobOutput() GetSynchronizationJobsJobOutput

func (GetSynchronizationJobsJobArgs) ToGetSynchronizationJobsJobOutputWithContext

func (i GetSynchronizationJobsJobArgs) ToGetSynchronizationJobsJobOutputWithContext(ctx context.Context) GetSynchronizationJobsJobOutput

type GetSynchronizationJobsJobArray

type GetSynchronizationJobsJobArray []GetSynchronizationJobsJobInput

func (GetSynchronizationJobsJobArray) ElementType

func (GetSynchronizationJobsJobArray) ToGetSynchronizationJobsJobArrayOutput

func (i GetSynchronizationJobsJobArray) ToGetSynchronizationJobsJobArrayOutput() GetSynchronizationJobsJobArrayOutput

func (GetSynchronizationJobsJobArray) ToGetSynchronizationJobsJobArrayOutputWithContext

func (i GetSynchronizationJobsJobArray) ToGetSynchronizationJobsJobArrayOutputWithContext(ctx context.Context) GetSynchronizationJobsJobArrayOutput

type GetSynchronizationJobsJobArrayInput

type GetSynchronizationJobsJobArrayInput interface {
	pulumi.Input

	ToGetSynchronizationJobsJobArrayOutput() GetSynchronizationJobsJobArrayOutput
	ToGetSynchronizationJobsJobArrayOutputWithContext(context.Context) GetSynchronizationJobsJobArrayOutput
}

GetSynchronizationJobsJobArrayInput is an input type that accepts GetSynchronizationJobsJobArray and GetSynchronizationJobsJobArrayOutput values. You can construct a concrete instance of `GetSynchronizationJobsJobArrayInput` via:

GetSynchronizationJobsJobArray{ GetSynchronizationJobsJobArgs{...} }

type GetSynchronizationJobsJobArrayOutput

type GetSynchronizationJobsJobArrayOutput struct{ *pulumi.OutputState }

func (GetSynchronizationJobsJobArrayOutput) ElementType

func (GetSynchronizationJobsJobArrayOutput) Index

func (GetSynchronizationJobsJobArrayOutput) ToGetSynchronizationJobsJobArrayOutput

func (o GetSynchronizationJobsJobArrayOutput) ToGetSynchronizationJobsJobArrayOutput() GetSynchronizationJobsJobArrayOutput

func (GetSynchronizationJobsJobArrayOutput) ToGetSynchronizationJobsJobArrayOutputWithContext

func (o GetSynchronizationJobsJobArrayOutput) ToGetSynchronizationJobsJobArrayOutputWithContext(ctx context.Context) GetSynchronizationJobsJobArrayOutput

type GetSynchronizationJobsJobInput

type GetSynchronizationJobsJobInput interface {
	pulumi.Input

	ToGetSynchronizationJobsJobOutput() GetSynchronizationJobsJobOutput
	ToGetSynchronizationJobsJobOutputWithContext(context.Context) GetSynchronizationJobsJobOutput
}

GetSynchronizationJobsJobInput is an input type that accepts GetSynchronizationJobsJobArgs and GetSynchronizationJobsJobOutput values. You can construct a concrete instance of `GetSynchronizationJobsJobInput` via:

GetSynchronizationJobsJobArgs{...}

type GetSynchronizationJobsJobOutput

type GetSynchronizationJobsJobOutput struct{ *pulumi.OutputState }

func (GetSynchronizationJobsJobOutput) Checkpoint

Start time in Unix timestamp format.

func (GetSynchronizationJobsJobOutput) CreateTime

func (GetSynchronizationJobsJobOutput) DataInitialization

func (o GetSynchronizationJobsJobOutput) DataInitialization() pulumi.BoolOutput

Whether to execute DTS supports schema migration, full data migration, or full-data initialization.

func (GetSynchronizationJobsJobOutput) DataSynchronization

func (o GetSynchronizationJobsJobOutput) DataSynchronization() pulumi.BoolOutput

Whether to perform incremental data migration for migration types or synchronization.

func (GetSynchronizationJobsJobOutput) DbList

Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, synchronization or subscription objects](https://help.aliyun.com/document_detail/209545.html).

func (GetSynchronizationJobsJobOutput) DestinationEndpointDataBaseName

func (o GetSynchronizationJobsJobOutput) DestinationEndpointDataBaseName() pulumi.StringOutput

The name of migrate the database.

func (GetSynchronizationJobsJobOutput) DestinationEndpointEngineName

func (o GetSynchronizationJobsJobOutput) DestinationEndpointEngineName() pulumi.StringOutput

The type of destination database. Valid values: `ADB20`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.

func (GetSynchronizationJobsJobOutput) DestinationEndpointInstanceId

func (o GetSynchronizationJobsJobOutput) DestinationEndpointInstanceId() pulumi.StringOutput

The ID of destination instance.

func (GetSynchronizationJobsJobOutput) DestinationEndpointInstanceType

func (o GetSynchronizationJobsJobOutput) DestinationEndpointInstanceType() pulumi.StringOutput

The type of destination instance. Valid values: `ads`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.

func (GetSynchronizationJobsJobOutput) DestinationEndpointIp

func (o GetSynchronizationJobsJobOutput) DestinationEndpointIp() pulumi.StringOutput

The ip of source endpoint.

func (GetSynchronizationJobsJobOutput) DestinationEndpointOracleSid

func (o GetSynchronizationJobsJobOutput) DestinationEndpointOracleSid() pulumi.StringOutput

The SID of Oracle database.

func (GetSynchronizationJobsJobOutput) DestinationEndpointPort

func (o GetSynchronizationJobsJobOutput) DestinationEndpointPort() pulumi.StringOutput

The port of source endpoint.

func (GetSynchronizationJobsJobOutput) DestinationEndpointRegion

func (o GetSynchronizationJobsJobOutput) DestinationEndpointRegion() pulumi.StringOutput

The region of destination instance.

func (GetSynchronizationJobsJobOutput) DestinationEndpointUserName

func (o GetSynchronizationJobsJobOutput) DestinationEndpointUserName() pulumi.StringOutput

The username of database account.

func (GetSynchronizationJobsJobOutput) DtsInstanceId

func (GetSynchronizationJobsJobOutput) DtsJobId

func (GetSynchronizationJobsJobOutput) DtsJobName

The name of synchronization job.

func (GetSynchronizationJobsJobOutput) ElementType

func (GetSynchronizationJobsJobOutput) ExpireTime

func (GetSynchronizationJobsJobOutput) Id

The ID of synchronizing instance. It's the ID of resource `dts.SynchronizationInstance`.

func (GetSynchronizationJobsJobOutput) SourceEndpointDatabaseName

func (o GetSynchronizationJobsJobOutput) SourceEndpointDatabaseName() pulumi.StringOutput

The name of migrate the database.

func (GetSynchronizationJobsJobOutput) SourceEndpointEngineName

func (o GetSynchronizationJobsJobOutput) SourceEndpointEngineName() pulumi.StringOutput

The type of source database. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.

func (GetSynchronizationJobsJobOutput) SourceEndpointInstanceId

func (o GetSynchronizationJobsJobOutput) SourceEndpointInstanceId() pulumi.StringOutput

The ID of source instance.

func (GetSynchronizationJobsJobOutput) SourceEndpointInstanceType

func (o GetSynchronizationJobsJobOutput) SourceEndpointInstanceType() pulumi.StringOutput

The type of source instance. Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.

func (GetSynchronizationJobsJobOutput) SourceEndpointIp

The ip of source endpoint.

func (GetSynchronizationJobsJobOutput) SourceEndpointOracleSid

func (o GetSynchronizationJobsJobOutput) SourceEndpointOracleSid() pulumi.StringOutput

The SID of Oracle database.

func (GetSynchronizationJobsJobOutput) SourceEndpointOwnerId

func (o GetSynchronizationJobsJobOutput) SourceEndpointOwnerId() pulumi.StringOutput

The Alibaba Cloud account ID to which the source instance belongs.

func (GetSynchronizationJobsJobOutput) SourceEndpointPort

func (o GetSynchronizationJobsJobOutput) SourceEndpointPort() pulumi.StringOutput

The port of source endpoint.

func (GetSynchronizationJobsJobOutput) SourceEndpointRegion

func (o GetSynchronizationJobsJobOutput) SourceEndpointRegion() pulumi.StringOutput

The region of source instance.

func (GetSynchronizationJobsJobOutput) SourceEndpointRole

func (o GetSynchronizationJobsJobOutput) SourceEndpointRole() pulumi.StringOutput

The name of the role configured for the cloud account to which the source instance belongs.

func (GetSynchronizationJobsJobOutput) SourceEndpointUserName

func (o GetSynchronizationJobsJobOutput) SourceEndpointUserName() pulumi.StringOutput

The username of database account.

func (GetSynchronizationJobsJobOutput) Status

The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.

func (GetSynchronizationJobsJobOutput) StructureInitialization

func (o GetSynchronizationJobsJobOutput) StructureInitialization() pulumi.BoolOutput

Whether to perform a database table structure to migrate or initialization values include:

func (GetSynchronizationJobsJobOutput) SynchronizationDirection

func (o GetSynchronizationJobsJobOutput) SynchronizationDirection() pulumi.StringOutput

Synchronization direction. Valid values: `Forward`, `Reverse`. Only when the property `syncArchitecture` of the `dts.SynchronizationInstance` was `bidirectional` this parameter should be passed, otherwise this parameter should not be specified.

func (GetSynchronizationJobsJobOutput) ToGetSynchronizationJobsJobOutput

func (o GetSynchronizationJobsJobOutput) ToGetSynchronizationJobsJobOutput() GetSynchronizationJobsJobOutput

func (GetSynchronizationJobsJobOutput) ToGetSynchronizationJobsJobOutputWithContext

func (o GetSynchronizationJobsJobOutput) ToGetSynchronizationJobsJobOutputWithContext(ctx context.Context) GetSynchronizationJobsJobOutput

type GetSynchronizationJobsOutputArgs added in v3.9.0

type GetSynchronizationJobsOutputArgs struct {
	EnableDetails pulumi.BoolPtrInput `pulumi:"enableDetails"`
	// A list of Synchronization Job IDs.
	Ids pulumi.StringArrayInput `pulumi:"ids"`
	// A regex string to filter results by synchronization job name.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results (after running `pulumi preview`).
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.
	Status pulumi.StringPtrInput `pulumi:"status"`
}

A collection of arguments for invoking getSynchronizationJobs.

func (GetSynchronizationJobsOutputArgs) ElementType added in v3.9.0

type GetSynchronizationJobsResult

type GetSynchronizationJobsResult struct {
	EnableDetails *bool `pulumi:"enableDetails"`
	// The provider-assigned unique ID for this managed resource.
	Id         string                      `pulumi:"id"`
	Ids        []string                    `pulumi:"ids"`
	Jobs       []GetSynchronizationJobsJob `pulumi:"jobs"`
	NameRegex  *string                     `pulumi:"nameRegex"`
	OutputFile *string                     `pulumi:"outputFile"`
	Status     *string                     `pulumi:"status"`
}

A collection of values returned by getSynchronizationJobs.

func GetSynchronizationJobs

func GetSynchronizationJobs(ctx *pulumi.Context, args *GetSynchronizationJobsArgs, opts ...pulumi.InvokeOption) (*GetSynchronizationJobsResult, error)

This data source provides the Dts Synchronization Jobs of the current Alibaba Cloud user.

> **NOTE:** Available in v1.138.0+.

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := dts.GetSynchronizationJobs(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("dtsSynchronizationJobId1", ids.Jobs[0].Id)
		return nil
	})
}

```

type GetSynchronizationJobsResultOutput added in v3.9.0

type GetSynchronizationJobsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getSynchronizationJobs.

func GetSynchronizationJobsOutput added in v3.9.0

func (GetSynchronizationJobsResultOutput) ElementType added in v3.9.0

func (GetSynchronizationJobsResultOutput) EnableDetails added in v3.9.0

func (GetSynchronizationJobsResultOutput) Id added in v3.9.0

The provider-assigned unique ID for this managed resource.

func (GetSynchronizationJobsResultOutput) Ids added in v3.9.0

func (GetSynchronizationJobsResultOutput) Jobs added in v3.9.0

func (GetSynchronizationJobsResultOutput) NameRegex added in v3.9.0

func (GetSynchronizationJobsResultOutput) OutputFile added in v3.9.0

func (GetSynchronizationJobsResultOutput) Status added in v3.9.0

func (GetSynchronizationJobsResultOutput) ToGetSynchronizationJobsResultOutput added in v3.9.0

func (o GetSynchronizationJobsResultOutput) ToGetSynchronizationJobsResultOutput() GetSynchronizationJobsResultOutput

func (GetSynchronizationJobsResultOutput) ToGetSynchronizationJobsResultOutputWithContext added in v3.9.0

func (o GetSynchronizationJobsResultOutput) ToGetSynchronizationJobsResultOutputWithContext(ctx context.Context) GetSynchronizationJobsResultOutput

type Instance added in v3.31.0

type Instance struct {
	pulumi.CustomResourceState

	// Whether to automatically renew the fee when it expires. Valid values:
	// - **false**: No, the default value.
	// - **true**: Yes.
	AutoPay pulumi.BoolPtrOutput `pulumi:"autoPay"`
	// Whether to start the task automatically after the purchase is completed. Value:
	// - **false**: No, the default value.
	// - **true**: Yes.
	AutoStart pulumi.BoolPtrOutput `pulumi:"autoStart"`
	// Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. **NOTE:** Enter this parameter and enable ETL to clean and convert data.
	ComputeUnit pulumi.IntPtrOutput `pulumi:"computeUnit"`
	// Instance creation time
	CreateTime pulumi.StringOutput `pulumi:"createTime"`
	// The number of private custom RDS instances in the PolarDB-X. The default value is **1**. **NOTE:** This parameter is required only when **source_endpoint_engine_name** is **DRDS**.
	DatabaseCount pulumi.IntOutput `pulumi:"databaseCount"`
	// The target database engine type.
	// - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL).
	// - **PolarDB**:PolarDB MySQL.
	// - **polardb_o**:PolarDB O engine.
	// - **polardb_pg**:PolarDB PostgreSQL.
	// - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis).
	// - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0.
	// - **PostgreSQL**: User-created PostgreSQL.
	// - **ODPS**:MaxCompute project.
	// - **oracle**: self-built Oracle.
	// - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
	// - **tidb**:TiDB database.
	// - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0.
	// - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0.
	// - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL.
	// - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server).
	// - **kafka**:Kafka databases (including Kafka and self-built Kafka).
	// - **DataHub**: DataHub, an Alibaba cloud streaming data service.
	// - **clickhouse**: ClickHouse.
	// - **DB2**: self-built DB2 LUW.
	// - **as400**:AS/400.
	// - **Tablestore**: Tablestore.
	// - **NOTE:**
	// - The default value is **MySQL**.
	// - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios).
	// - This parameter or **job_id** must be passed in.
	DestinationEndpointEngineName pulumi.StringOutput `pulumi:"destinationEndpointEngineName"`
	// The target instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.
	DestinationRegion pulumi.StringPtrOutput `pulumi:"destinationRegion"`
	// The ID of the subscription instance.
	DtsInstanceId pulumi.StringOutput `pulumi:"dtsInstanceId"`
	// Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: **1** ~ **100**. **NOTE:** The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
	Du pulumi.IntPtrOutput `pulumi:"du"`
	// Subscription billing type, Valid values: `ONLY_CONFIGURATION_FEE`: charges only configuration fees; `CONFIGURATION_FEE_AND_DATA_FEE`: charges configuration fees and data traffic fees.
	FeeType pulumi.StringPtrOutput `pulumi:"feeType"`
	// The type of the migration or synchronization instance.
	// - The specifications of the migration instance: **xxlarge**, **xlarge**, **large**, **medium**, **small**.
	// - The types of synchronization instances: **large**, **medium**, **small**, **micro**.
	// - **NOTE:** For performance descriptions of different specifications, see [Data Migration Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/cd773b) and [Data Synchronization Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/6bce7c).
	InstanceClass pulumi.StringPtrOutput `pulumi:"instanceClass"`
	// The name of Dts instance.
	InstanceName pulumi.StringOutput `pulumi:"instanceName"`
	// The ID of the task obtained by calling the **ConfigureDtsJob** operation (**DtsJobId**).> After you pass in this parameter, you do not need to pass the **source_region**, **destination_region**, **type**, **source_endpoint_engine_name**, or **destination_endpoint_engine_name** parameters. Even if the input is passed in, the configuration in **job_id** shall prevail.
	JobId pulumi.StringPtrOutput `pulumi:"jobId"`
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringPtrOutput `pulumi:"paymentType"`
	// The billing method of the subscription instance. Value: `Year`, `Month`. **NOTE:** This parameter is valid and must be passed in only when `paymentType` is `Subscription`.
	Period pulumi.StringPtrOutput `pulumi:"period"`
	// Resource Group ID.
	ResourceGroupId pulumi.StringOutput `pulumi:"resourceGroupId"`
	// Source instance database engine type.
	// - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL).
	// - **PolarDB**:PolarDB MySQL.
	// - **polardb_o**:PolarDB O engine.
	// - **polardb_pg**:PolarDB PostgreSQL.
	// - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis).
	// - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0.
	// - **PostgreSQL**: User-created PostgreSQL.
	// - **ODPS**:MaxCompute.
	// - **oracle**: self-built Oracle.
	// - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
	// - **tidb**:TiDB database.
	// - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0.
	// - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0.
	// - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL.
	// - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server).
	// - **kafka**:Kafka databases (including Kafka and self-built Kafka).
	// - **DataHub**: DataHub, an Alibaba cloud streaming data service.
	// - **clickhouse**: ClickHouse.
	// - **DB2**: self-built DB2 LUW.
	// - **as400**:AS/400.
	// - **Tablestore**: Tablestore.
	// - **NOTE:**
	// - The default value is **MySQL**.
	// - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios).
	// - This parameter or **job_id** must be passed in.
	SourceEndpointEngineName pulumi.StringOutput `pulumi:"sourceEndpointEngineName"`
	// The source instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.
	SourceRegion pulumi.StringPtrOutput `pulumi:"sourceRegion"`
	// Instance status.
	Status pulumi.StringOutput `pulumi:"status"`
	// Synchronization topology, value:
	// - **oneway**: one-way synchronization, the default value.
	// - **bidirectional**: two-way synchronization.
	SyncArchitecture pulumi.StringPtrOutput `pulumi:"syncArchitecture"`
	// The synchronization direction. Default value: `Forward`. Valid values:
	SynchronizationDirection pulumi.StringPtrOutput `pulumi:"synchronizationDirection"`
	// The tag value corresponding to the tag key.See the following `Block Tags`.
	Tags pulumi.MapOutput `pulumi:"tags"`
	// The instance type. Valid values:
	// - **migration**: MIGRATION.
	// - **sync**: synchronization.
	// - **subscribe**: SUBSCRIBE.
	// - **NOTE:** This parameter or **job_id** must be passed in.
	Type pulumi.StringPtrOutput `pulumi:"type"`
	// Prepaid instance purchase duration.
	// - When **period** is **Month**, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
	// - When **Period** is **Year**, the values are 1, 2, 3, and 5.
	// - **NOTE:**
	// - This parameter is valid and must be passed in only when **payment_type** is `Subscription`.
	// - The billing method of the subscription instance. You can set the parameter `period`.
	UsedTime pulumi.IntPtrOutput `pulumi:"usedTime"`
}

Provides a Dts Instance resource.

For information about Dts Instance and how to use it, see [What is Instance](https://www.alibabacloud.com/help/en/data-transmission-service/latest/createdtsinstance).

> **NOTE:** Available since v1.198.0.

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{
			Status: pulumi.StringRef("OK"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetRegions, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = dts.NewInstance(ctx, "default", &dts.InstanceArgs{
			Type:                          pulumi.String("sync"),
			ResourceGroupId:               pulumi.String(_default.Ids[0]),
			PaymentType:                   pulumi.String("Subscription"),
			InstanceClass:                 pulumi.String("large"),
			SourceEndpointEngineName:      pulumi.String("MySQL"),
			SourceRegion:                  pulumi.String(defaultGetRegions.Regions[0].Id),
			DestinationEndpointEngineName: pulumi.String("MySQL"),
			DestinationRegion:             pulumi.String(defaultGetRegions.Regions[0].Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Dts Instance can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/instance:Instance example <id> ```

func GetInstance added in v3.31.0

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InstanceState, opts ...pulumi.ResourceOption) (*Instance, error)

GetInstance gets an existing Instance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstance added in v3.31.0

func NewInstance(ctx *pulumi.Context,
	name string, args *InstanceArgs, opts ...pulumi.ResourceOption) (*Instance, error)

NewInstance registers a new resource with the given unique name, arguments, and options.

func (*Instance) ElementType added in v3.31.0

func (*Instance) ElementType() reflect.Type

func (*Instance) ToInstanceOutput added in v3.31.0

func (i *Instance) ToInstanceOutput() InstanceOutput

func (*Instance) ToInstanceOutputWithContext added in v3.31.0

func (i *Instance) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

type InstanceArgs added in v3.31.0

type InstanceArgs struct {
	// Whether to automatically renew the fee when it expires. Valid values:
	// - **false**: No, the default value.
	// - **true**: Yes.
	AutoPay pulumi.BoolPtrInput
	// Whether to start the task automatically after the purchase is completed. Value:
	// - **false**: No, the default value.
	// - **true**: Yes.
	AutoStart pulumi.BoolPtrInput
	// Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. **NOTE:** Enter this parameter and enable ETL to clean and convert data.
	ComputeUnit pulumi.IntPtrInput
	// The number of private custom RDS instances in the PolarDB-X. The default value is **1**. **NOTE:** This parameter is required only when **source_endpoint_engine_name** is **DRDS**.
	DatabaseCount pulumi.IntPtrInput
	// The target database engine type.
	// - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL).
	// - **PolarDB**:PolarDB MySQL.
	// - **polardb_o**:PolarDB O engine.
	// - **polardb_pg**:PolarDB PostgreSQL.
	// - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis).
	// - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0.
	// - **PostgreSQL**: User-created PostgreSQL.
	// - **ODPS**:MaxCompute project.
	// - **oracle**: self-built Oracle.
	// - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
	// - **tidb**:TiDB database.
	// - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0.
	// - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0.
	// - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL.
	// - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server).
	// - **kafka**:Kafka databases (including Kafka and self-built Kafka).
	// - **DataHub**: DataHub, an Alibaba cloud streaming data service.
	// - **clickhouse**: ClickHouse.
	// - **DB2**: self-built DB2 LUW.
	// - **as400**:AS/400.
	// - **Tablestore**: Tablestore.
	// - **NOTE:**
	// - The default value is **MySQL**.
	// - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios).
	// - This parameter or **job_id** must be passed in.
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The target instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.
	DestinationRegion pulumi.StringPtrInput
	// Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: **1** ~ **100**. **NOTE:** The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
	Du pulumi.IntPtrInput
	// Subscription billing type, Valid values: `ONLY_CONFIGURATION_FEE`: charges only configuration fees; `CONFIGURATION_FEE_AND_DATA_FEE`: charges configuration fees and data traffic fees.
	FeeType pulumi.StringPtrInput
	// The type of the migration or synchronization instance.
	// - The specifications of the migration instance: **xxlarge**, **xlarge**, **large**, **medium**, **small**.
	// - The types of synchronization instances: **large**, **medium**, **small**, **micro**.
	// - **NOTE:** For performance descriptions of different specifications, see [Data Migration Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/cd773b) and [Data Synchronization Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/6bce7c).
	InstanceClass pulumi.StringPtrInput
	// The ID of the task obtained by calling the **ConfigureDtsJob** operation (**DtsJobId**).> After you pass in this parameter, you do not need to pass the **source_region**, **destination_region**, **type**, **source_endpoint_engine_name**, or **destination_endpoint_engine_name** parameters. Even if the input is passed in, the configuration in **job_id** shall prevail.
	JobId pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringPtrInput
	// The billing method of the subscription instance. Value: `Year`, `Month`. **NOTE:** This parameter is valid and must be passed in only when `paymentType` is `Subscription`.
	Period pulumi.StringPtrInput
	// Resource Group ID.
	ResourceGroupId pulumi.StringPtrInput
	// Source instance database engine type.
	// - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL).
	// - **PolarDB**:PolarDB MySQL.
	// - **polardb_o**:PolarDB O engine.
	// - **polardb_pg**:PolarDB PostgreSQL.
	// - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis).
	// - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0.
	// - **PostgreSQL**: User-created PostgreSQL.
	// - **ODPS**:MaxCompute.
	// - **oracle**: self-built Oracle.
	// - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
	// - **tidb**:TiDB database.
	// - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0.
	// - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0.
	// - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL.
	// - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server).
	// - **kafka**:Kafka databases (including Kafka and self-built Kafka).
	// - **DataHub**: DataHub, an Alibaba cloud streaming data service.
	// - **clickhouse**: ClickHouse.
	// - **DB2**: self-built DB2 LUW.
	// - **as400**:AS/400.
	// - **Tablestore**: Tablestore.
	// - **NOTE:**
	// - The default value is **MySQL**.
	// - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios).
	// - This parameter or **job_id** must be passed in.
	SourceEndpointEngineName pulumi.StringPtrInput
	// The source instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.
	SourceRegion pulumi.StringPtrInput
	// Synchronization topology, value:
	// - **oneway**: one-way synchronization, the default value.
	// - **bidirectional**: two-way synchronization.
	SyncArchitecture pulumi.StringPtrInput
	// The synchronization direction. Default value: `Forward`. Valid values:
	SynchronizationDirection pulumi.StringPtrInput
	// The tag value corresponding to the tag key.See the following `Block Tags`.
	Tags pulumi.MapInput
	// The instance type. Valid values:
	// - **migration**: MIGRATION.
	// - **sync**: synchronization.
	// - **subscribe**: SUBSCRIBE.
	// - **NOTE:** This parameter or **job_id** must be passed in.
	Type pulumi.StringPtrInput
	// Prepaid instance purchase duration.
	// - When **period** is **Month**, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
	// - When **Period** is **Year**, the values are 1, 2, 3, and 5.
	// - **NOTE:**
	// - This parameter is valid and must be passed in only when **payment_type** is `Subscription`.
	// - The billing method of the subscription instance. You can set the parameter `period`.
	UsedTime pulumi.IntPtrInput
}

The set of arguments for constructing a Instance resource.

func (InstanceArgs) ElementType added in v3.31.0

func (InstanceArgs) ElementType() reflect.Type

type InstanceArray added in v3.31.0

type InstanceArray []InstanceInput

func (InstanceArray) ElementType added in v3.31.0

func (InstanceArray) ElementType() reflect.Type

func (InstanceArray) ToInstanceArrayOutput added in v3.31.0

func (i InstanceArray) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArray) ToInstanceArrayOutputWithContext added in v3.31.0

func (i InstanceArray) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceArrayInput added in v3.31.0

type InstanceArrayInput interface {
	pulumi.Input

	ToInstanceArrayOutput() InstanceArrayOutput
	ToInstanceArrayOutputWithContext(context.Context) InstanceArrayOutput
}

InstanceArrayInput is an input type that accepts InstanceArray and InstanceArrayOutput values. You can construct a concrete instance of `InstanceArrayInput` via:

InstanceArray{ InstanceArgs{...} }

type InstanceArrayOutput added in v3.31.0

type InstanceArrayOutput struct{ *pulumi.OutputState }

func (InstanceArrayOutput) ElementType added in v3.31.0

func (InstanceArrayOutput) ElementType() reflect.Type

func (InstanceArrayOutput) Index added in v3.31.0

func (InstanceArrayOutput) ToInstanceArrayOutput added in v3.31.0

func (o InstanceArrayOutput) ToInstanceArrayOutput() InstanceArrayOutput

func (InstanceArrayOutput) ToInstanceArrayOutputWithContext added in v3.31.0

func (o InstanceArrayOutput) ToInstanceArrayOutputWithContext(ctx context.Context) InstanceArrayOutput

type InstanceInput added in v3.31.0

type InstanceInput interface {
	pulumi.Input

	ToInstanceOutput() InstanceOutput
	ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
}

type InstanceMap added in v3.31.0

type InstanceMap map[string]InstanceInput

func (InstanceMap) ElementType added in v3.31.0

func (InstanceMap) ElementType() reflect.Type

func (InstanceMap) ToInstanceMapOutput added in v3.31.0

func (i InstanceMap) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMap) ToInstanceMapOutputWithContext added in v3.31.0

func (i InstanceMap) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceMapInput added in v3.31.0

type InstanceMapInput interface {
	pulumi.Input

	ToInstanceMapOutput() InstanceMapOutput
	ToInstanceMapOutputWithContext(context.Context) InstanceMapOutput
}

InstanceMapInput is an input type that accepts InstanceMap and InstanceMapOutput values. You can construct a concrete instance of `InstanceMapInput` via:

InstanceMap{ "key": InstanceArgs{...} }

type InstanceMapOutput added in v3.31.0

type InstanceMapOutput struct{ *pulumi.OutputState }

func (InstanceMapOutput) ElementType added in v3.31.0

func (InstanceMapOutput) ElementType() reflect.Type

func (InstanceMapOutput) MapIndex added in v3.31.0

func (InstanceMapOutput) ToInstanceMapOutput added in v3.31.0

func (o InstanceMapOutput) ToInstanceMapOutput() InstanceMapOutput

func (InstanceMapOutput) ToInstanceMapOutputWithContext added in v3.31.0

func (o InstanceMapOutput) ToInstanceMapOutputWithContext(ctx context.Context) InstanceMapOutput

type InstanceOutput added in v3.31.0

type InstanceOutput struct{ *pulumi.OutputState }

func (InstanceOutput) AutoPay added in v3.31.0

func (o InstanceOutput) AutoPay() pulumi.BoolPtrOutput

Whether to automatically renew the fee when it expires. Valid values: - **false**: No, the default value. - **true**: Yes.

func (InstanceOutput) AutoStart added in v3.31.0

func (o InstanceOutput) AutoStart() pulumi.BoolPtrOutput

Whether to start the task automatically after the purchase is completed. Value: - **false**: No, the default value. - **true**: Yes.

func (InstanceOutput) ComputeUnit added in v3.31.0

func (o InstanceOutput) ComputeUnit() pulumi.IntPtrOutput

Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. **NOTE:** Enter this parameter and enable ETL to clean and convert data.

func (InstanceOutput) CreateTime added in v3.31.0

func (o InstanceOutput) CreateTime() pulumi.StringOutput

Instance creation time

func (InstanceOutput) DatabaseCount added in v3.31.0

func (o InstanceOutput) DatabaseCount() pulumi.IntOutput

The number of private custom RDS instances in the PolarDB-X. The default value is **1**. **NOTE:** This parameter is required only when **source_endpoint_engine_name** is **DRDS**.

func (InstanceOutput) DestinationEndpointEngineName added in v3.31.0

func (o InstanceOutput) DestinationEndpointEngineName() pulumi.StringOutput

The target database engine type. - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL). - **PolarDB**:PolarDB MySQL. - **polardb_o**:PolarDB O engine. - **polardb_pg**:PolarDB PostgreSQL. - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis). - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0. - **PostgreSQL**: User-created PostgreSQL. - **ODPS**:MaxCompute project. - **oracle**: self-built Oracle. - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB). - **tidb**:TiDB database. - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0. - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0. - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL. - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server). - **kafka**:Kafka databases (including Kafka and self-built Kafka). - **DataHub**: DataHub, an Alibaba cloud streaming data service. - **clickhouse**: ClickHouse. - **DB2**: self-built DB2 LUW. - **as400**:AS/400. - **Tablestore**: Tablestore. - **NOTE:** - The default value is **MySQL**. - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios). - This parameter or **job_id** must be passed in.

func (InstanceOutput) DestinationRegion added in v3.31.0

func (o InstanceOutput) DestinationRegion() pulumi.StringPtrOutput

The target instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.

func (InstanceOutput) DtsInstanceId added in v3.31.0

func (o InstanceOutput) DtsInstanceId() pulumi.StringOutput

The ID of the subscription instance.

func (InstanceOutput) Du added in v3.31.0

Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: **1** ~ **100**. **NOTE:** The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.

func (InstanceOutput) ElementType added in v3.31.0

func (InstanceOutput) ElementType() reflect.Type

func (InstanceOutput) FeeType added in v3.31.0

Subscription billing type, Valid values: `ONLY_CONFIGURATION_FEE`: charges only configuration fees; `CONFIGURATION_FEE_AND_DATA_FEE`: charges configuration fees and data traffic fees.

func (InstanceOutput) InstanceClass added in v3.31.0

func (o InstanceOutput) InstanceClass() pulumi.StringPtrOutput

The type of the migration or synchronization instance. - The specifications of the migration instance: **xxlarge**, **xlarge**, **large**, **medium**, **small**. - The types of synchronization instances: **large**, **medium**, **small**, **micro**. - **NOTE:** For performance descriptions of different specifications, see [Data Migration Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/cd773b) and [Data Synchronization Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/6bce7c).

func (InstanceOutput) InstanceName added in v3.31.0

func (o InstanceOutput) InstanceName() pulumi.StringOutput

The name of Dts instance.

func (InstanceOutput) JobId added in v3.31.0

The ID of the task obtained by calling the **ConfigureDtsJob** operation (**DtsJobId**).> After you pass in this parameter, you do not need to pass the **source_region**, **destination_region**, **type**, **source_endpoint_engine_name**, or **destination_endpoint_engine_name** parameters. Even if the input is passed in, the configuration in **job_id** shall prevail.

func (InstanceOutput) PaymentType added in v3.31.0

func (o InstanceOutput) PaymentType() pulumi.StringPtrOutput

The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.

func (InstanceOutput) Period added in v3.31.0

The billing method of the subscription instance. Value: `Year`, `Month`. **NOTE:** This parameter is valid and must be passed in only when `paymentType` is `Subscription`.

func (InstanceOutput) ResourceGroupId added in v3.31.0

func (o InstanceOutput) ResourceGroupId() pulumi.StringOutput

Resource Group ID.

func (InstanceOutput) SourceEndpointEngineName added in v3.31.0

func (o InstanceOutput) SourceEndpointEngineName() pulumi.StringOutput

Source instance database engine type. - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL). - **PolarDB**:PolarDB MySQL. - **polardb_o**:PolarDB O engine. - **polardb_pg**:PolarDB PostgreSQL. - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis). - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0. - **PostgreSQL**: User-created PostgreSQL. - **ODPS**:MaxCompute. - **oracle**: self-built Oracle. - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB). - **tidb**:TiDB database. - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0. - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0. - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL. - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server). - **kafka**:Kafka databases (including Kafka and self-built Kafka). - **DataHub**: DataHub, an Alibaba cloud streaming data service. - **clickhouse**: ClickHouse. - **DB2**: self-built DB2 LUW. - **as400**:AS/400. - **Tablestore**: Tablestore. - **NOTE:** - The default value is **MySQL**. - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios). - This parameter or **job_id** must be passed in.

func (InstanceOutput) SourceRegion added in v3.31.0

func (o InstanceOutput) SourceRegion() pulumi.StringPtrOutput

The source instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.

func (InstanceOutput) Status added in v3.31.0

func (o InstanceOutput) Status() pulumi.StringOutput

Instance status.

func (InstanceOutput) SyncArchitecture added in v3.31.0

func (o InstanceOutput) SyncArchitecture() pulumi.StringPtrOutput

Synchronization topology, value: - **oneway**: one-way synchronization, the default value. - **bidirectional**: two-way synchronization.

func (InstanceOutput) SynchronizationDirection added in v3.31.0

func (o InstanceOutput) SynchronizationDirection() pulumi.StringPtrOutput

The synchronization direction. Default value: `Forward`. Valid values:

func (InstanceOutput) Tags added in v3.31.0

func (o InstanceOutput) Tags() pulumi.MapOutput

The tag value corresponding to the tag key.See the following `Block Tags`.

func (InstanceOutput) ToInstanceOutput added in v3.31.0

func (o InstanceOutput) ToInstanceOutput() InstanceOutput

func (InstanceOutput) ToInstanceOutputWithContext added in v3.31.0

func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (InstanceOutput) Type added in v3.31.0

The instance type. Valid values: - **migration**: MIGRATION. - **sync**: synchronization. - **subscribe**: SUBSCRIBE. - **NOTE:** This parameter or **job_id** must be passed in.

func (InstanceOutput) UsedTime added in v3.31.0

func (o InstanceOutput) UsedTime() pulumi.IntPtrOutput

Prepaid instance purchase duration. - When **period** is **Month**, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9. - When **Period** is **Year**, the values are 1, 2, 3, and 5. - **NOTE:** - This parameter is valid and must be passed in only when **payment_type** is `Subscription`. - The billing method of the subscription instance. You can set the parameter `period`.

type InstanceState added in v3.31.0

type InstanceState struct {
	// Whether to automatically renew the fee when it expires. Valid values:
	// - **false**: No, the default value.
	// - **true**: Yes.
	AutoPay pulumi.BoolPtrInput
	// Whether to start the task automatically after the purchase is completed. Value:
	// - **false**: No, the default value.
	// - **true**: Yes.
	AutoStart pulumi.BoolPtrInput
	// Specifications of ETL. The unit is compute unit (CU),1CU = 1vCPU +4GB of memory. The value range is an integer greater than or equal to 2. **NOTE:** Enter this parameter and enable ETL to clean and convert data.
	ComputeUnit pulumi.IntPtrInput
	// Instance creation time
	CreateTime pulumi.StringPtrInput
	// The number of private custom RDS instances in the PolarDB-X. The default value is **1**. **NOTE:** This parameter is required only when **source_endpoint_engine_name** is **DRDS**.
	DatabaseCount pulumi.IntPtrInput
	// The target database engine type.
	// - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL).
	// - **PolarDB**:PolarDB MySQL.
	// - **polardb_o**:PolarDB O engine.
	// - **polardb_pg**:PolarDB PostgreSQL.
	// - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis).
	// - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0.
	// - **PostgreSQL**: User-created PostgreSQL.
	// - **ODPS**:MaxCompute project.
	// - **oracle**: self-built Oracle.
	// - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
	// - **tidb**:TiDB database.
	// - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0.
	// - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0.
	// - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL.
	// - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server).
	// - **kafka**:Kafka databases (including Kafka and self-built Kafka).
	// - **DataHub**: DataHub, an Alibaba cloud streaming data service.
	// - **clickhouse**: ClickHouse.
	// - **DB2**: self-built DB2 LUW.
	// - **as400**:AS/400.
	// - **Tablestore**: Tablestore.
	// - **NOTE:**
	// - The default value is **MySQL**.
	// - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios).
	// - This parameter or **job_id** must be passed in.
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The target instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.
	DestinationRegion pulumi.StringPtrInput
	// The ID of the subscription instance.
	DtsInstanceId pulumi.StringPtrInput
	// Assign a specified number of DU resources to DTS tasks in the DTS exclusive cluster. Valid values: **1** ~ **100**. **NOTE:** The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.
	Du pulumi.IntPtrInput
	// Subscription billing type, Valid values: `ONLY_CONFIGURATION_FEE`: charges only configuration fees; `CONFIGURATION_FEE_AND_DATA_FEE`: charges configuration fees and data traffic fees.
	FeeType pulumi.StringPtrInput
	// The type of the migration or synchronization instance.
	// - The specifications of the migration instance: **xxlarge**, **xlarge**, **large**, **medium**, **small**.
	// - The types of synchronization instances: **large**, **medium**, **small**, **micro**.
	// - **NOTE:** For performance descriptions of different specifications, see [Data Migration Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/cd773b) and [Data Synchronization Link Specifications](https://www.alibabacloud.com/help/en/data-transmission-service/latest/6bce7c).
	InstanceClass pulumi.StringPtrInput
	// The name of Dts instance.
	InstanceName pulumi.StringPtrInput
	// The ID of the task obtained by calling the **ConfigureDtsJob** operation (**DtsJobId**).> After you pass in this parameter, you do not need to pass the **source_region**, **destination_region**, **type**, **source_endpoint_engine_name**, or **destination_endpoint_engine_name** parameters. Even if the input is passed in, the configuration in **job_id** shall prevail.
	JobId pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringPtrInput
	// The billing method of the subscription instance. Value: `Year`, `Month`. **NOTE:** This parameter is valid and must be passed in only when `paymentType` is `Subscription`.
	Period pulumi.StringPtrInput
	// Resource Group ID.
	ResourceGroupId pulumi.StringPtrInput
	// Source instance database engine type.
	// - **MySQL**:MySQL databases (including RDS MySQL and self-built MySQL).
	// - **PolarDB**:PolarDB MySQL.
	// - **polardb_o**:PolarDB O engine.
	// - **polardb_pg**:PolarDB PostgreSQL.
	// - **Redis**:Redis databases (including apsaradb for Redis and user-created Redis).
	// - **DRDS**: cloud-native distributed database PolarDB-X 1.0 and 2.0.
	// - **PostgreSQL**: User-created PostgreSQL.
	// - **ODPS**:MaxCompute.
	// - **oracle**: self-built Oracle.
	// - **mongodb**:MongoDB databases (including apsaradb for MongoDB and user-created MongoDB).
	// - **tidb**:TiDB database.
	// - **ADS**: Cloud native data warehouse AnalyticDB MySQL 2.0.
	// - **ADB30**: Cloud native data warehouse AnalyticDB MySQL 3.0.
	// - **Greenplum**: Cloud native data warehouse AnalyticDB PostgreSQL.
	// - **MSSQL**:SQL Server databases (including RDS SQL Server and self-built SQL Server).
	// - **kafka**:Kafka databases (including Kafka and self-built Kafka).
	// - **DataHub**: DataHub, an Alibaba cloud streaming data service.
	// - **clickhouse**: ClickHouse.
	// - **DB2**: self-built DB2 LUW.
	// - **as400**:AS/400.
	// - **Tablestore**: Tablestore.
	// - **NOTE:**
	// - The default value is **MySQL**.
	// - For more information about the supported source and destination databases, see [Database, Synchronization Initialization Type, and Synchronization Topology](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-synchronization-scenarios-1) and [Supported Database and Migration Type](https://www.alibabacloud.com/help/en/data-transmission-service/latest/overview-of-data-migration-scenarios).
	// - This parameter or **job_id** must be passed in.
	SourceEndpointEngineName pulumi.StringPtrInput
	// The source instance region. For more information, see [List of supported regions](https://www.alibabacloud.com/help/en/data-transmission-service/latest/list-of-supported-regions). **NOTE:** This parameter or **job_id** must be passed in.
	SourceRegion pulumi.StringPtrInput
	// Instance status.
	Status pulumi.StringPtrInput
	// Synchronization topology, value:
	// - **oneway**: one-way synchronization, the default value.
	// - **bidirectional**: two-way synchronization.
	SyncArchitecture pulumi.StringPtrInput
	// The synchronization direction. Default value: `Forward`. Valid values:
	SynchronizationDirection pulumi.StringPtrInput
	// The tag value corresponding to the tag key.See the following `Block Tags`.
	Tags pulumi.MapInput
	// The instance type. Valid values:
	// - **migration**: MIGRATION.
	// - **sync**: synchronization.
	// - **subscribe**: SUBSCRIBE.
	// - **NOTE:** This parameter or **job_id** must be passed in.
	Type pulumi.StringPtrInput
	// Prepaid instance purchase duration.
	// - When **period** is **Month**, the values are: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
	// - When **Period** is **Year**, the values are 1, 2, 3, and 5.
	// - **NOTE:**
	// - This parameter is valid and must be passed in only when **payment_type** is `Subscription`.
	// - The billing method of the subscription instance. You can set the parameter `period`.
	UsedTime pulumi.IntPtrInput
}

func (InstanceState) ElementType added in v3.31.0

func (InstanceState) ElementType() reflect.Type

type JobMonitorRule

type JobMonitorRule struct {
	pulumi.CustomResourceState

	// Trigger delay alarm threshold, which is measured in seconds.
	DelayRuleTime pulumi.StringOutput `pulumi:"delayRuleTime"`
	// Migration, synchronization or subscription task ID can be by calling the [DescribeDtsJobs] get.
	DtsJobId pulumi.StringOutput `pulumi:"dtsJobId"`
	// The alarm is triggered after notification of the contact phone number, A plurality of phone numbers between them with a comma (,) to separate.
	Phone pulumi.StringPtrOutput `pulumi:"phone"`
	// Whether to enable monitoring rules, valid values: `Y`, `N`.
	State pulumi.StringOutput `pulumi:"state"`
	// Monitoring rules of type, valid values: `delay`, `error`. **delay**: delay alarm. **error**: abnormal alarm.
	Type pulumi.StringOutput `pulumi:"type"`
}

Provides a DTS Job Monitor Rule resource.

For information about DTS Job Monitor Rule and how to use it, see [What is Job Monitor Rule](https://www.aliyun.com/product/dts).

> **NOTE:** Available since v1.134.0.

## Import

DTS Job Monitor Rule can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/jobMonitorRule:JobMonitorRule example <dts_job_id> ```

func GetJobMonitorRule

func GetJobMonitorRule(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *JobMonitorRuleState, opts ...pulumi.ResourceOption) (*JobMonitorRule, error)

GetJobMonitorRule gets an existing JobMonitorRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewJobMonitorRule

func NewJobMonitorRule(ctx *pulumi.Context,
	name string, args *JobMonitorRuleArgs, opts ...pulumi.ResourceOption) (*JobMonitorRule, error)

NewJobMonitorRule registers a new resource with the given unique name, arguments, and options.

func (*JobMonitorRule) ElementType

func (*JobMonitorRule) ElementType() reflect.Type

func (*JobMonitorRule) ToJobMonitorRuleOutput

func (i *JobMonitorRule) ToJobMonitorRuleOutput() JobMonitorRuleOutput

func (*JobMonitorRule) ToJobMonitorRuleOutputWithContext

func (i *JobMonitorRule) ToJobMonitorRuleOutputWithContext(ctx context.Context) JobMonitorRuleOutput

type JobMonitorRuleArgs

type JobMonitorRuleArgs struct {
	// Trigger delay alarm threshold, which is measured in seconds.
	DelayRuleTime pulumi.StringPtrInput
	// Migration, synchronization or subscription task ID can be by calling the [DescribeDtsJobs] get.
	DtsJobId pulumi.StringInput
	// The alarm is triggered after notification of the contact phone number, A plurality of phone numbers between them with a comma (,) to separate.
	Phone pulumi.StringPtrInput
	// Whether to enable monitoring rules, valid values: `Y`, `N`.
	State pulumi.StringPtrInput
	// Monitoring rules of type, valid values: `delay`, `error`. **delay**: delay alarm. **error**: abnormal alarm.
	Type pulumi.StringInput
}

The set of arguments for constructing a JobMonitorRule resource.

func (JobMonitorRuleArgs) ElementType

func (JobMonitorRuleArgs) ElementType() reflect.Type

type JobMonitorRuleArray

type JobMonitorRuleArray []JobMonitorRuleInput

func (JobMonitorRuleArray) ElementType

func (JobMonitorRuleArray) ElementType() reflect.Type

func (JobMonitorRuleArray) ToJobMonitorRuleArrayOutput

func (i JobMonitorRuleArray) ToJobMonitorRuleArrayOutput() JobMonitorRuleArrayOutput

func (JobMonitorRuleArray) ToJobMonitorRuleArrayOutputWithContext

func (i JobMonitorRuleArray) ToJobMonitorRuleArrayOutputWithContext(ctx context.Context) JobMonitorRuleArrayOutput

type JobMonitorRuleArrayInput

type JobMonitorRuleArrayInput interface {
	pulumi.Input

	ToJobMonitorRuleArrayOutput() JobMonitorRuleArrayOutput
	ToJobMonitorRuleArrayOutputWithContext(context.Context) JobMonitorRuleArrayOutput
}

JobMonitorRuleArrayInput is an input type that accepts JobMonitorRuleArray and JobMonitorRuleArrayOutput values. You can construct a concrete instance of `JobMonitorRuleArrayInput` via:

JobMonitorRuleArray{ JobMonitorRuleArgs{...} }

type JobMonitorRuleArrayOutput

type JobMonitorRuleArrayOutput struct{ *pulumi.OutputState }

func (JobMonitorRuleArrayOutput) ElementType

func (JobMonitorRuleArrayOutput) ElementType() reflect.Type

func (JobMonitorRuleArrayOutput) Index

func (JobMonitorRuleArrayOutput) ToJobMonitorRuleArrayOutput

func (o JobMonitorRuleArrayOutput) ToJobMonitorRuleArrayOutput() JobMonitorRuleArrayOutput

func (JobMonitorRuleArrayOutput) ToJobMonitorRuleArrayOutputWithContext

func (o JobMonitorRuleArrayOutput) ToJobMonitorRuleArrayOutputWithContext(ctx context.Context) JobMonitorRuleArrayOutput

type JobMonitorRuleInput

type JobMonitorRuleInput interface {
	pulumi.Input

	ToJobMonitorRuleOutput() JobMonitorRuleOutput
	ToJobMonitorRuleOutputWithContext(ctx context.Context) JobMonitorRuleOutput
}

type JobMonitorRuleMap

type JobMonitorRuleMap map[string]JobMonitorRuleInput

func (JobMonitorRuleMap) ElementType

func (JobMonitorRuleMap) ElementType() reflect.Type

func (JobMonitorRuleMap) ToJobMonitorRuleMapOutput

func (i JobMonitorRuleMap) ToJobMonitorRuleMapOutput() JobMonitorRuleMapOutput

func (JobMonitorRuleMap) ToJobMonitorRuleMapOutputWithContext

func (i JobMonitorRuleMap) ToJobMonitorRuleMapOutputWithContext(ctx context.Context) JobMonitorRuleMapOutput

type JobMonitorRuleMapInput

type JobMonitorRuleMapInput interface {
	pulumi.Input

	ToJobMonitorRuleMapOutput() JobMonitorRuleMapOutput
	ToJobMonitorRuleMapOutputWithContext(context.Context) JobMonitorRuleMapOutput
}

JobMonitorRuleMapInput is an input type that accepts JobMonitorRuleMap and JobMonitorRuleMapOutput values. You can construct a concrete instance of `JobMonitorRuleMapInput` via:

JobMonitorRuleMap{ "key": JobMonitorRuleArgs{...} }

type JobMonitorRuleMapOutput

type JobMonitorRuleMapOutput struct{ *pulumi.OutputState }

func (JobMonitorRuleMapOutput) ElementType

func (JobMonitorRuleMapOutput) ElementType() reflect.Type

func (JobMonitorRuleMapOutput) MapIndex

func (JobMonitorRuleMapOutput) ToJobMonitorRuleMapOutput

func (o JobMonitorRuleMapOutput) ToJobMonitorRuleMapOutput() JobMonitorRuleMapOutput

func (JobMonitorRuleMapOutput) ToJobMonitorRuleMapOutputWithContext

func (o JobMonitorRuleMapOutput) ToJobMonitorRuleMapOutputWithContext(ctx context.Context) JobMonitorRuleMapOutput

type JobMonitorRuleOutput

type JobMonitorRuleOutput struct{ *pulumi.OutputState }

func (JobMonitorRuleOutput) DelayRuleTime added in v3.27.0

func (o JobMonitorRuleOutput) DelayRuleTime() pulumi.StringOutput

Trigger delay alarm threshold, which is measured in seconds.

func (JobMonitorRuleOutput) DtsJobId added in v3.27.0

Migration, synchronization or subscription task ID can be by calling the [DescribeDtsJobs] get.

func (JobMonitorRuleOutput) ElementType

func (JobMonitorRuleOutput) ElementType() reflect.Type

func (JobMonitorRuleOutput) Phone added in v3.27.0

The alarm is triggered after notification of the contact phone number, A plurality of phone numbers between them with a comma (,) to separate.

func (JobMonitorRuleOutput) State added in v3.27.0

Whether to enable monitoring rules, valid values: `Y`, `N`.

func (JobMonitorRuleOutput) ToJobMonitorRuleOutput

func (o JobMonitorRuleOutput) ToJobMonitorRuleOutput() JobMonitorRuleOutput

func (JobMonitorRuleOutput) ToJobMonitorRuleOutputWithContext

func (o JobMonitorRuleOutput) ToJobMonitorRuleOutputWithContext(ctx context.Context) JobMonitorRuleOutput

func (JobMonitorRuleOutput) Type added in v3.27.0

Monitoring rules of type, valid values: `delay`, `error`. **delay**: delay alarm. **error**: abnormal alarm.

type JobMonitorRuleState

type JobMonitorRuleState struct {
	// Trigger delay alarm threshold, which is measured in seconds.
	DelayRuleTime pulumi.StringPtrInput
	// Migration, synchronization or subscription task ID can be by calling the [DescribeDtsJobs] get.
	DtsJobId pulumi.StringPtrInput
	// The alarm is triggered after notification of the contact phone number, A plurality of phone numbers between them with a comma (,) to separate.
	Phone pulumi.StringPtrInput
	// Whether to enable monitoring rules, valid values: `Y`, `N`.
	State pulumi.StringPtrInput
	// Monitoring rules of type, valid values: `delay`, `error`. **delay**: delay alarm. **error**: abnormal alarm.
	Type pulumi.StringPtrInput
}

func (JobMonitorRuleState) ElementType

func (JobMonitorRuleState) ElementType() reflect.Type

type MigrationInstance added in v3.18.0

type MigrationInstance struct {
	pulumi.CustomResourceState

	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrOutput `pulumi:"computeUnit"`
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrOutput `pulumi:"databaseCount"`
	// The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	DestinationEndpointEngineName pulumi.StringOutput `pulumi:"destinationEndpointEngineName"`
	// The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationEndpointRegion pulumi.StringOutput `pulumi:"destinationEndpointRegion"`
	// The ID of the Migration Instance.
	DtsInstanceId pulumi.StringOutput `pulumi:"dtsInstanceId"`
	// The instance class. Valid values: `large`, `medium`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringOutput `pulumi:"instanceClass"`
	// The payment type of the resource. Valid values: `PayAsYouGo`.
	PaymentType pulumi.StringOutput `pulumi:"paymentType"`
	// The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	SourceEndpointEngineName pulumi.StringOutput `pulumi:"sourceEndpointEngineName"`
	// The region of source instance.
	SourceEndpointRegion pulumi.StringOutput `pulumi:"sourceEndpointRegion"`
	// The status.
	Status pulumi.StringOutput `pulumi:"status"`
	// The sync architecture. Valid values: `oneway`.
	SyncArchitecture pulumi.StringPtrOutput `pulumi:"syncArchitecture"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Provides a DTS Migration Instance resource.

For information about DTS Migration Instance and how to use it, see [What is Synchronization Instance](https://www.alibabacloud.com/help/en/doc-detail/208270.html).

> **NOTE:** Available since v1.157.0.

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = dts.NewMigrationInstance(ctx, "default", &dts.MigrationInstanceArgs{
			PaymentType:                   pulumi.String("PayAsYouGo"),
			SourceEndpointEngineName:      pulumi.String("MySQL"),
			SourceEndpointRegion:          pulumi.String(_default.Regions[0].Id),
			DestinationEndpointEngineName: pulumi.String("MySQL"),
			DestinationEndpointRegion:     pulumi.String(_default.Regions[0].Id),
			InstanceClass:                 pulumi.String("small"),
			SyncArchitecture:              pulumi.String("oneway"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

DTS Migration Instance can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/migrationInstance:MigrationInstance example <id> ```

func GetMigrationInstance added in v3.18.0

func GetMigrationInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MigrationInstanceState, opts ...pulumi.ResourceOption) (*MigrationInstance, error)

GetMigrationInstance gets an existing MigrationInstance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMigrationInstance added in v3.18.0

func NewMigrationInstance(ctx *pulumi.Context,
	name string, args *MigrationInstanceArgs, opts ...pulumi.ResourceOption) (*MigrationInstance, error)

NewMigrationInstance registers a new resource with the given unique name, arguments, and options.

func (*MigrationInstance) ElementType added in v3.18.0

func (*MigrationInstance) ElementType() reflect.Type

func (*MigrationInstance) ToMigrationInstanceOutput added in v3.18.0

func (i *MigrationInstance) ToMigrationInstanceOutput() MigrationInstanceOutput

func (*MigrationInstance) ToMigrationInstanceOutputWithContext added in v3.18.0

func (i *MigrationInstance) ToMigrationInstanceOutputWithContext(ctx context.Context) MigrationInstanceOutput

type MigrationInstanceArgs added in v3.18.0

type MigrationInstanceArgs struct {
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrInput
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrInput
	// The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	DestinationEndpointEngineName pulumi.StringInput
	// The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationEndpointRegion pulumi.StringInput
	// The instance class. Valid values: `large`, `medium`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `PayAsYouGo`.
	PaymentType pulumi.StringInput
	// The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	SourceEndpointEngineName pulumi.StringInput
	// The region of source instance.
	SourceEndpointRegion pulumi.StringInput
	// The sync architecture. Valid values: `oneway`.
	SyncArchitecture pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
}

The set of arguments for constructing a MigrationInstance resource.

func (MigrationInstanceArgs) ElementType added in v3.18.0

func (MigrationInstanceArgs) ElementType() reflect.Type

type MigrationInstanceArray added in v3.18.0

type MigrationInstanceArray []MigrationInstanceInput

func (MigrationInstanceArray) ElementType added in v3.18.0

func (MigrationInstanceArray) ElementType() reflect.Type

func (MigrationInstanceArray) ToMigrationInstanceArrayOutput added in v3.18.0

func (i MigrationInstanceArray) ToMigrationInstanceArrayOutput() MigrationInstanceArrayOutput

func (MigrationInstanceArray) ToMigrationInstanceArrayOutputWithContext added in v3.18.0

func (i MigrationInstanceArray) ToMigrationInstanceArrayOutputWithContext(ctx context.Context) MigrationInstanceArrayOutput

type MigrationInstanceArrayInput added in v3.18.0

type MigrationInstanceArrayInput interface {
	pulumi.Input

	ToMigrationInstanceArrayOutput() MigrationInstanceArrayOutput
	ToMigrationInstanceArrayOutputWithContext(context.Context) MigrationInstanceArrayOutput
}

MigrationInstanceArrayInput is an input type that accepts MigrationInstanceArray and MigrationInstanceArrayOutput values. You can construct a concrete instance of `MigrationInstanceArrayInput` via:

MigrationInstanceArray{ MigrationInstanceArgs{...} }

type MigrationInstanceArrayOutput added in v3.18.0

type MigrationInstanceArrayOutput struct{ *pulumi.OutputState }

func (MigrationInstanceArrayOutput) ElementType added in v3.18.0

func (MigrationInstanceArrayOutput) Index added in v3.18.0

func (MigrationInstanceArrayOutput) ToMigrationInstanceArrayOutput added in v3.18.0

func (o MigrationInstanceArrayOutput) ToMigrationInstanceArrayOutput() MigrationInstanceArrayOutput

func (MigrationInstanceArrayOutput) ToMigrationInstanceArrayOutputWithContext added in v3.18.0

func (o MigrationInstanceArrayOutput) ToMigrationInstanceArrayOutputWithContext(ctx context.Context) MigrationInstanceArrayOutput

type MigrationInstanceInput added in v3.18.0

type MigrationInstanceInput interface {
	pulumi.Input

	ToMigrationInstanceOutput() MigrationInstanceOutput
	ToMigrationInstanceOutputWithContext(ctx context.Context) MigrationInstanceOutput
}

type MigrationInstanceMap added in v3.18.0

type MigrationInstanceMap map[string]MigrationInstanceInput

func (MigrationInstanceMap) ElementType added in v3.18.0

func (MigrationInstanceMap) ElementType() reflect.Type

func (MigrationInstanceMap) ToMigrationInstanceMapOutput added in v3.18.0

func (i MigrationInstanceMap) ToMigrationInstanceMapOutput() MigrationInstanceMapOutput

func (MigrationInstanceMap) ToMigrationInstanceMapOutputWithContext added in v3.18.0

func (i MigrationInstanceMap) ToMigrationInstanceMapOutputWithContext(ctx context.Context) MigrationInstanceMapOutput

type MigrationInstanceMapInput added in v3.18.0

type MigrationInstanceMapInput interface {
	pulumi.Input

	ToMigrationInstanceMapOutput() MigrationInstanceMapOutput
	ToMigrationInstanceMapOutputWithContext(context.Context) MigrationInstanceMapOutput
}

MigrationInstanceMapInput is an input type that accepts MigrationInstanceMap and MigrationInstanceMapOutput values. You can construct a concrete instance of `MigrationInstanceMapInput` via:

MigrationInstanceMap{ "key": MigrationInstanceArgs{...} }

type MigrationInstanceMapOutput added in v3.18.0

type MigrationInstanceMapOutput struct{ *pulumi.OutputState }

func (MigrationInstanceMapOutput) ElementType added in v3.18.0

func (MigrationInstanceMapOutput) ElementType() reflect.Type

func (MigrationInstanceMapOutput) MapIndex added in v3.18.0

func (MigrationInstanceMapOutput) ToMigrationInstanceMapOutput added in v3.18.0

func (o MigrationInstanceMapOutput) ToMigrationInstanceMapOutput() MigrationInstanceMapOutput

func (MigrationInstanceMapOutput) ToMigrationInstanceMapOutputWithContext added in v3.18.0

func (o MigrationInstanceMapOutput) ToMigrationInstanceMapOutputWithContext(ctx context.Context) MigrationInstanceMapOutput

type MigrationInstanceOutput added in v3.18.0

type MigrationInstanceOutput struct{ *pulumi.OutputState }

func (MigrationInstanceOutput) ComputeUnit added in v3.27.0

[ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.

func (MigrationInstanceOutput) DatabaseCount added in v3.27.0

func (o MigrationInstanceOutput) DatabaseCount() pulumi.IntPtrOutput

The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.

func (MigrationInstanceOutput) DestinationEndpointEngineName added in v3.27.0

func (o MigrationInstanceOutput) DestinationEndpointEngineName() pulumi.StringOutput

The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).

func (MigrationInstanceOutput) DestinationEndpointRegion added in v3.27.0

func (o MigrationInstanceOutput) DestinationEndpointRegion() pulumi.StringOutput

The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).

func (MigrationInstanceOutput) DtsInstanceId added in v3.27.0

func (o MigrationInstanceOutput) DtsInstanceId() pulumi.StringOutput

The ID of the Migration Instance.

func (MigrationInstanceOutput) ElementType added in v3.18.0

func (MigrationInstanceOutput) ElementType() reflect.Type

func (MigrationInstanceOutput) InstanceClass added in v3.27.0

func (o MigrationInstanceOutput) InstanceClass() pulumi.StringOutput

The instance class. Valid values: `large`, `medium`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).

func (MigrationInstanceOutput) PaymentType added in v3.27.0

The payment type of the resource. Valid values: `PayAsYouGo`.

func (MigrationInstanceOutput) SourceEndpointEngineName added in v3.27.0

func (o MigrationInstanceOutput) SourceEndpointEngineName() pulumi.StringOutput

The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).

func (MigrationInstanceOutput) SourceEndpointRegion added in v3.27.0

func (o MigrationInstanceOutput) SourceEndpointRegion() pulumi.StringOutput

The region of source instance.

func (MigrationInstanceOutput) Status added in v3.27.0

The status.

func (MigrationInstanceOutput) SyncArchitecture added in v3.27.0

func (o MigrationInstanceOutput) SyncArchitecture() pulumi.StringPtrOutput

The sync architecture. Valid values: `oneway`.

func (MigrationInstanceOutput) Tags added in v3.27.0

A mapping of tags to assign to the resource.

func (MigrationInstanceOutput) ToMigrationInstanceOutput added in v3.18.0

func (o MigrationInstanceOutput) ToMigrationInstanceOutput() MigrationInstanceOutput

func (MigrationInstanceOutput) ToMigrationInstanceOutputWithContext added in v3.18.0

func (o MigrationInstanceOutput) ToMigrationInstanceOutputWithContext(ctx context.Context) MigrationInstanceOutput

type MigrationInstanceState added in v3.18.0

type MigrationInstanceState struct {
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrInput
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrInput
	// The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationEndpointRegion pulumi.StringPtrInput
	// The ID of the Migration Instance.
	DtsInstanceId pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `PayAsYouGo`.
	PaymentType pulumi.StringPtrInput
	// The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	SourceEndpointEngineName pulumi.StringPtrInput
	// The region of source instance.
	SourceEndpointRegion pulumi.StringPtrInput
	// The status.
	Status pulumi.StringPtrInput
	// The sync architecture. Valid values: `oneway`.
	SyncArchitecture pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
}

func (MigrationInstanceState) ElementType added in v3.18.0

func (MigrationInstanceState) ElementType() reflect.Type

type MigrationJob added in v3.18.0

type MigrationJob struct {
	pulumi.CustomResourceState

	// Start time in Unix timestamp format.
	Checkpoint pulumi.StringOutput `pulumi:"checkpoint"`
	// Whether to execute DTS supports schema migration.
	DataInitialization pulumi.BoolOutput `pulumi:"dataInitialization"`
	// Whether to perform incremental data migration.
	DataSynchronization pulumi.BoolOutput `pulumi:"dataSynchronization"`
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, migration or subscription objects](https://help.aliyun.com/document_detail/209545.html).
	DbList pulumi.StringOutput `pulumi:"dbList"`
	// The name of migrate the database.
	DestinationEndpointDatabaseName pulumi.StringPtrOutput `pulumi:"destinationEndpointDatabaseName"`
	// The type of destination database. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName pulumi.StringOutput `pulumi:"destinationEndpointEngineName"`
	// The ID of destination instance.
	DestinationEndpointInstanceId pulumi.StringPtrOutput `pulumi:"destinationEndpointInstanceId"`
	// The type of destination instance. Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType pulumi.StringOutput `pulumi:"destinationEndpointInstanceType"`
	// The ip of source endpoint.
	DestinationEndpointIp pulumi.StringPtrOutput `pulumi:"destinationEndpointIp"`
	// The SID of Oracle database.
	DestinationEndpointOracleSid pulumi.StringPtrOutput `pulumi:"destinationEndpointOracleSid"`
	// The password of database account.
	DestinationEndpointPassword pulumi.StringPtrOutput `pulumi:"destinationEndpointPassword"`
	// The port of source endpoint.
	DestinationEndpointPort pulumi.StringPtrOutput `pulumi:"destinationEndpointPort"`
	// The region of destination instance.
	DestinationEndpointRegion pulumi.StringPtrOutput `pulumi:"destinationEndpointRegion"`
	// The username of database account.
	DestinationEndpointUserName pulumi.StringPtrOutput `pulumi:"destinationEndpointUserName"`
	// The Migration instance ID. The ID of `dts.MigrationInstance`.
	DtsInstanceId pulumi.StringOutput `pulumi:"dtsInstanceId"`
	// The name of migration job.
	DtsJobName pulumi.StringOutput `pulumi:"dtsJobName"`
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.
	InstanceClass pulumi.StringOutput `pulumi:"instanceClass"`
	// The name of migrate the database.
	SourceEndpointDatabaseName pulumi.StringPtrOutput `pulumi:"sourceEndpointDatabaseName"`
	// The type of source database. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName pulumi.StringOutput `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance.
	SourceEndpointInstanceId pulumi.StringPtrOutput `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance. Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType pulumi.StringOutput `pulumi:"sourceEndpointInstanceType"`
	// The ip of source endpoint.
	SourceEndpointIp pulumi.StringPtrOutput `pulumi:"sourceEndpointIp"`
	// The SID of Oracle database.
	SourceEndpointOracleSid pulumi.StringPtrOutput `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs.
	SourceEndpointOwnerId pulumi.StringPtrOutput `pulumi:"sourceEndpointOwnerId"`
	// The password of database account.
	SourceEndpointPassword pulumi.StringPtrOutput `pulumi:"sourceEndpointPassword"`
	// The port of source endpoint.
	SourceEndpointPort pulumi.StringPtrOutput `pulumi:"sourceEndpointPort"`
	// The region of source instance.
	SourceEndpointRegion pulumi.StringPtrOutput `pulumi:"sourceEndpointRegion"`
	// The name of the role configured for the cloud account to which the source instance belongs.
	SourceEndpointRole pulumi.StringPtrOutput `pulumi:"sourceEndpointRole"`
	// The username of database account.
	SourceEndpointUserName pulumi.StringPtrOutput `pulumi:"sourceEndpointUserName"`
	// The status of the resource. Valid values: `Migrating`, `Suspending`. You can suspend the task by specifying `Suspending` and start the task by specifying `Migrating`.
	Status pulumi.StringOutput `pulumi:"status"`
	// Whether to perform a database table structure to migrate.
	StructureInitialization pulumi.BoolOutput `pulumi:"structureInitialization"`
}

Provides a DTS Migration Job resource.

For information about DTS Migration Job and how to use it, see [What is Migration Job](https://www.alibabacloud.com/help/en/doc-detail/208399.html).

> **NOTE:** Available since v1.157.0.

## Import

DTS Migration Job can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/migrationJob:MigrationJob example <id> ```

func GetMigrationJob added in v3.18.0

func GetMigrationJob(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MigrationJobState, opts ...pulumi.ResourceOption) (*MigrationJob, error)

GetMigrationJob gets an existing MigrationJob resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMigrationJob added in v3.18.0

func NewMigrationJob(ctx *pulumi.Context,
	name string, args *MigrationJobArgs, opts ...pulumi.ResourceOption) (*MigrationJob, error)

NewMigrationJob registers a new resource with the given unique name, arguments, and options.

func (*MigrationJob) ElementType added in v3.18.0

func (*MigrationJob) ElementType() reflect.Type

func (*MigrationJob) ToMigrationJobOutput added in v3.18.0

func (i *MigrationJob) ToMigrationJobOutput() MigrationJobOutput

func (*MigrationJob) ToMigrationJobOutputWithContext added in v3.18.0

func (i *MigrationJob) ToMigrationJobOutputWithContext(ctx context.Context) MigrationJobOutput

type MigrationJobArgs added in v3.18.0

type MigrationJobArgs struct {
	// Start time in Unix timestamp format.
	Checkpoint pulumi.StringPtrInput
	// Whether to execute DTS supports schema migration.
	DataInitialization pulumi.BoolInput
	// Whether to perform incremental data migration.
	DataSynchronization pulumi.BoolInput
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, migration or subscription objects](https://help.aliyun.com/document_detail/209545.html).
	DbList pulumi.StringInput
	// The name of migrate the database.
	DestinationEndpointDatabaseName pulumi.StringPtrInput
	// The type of destination database. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName pulumi.StringInput
	// The ID of destination instance.
	DestinationEndpointInstanceId pulumi.StringPtrInput
	// The type of destination instance. Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType pulumi.StringInput
	// The ip of source endpoint.
	DestinationEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database.
	DestinationEndpointOracleSid pulumi.StringPtrInput
	// The password of database account.
	DestinationEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint.
	DestinationEndpointPort pulumi.StringPtrInput
	// The region of destination instance.
	DestinationEndpointRegion pulumi.StringPtrInput
	// The username of database account.
	DestinationEndpointUserName pulumi.StringPtrInput
	// The Migration instance ID. The ID of `dts.MigrationInstance`.
	DtsInstanceId pulumi.StringInput
	// The name of migration job.
	DtsJobName pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.
	InstanceClass pulumi.StringPtrInput
	// The name of migrate the database.
	SourceEndpointDatabaseName pulumi.StringPtrInput
	// The type of source database. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName pulumi.StringInput
	// The ID of source instance.
	SourceEndpointInstanceId pulumi.StringPtrInput
	// The type of source instance. Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType pulumi.StringInput
	// The ip of source endpoint.
	SourceEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database.
	SourceEndpointOracleSid pulumi.StringPtrInput
	// The Alibaba Cloud account ID to which the source instance belongs.
	SourceEndpointOwnerId pulumi.StringPtrInput
	// The password of database account.
	SourceEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint.
	SourceEndpointPort pulumi.StringPtrInput
	// The region of source instance.
	SourceEndpointRegion pulumi.StringPtrInput
	// The name of the role configured for the cloud account to which the source instance belongs.
	SourceEndpointRole pulumi.StringPtrInput
	// The username of database account.
	SourceEndpointUserName pulumi.StringPtrInput
	// The status of the resource. Valid values: `Migrating`, `Suspending`. You can suspend the task by specifying `Suspending` and start the task by specifying `Migrating`.
	Status pulumi.StringPtrInput
	// Whether to perform a database table structure to migrate.
	StructureInitialization pulumi.BoolInput
}

The set of arguments for constructing a MigrationJob resource.

func (MigrationJobArgs) ElementType added in v3.18.0

func (MigrationJobArgs) ElementType() reflect.Type

type MigrationJobArray added in v3.18.0

type MigrationJobArray []MigrationJobInput

func (MigrationJobArray) ElementType added in v3.18.0

func (MigrationJobArray) ElementType() reflect.Type

func (MigrationJobArray) ToMigrationJobArrayOutput added in v3.18.0

func (i MigrationJobArray) ToMigrationJobArrayOutput() MigrationJobArrayOutput

func (MigrationJobArray) ToMigrationJobArrayOutputWithContext added in v3.18.0

func (i MigrationJobArray) ToMigrationJobArrayOutputWithContext(ctx context.Context) MigrationJobArrayOutput

type MigrationJobArrayInput added in v3.18.0

type MigrationJobArrayInput interface {
	pulumi.Input

	ToMigrationJobArrayOutput() MigrationJobArrayOutput
	ToMigrationJobArrayOutputWithContext(context.Context) MigrationJobArrayOutput
}

MigrationJobArrayInput is an input type that accepts MigrationJobArray and MigrationJobArrayOutput values. You can construct a concrete instance of `MigrationJobArrayInput` via:

MigrationJobArray{ MigrationJobArgs{...} }

type MigrationJobArrayOutput added in v3.18.0

type MigrationJobArrayOutput struct{ *pulumi.OutputState }

func (MigrationJobArrayOutput) ElementType added in v3.18.0

func (MigrationJobArrayOutput) ElementType() reflect.Type

func (MigrationJobArrayOutput) Index added in v3.18.0

func (MigrationJobArrayOutput) ToMigrationJobArrayOutput added in v3.18.0

func (o MigrationJobArrayOutput) ToMigrationJobArrayOutput() MigrationJobArrayOutput

func (MigrationJobArrayOutput) ToMigrationJobArrayOutputWithContext added in v3.18.0

func (o MigrationJobArrayOutput) ToMigrationJobArrayOutputWithContext(ctx context.Context) MigrationJobArrayOutput

type MigrationJobInput added in v3.18.0

type MigrationJobInput interface {
	pulumi.Input

	ToMigrationJobOutput() MigrationJobOutput
	ToMigrationJobOutputWithContext(ctx context.Context) MigrationJobOutput
}

type MigrationJobMap added in v3.18.0

type MigrationJobMap map[string]MigrationJobInput

func (MigrationJobMap) ElementType added in v3.18.0

func (MigrationJobMap) ElementType() reflect.Type

func (MigrationJobMap) ToMigrationJobMapOutput added in v3.18.0

func (i MigrationJobMap) ToMigrationJobMapOutput() MigrationJobMapOutput

func (MigrationJobMap) ToMigrationJobMapOutputWithContext added in v3.18.0

func (i MigrationJobMap) ToMigrationJobMapOutputWithContext(ctx context.Context) MigrationJobMapOutput

type MigrationJobMapInput added in v3.18.0

type MigrationJobMapInput interface {
	pulumi.Input

	ToMigrationJobMapOutput() MigrationJobMapOutput
	ToMigrationJobMapOutputWithContext(context.Context) MigrationJobMapOutput
}

MigrationJobMapInput is an input type that accepts MigrationJobMap and MigrationJobMapOutput values. You can construct a concrete instance of `MigrationJobMapInput` via:

MigrationJobMap{ "key": MigrationJobArgs{...} }

type MigrationJobMapOutput added in v3.18.0

type MigrationJobMapOutput struct{ *pulumi.OutputState }

func (MigrationJobMapOutput) ElementType added in v3.18.0

func (MigrationJobMapOutput) ElementType() reflect.Type

func (MigrationJobMapOutput) MapIndex added in v3.18.0

func (MigrationJobMapOutput) ToMigrationJobMapOutput added in v3.18.0

func (o MigrationJobMapOutput) ToMigrationJobMapOutput() MigrationJobMapOutput

func (MigrationJobMapOutput) ToMigrationJobMapOutputWithContext added in v3.18.0

func (o MigrationJobMapOutput) ToMigrationJobMapOutputWithContext(ctx context.Context) MigrationJobMapOutput

type MigrationJobOutput added in v3.18.0

type MigrationJobOutput struct{ *pulumi.OutputState }

func (MigrationJobOutput) Checkpoint added in v3.27.0

func (o MigrationJobOutput) Checkpoint() pulumi.StringOutput

Start time in Unix timestamp format.

func (MigrationJobOutput) DataInitialization added in v3.27.0

func (o MigrationJobOutput) DataInitialization() pulumi.BoolOutput

Whether to execute DTS supports schema migration.

func (MigrationJobOutput) DataSynchronization added in v3.27.0

func (o MigrationJobOutput) DataSynchronization() pulumi.BoolOutput

Whether to perform incremental data migration.

func (MigrationJobOutput) DbList added in v3.27.0

Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, migration or subscription objects](https://help.aliyun.com/document_detail/209545.html).

func (MigrationJobOutput) DestinationEndpointDatabaseName added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointDatabaseName() pulumi.StringPtrOutput

The name of migrate the database.

func (MigrationJobOutput) DestinationEndpointEngineName added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointEngineName() pulumi.StringOutput

The type of destination database. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.

func (MigrationJobOutput) DestinationEndpointInstanceId added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointInstanceId() pulumi.StringPtrOutput

The ID of destination instance.

func (MigrationJobOutput) DestinationEndpointInstanceType added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointInstanceType() pulumi.StringOutput

The type of destination instance. Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.

func (MigrationJobOutput) DestinationEndpointIp added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointIp() pulumi.StringPtrOutput

The ip of source endpoint.

func (MigrationJobOutput) DestinationEndpointOracleSid added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointOracleSid() pulumi.StringPtrOutput

The SID of Oracle database.

func (MigrationJobOutput) DestinationEndpointPassword added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointPassword() pulumi.StringPtrOutput

The password of database account.

func (MigrationJobOutput) DestinationEndpointPort added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointPort() pulumi.StringPtrOutput

The port of source endpoint.

func (MigrationJobOutput) DestinationEndpointRegion added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointRegion() pulumi.StringPtrOutput

The region of destination instance.

func (MigrationJobOutput) DestinationEndpointUserName added in v3.27.0

func (o MigrationJobOutput) DestinationEndpointUserName() pulumi.StringPtrOutput

The username of database account.

func (MigrationJobOutput) DtsInstanceId added in v3.27.0

func (o MigrationJobOutput) DtsInstanceId() pulumi.StringOutput

The Migration instance ID. The ID of `dts.MigrationInstance`.

func (MigrationJobOutput) DtsJobName added in v3.27.0

func (o MigrationJobOutput) DtsJobName() pulumi.StringOutput

The name of migration job.

func (MigrationJobOutput) ElementType added in v3.18.0

func (MigrationJobOutput) ElementType() reflect.Type

func (MigrationJobOutput) InstanceClass added in v3.27.0

func (o MigrationJobOutput) InstanceClass() pulumi.StringOutput

The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.

func (MigrationJobOutput) SourceEndpointDatabaseName added in v3.27.0

func (o MigrationJobOutput) SourceEndpointDatabaseName() pulumi.StringPtrOutput

The name of migrate the database.

func (MigrationJobOutput) SourceEndpointEngineName added in v3.27.0

func (o MigrationJobOutput) SourceEndpointEngineName() pulumi.StringOutput

The type of source database. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.

func (MigrationJobOutput) SourceEndpointInstanceId added in v3.27.0

func (o MigrationJobOutput) SourceEndpointInstanceId() pulumi.StringPtrOutput

The ID of source instance.

func (MigrationJobOutput) SourceEndpointInstanceType added in v3.27.0

func (o MigrationJobOutput) SourceEndpointInstanceType() pulumi.StringOutput

The type of source instance. Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.

func (MigrationJobOutput) SourceEndpointIp added in v3.27.0

func (o MigrationJobOutput) SourceEndpointIp() pulumi.StringPtrOutput

The ip of source endpoint.

func (MigrationJobOutput) SourceEndpointOracleSid added in v3.27.0

func (o MigrationJobOutput) SourceEndpointOracleSid() pulumi.StringPtrOutput

The SID of Oracle database.

func (MigrationJobOutput) SourceEndpointOwnerId added in v3.27.0

func (o MigrationJobOutput) SourceEndpointOwnerId() pulumi.StringPtrOutput

The Alibaba Cloud account ID to which the source instance belongs.

func (MigrationJobOutput) SourceEndpointPassword added in v3.27.0

func (o MigrationJobOutput) SourceEndpointPassword() pulumi.StringPtrOutput

The password of database account.

func (MigrationJobOutput) SourceEndpointPort added in v3.27.0

func (o MigrationJobOutput) SourceEndpointPort() pulumi.StringPtrOutput

The port of source endpoint.

func (MigrationJobOutput) SourceEndpointRegion added in v3.27.0

func (o MigrationJobOutput) SourceEndpointRegion() pulumi.StringPtrOutput

The region of source instance.

func (MigrationJobOutput) SourceEndpointRole added in v3.27.0

func (o MigrationJobOutput) SourceEndpointRole() pulumi.StringPtrOutput

The name of the role configured for the cloud account to which the source instance belongs.

func (MigrationJobOutput) SourceEndpointUserName added in v3.27.0

func (o MigrationJobOutput) SourceEndpointUserName() pulumi.StringPtrOutput

The username of database account.

func (MigrationJobOutput) Status added in v3.27.0

The status of the resource. Valid values: `Migrating`, `Suspending`. You can suspend the task by specifying `Suspending` and start the task by specifying `Migrating`.

func (MigrationJobOutput) StructureInitialization added in v3.27.0

func (o MigrationJobOutput) StructureInitialization() pulumi.BoolOutput

Whether to perform a database table structure to migrate.

func (MigrationJobOutput) ToMigrationJobOutput added in v3.18.0

func (o MigrationJobOutput) ToMigrationJobOutput() MigrationJobOutput

func (MigrationJobOutput) ToMigrationJobOutputWithContext added in v3.18.0

func (o MigrationJobOutput) ToMigrationJobOutputWithContext(ctx context.Context) MigrationJobOutput

type MigrationJobState added in v3.18.0

type MigrationJobState struct {
	// Start time in Unix timestamp format.
	Checkpoint pulumi.StringPtrInput
	// Whether to execute DTS supports schema migration.
	DataInitialization pulumi.BoolPtrInput
	// Whether to perform incremental data migration.
	DataSynchronization pulumi.BoolPtrInput
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, migration or subscription objects](https://help.aliyun.com/document_detail/209545.html).
	DbList pulumi.StringPtrInput
	// The name of migrate the database.
	DestinationEndpointDatabaseName pulumi.StringPtrInput
	// The type of destination database. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The ID of destination instance.
	DestinationEndpointInstanceId pulumi.StringPtrInput
	// The type of destination instance. Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType pulumi.StringPtrInput
	// The ip of source endpoint.
	DestinationEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database.
	DestinationEndpointOracleSid pulumi.StringPtrInput
	// The password of database account.
	DestinationEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint.
	DestinationEndpointPort pulumi.StringPtrInput
	// The region of destination instance.
	DestinationEndpointRegion pulumi.StringPtrInput
	// The username of database account.
	DestinationEndpointUserName pulumi.StringPtrInput
	// The Migration instance ID. The ID of `dts.MigrationInstance`.
	DtsInstanceId pulumi.StringPtrInput
	// The name of migration job.
	DtsJobName pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.
	InstanceClass pulumi.StringPtrInput
	// The name of migrate the database.
	SourceEndpointDatabaseName pulumi.StringPtrInput
	// The type of source database. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName pulumi.StringPtrInput
	// The ID of source instance.
	SourceEndpointInstanceId pulumi.StringPtrInput
	// The type of source instance. Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType pulumi.StringPtrInput
	// The ip of source endpoint.
	SourceEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database.
	SourceEndpointOracleSid pulumi.StringPtrInput
	// The Alibaba Cloud account ID to which the source instance belongs.
	SourceEndpointOwnerId pulumi.StringPtrInput
	// The password of database account.
	SourceEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint.
	SourceEndpointPort pulumi.StringPtrInput
	// The region of source instance.
	SourceEndpointRegion pulumi.StringPtrInput
	// The name of the role configured for the cloud account to which the source instance belongs.
	SourceEndpointRole pulumi.StringPtrInput
	// The username of database account.
	SourceEndpointUserName pulumi.StringPtrInput
	// The status of the resource. Valid values: `Migrating`, `Suspending`. You can suspend the task by specifying `Suspending` and start the task by specifying `Migrating`.
	Status pulumi.StringPtrInput
	// Whether to perform a database table structure to migrate.
	StructureInitialization pulumi.BoolPtrInput
}

func (MigrationJobState) ElementType added in v3.18.0

func (MigrationJobState) ElementType() reflect.Type

type SubscriptionJob

type SubscriptionJob struct {
	pulumi.CustomResourceState

	// Subscription start time in Unix timestamp format.
	Checkpoint pulumi.StringOutput `pulumi:"checkpoint"`
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrOutput `pulumi:"computeUnit"`
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrOutput `pulumi:"databaseCount"`
	// Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects [document](https://help.aliyun.com/document_detail/209545.html).
	DbList pulumi.StringPtrOutput `pulumi:"dbList"`
	// This parameter decides whether to monitor the delay status. Valid values: `true`, `false`.
	DelayNotice pulumi.BoolPtrOutput `pulumi:"delayNotice"`
	// The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	DelayPhone pulumi.StringPtrOutput `pulumi:"delayPhone"`
	// When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.
	DelayRuleTime pulumi.StringPtrOutput `pulumi:"delayRuleTime"`
	// The destination endpoint engine name. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`.
	DestinationEndpointEngineName pulumi.StringPtrOutput `pulumi:"destinationEndpointEngineName"`
	// The destination region. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationRegion pulumi.StringPtrOutput `pulumi:"destinationRegion"`
	// The ID of subscription instance.
	DtsInstanceId pulumi.StringOutput `pulumi:"dtsInstanceId"`
	// The name of subscription task.
	DtsJobName pulumi.StringPtrOutput `pulumi:"dtsJobName"`
	// This parameter decides whether to monitor abnormal status. Valid values: `true`, `false`.
	ErrorNotice pulumi.BoolPtrOutput `pulumi:"errorNotice"`
	// The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	ErrorPhone pulumi.StringPtrOutput `pulumi:"errorPhone"`
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.
	InstanceClass pulumi.StringPtrOutput `pulumi:"instanceClass"`
	// The duration of prepaid instance purchase. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDuration pulumi.IntPtrOutput `pulumi:"paymentDuration"`
	// The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDurationUnit pulumi.StringPtrOutput `pulumi:"paymentDurationUnit"`
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringOutput `pulumi:"paymentType"`
	// DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the [Reserve parameter](https://help.aliyun.com/document_detail/176470.html).
	Reserve pulumi.StringPtrOutput `pulumi:"reserve"`
	// To subscribe to the name of the database.
	SourceEndpointDatabaseName pulumi.StringPtrOutput `pulumi:"sourceEndpointDatabaseName"`
	// The source database type value is MySQL or Oracle. Valid values: `MySQL`, `Oracle`.
	SourceEndpointEngineName pulumi.StringOutput `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
	SourceEndpointInstanceId pulumi.StringPtrOutput `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance. Valid values: `RDS`, `PolarDB`, `DRDS`, `LocalInstance`, `ECS`, `Express`, `CEN`, `dg`.
	SourceEndpointInstanceType pulumi.StringOutput `pulumi:"sourceEndpointInstanceType"`
	// The IP of source endpoint.
	SourceEndpointIp pulumi.StringPtrOutput `pulumi:"sourceEndpointIp"`
	// The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid pulumi.StringPtrOutput `pulumi:"sourceEndpointOracleSid"`
	// The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
	SourceEndpointOwnerId pulumi.StringPtrOutput `pulumi:"sourceEndpointOwnerId"`
	// The password of source database instance account.
	SourceEndpointPassword pulumi.StringPtrOutput `pulumi:"sourceEndpointPassword"`
	// The port of source database.
	SourceEndpointPort pulumi.StringPtrOutput `pulumi:"sourceEndpointPort"`
	// The region of source database.
	SourceEndpointRegion pulumi.StringOutput `pulumi:"sourceEndpointRegion"`
	// Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
	SourceEndpointRole pulumi.StringPtrOutput `pulumi:"sourceEndpointRole"`
	// The username of source database instance account.
	SourceEndpointUserName pulumi.StringPtrOutput `pulumi:"sourceEndpointUserName"`
	// The status of the task. Valid values: `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state to `Normal` to start the job, and specify this state of `Abnormal` to stop the job. **Note: We treat the state `Starting` as the state of `Normal`, and consider the two states to be consistent on the user side.**
	Status pulumi.StringOutput `pulumi:"status"`
	// Whether to subscribe the DDL type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDdl pulumi.BoolOutput `pulumi:"subscriptionDataTypeDdl"`
	// Whether to subscribe the DML type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDml pulumi.BoolOutput `pulumi:"subscriptionDataTypeDml"`
	// Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: `classic`, `vpc`.
	SubscriptionInstanceNetworkType pulumi.StringPtrOutput `pulumi:"subscriptionInstanceNetworkType"`
	// The ID of subscription vpc instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.
	SubscriptionInstanceVpcId pulumi.StringPtrOutput `pulumi:"subscriptionInstanceVpcId"`
	// The ID of subscription VSwitch instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.
	SubscriptionInstanceVswitchId pulumi.StringPtrOutput `pulumi:"subscriptionInstanceVswitchId"`
	// The sync architecture. Valid values: `bidirectional`, `oneway`.
	SyncArchitecture pulumi.StringPtrOutput `pulumi:"syncArchitecture"`
	// The synchronization direction. Valid values: `Forward`, `Reverse`. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.
	SynchronizationDirection pulumi.StringPtrOutput `pulumi:"synchronizationDirection"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Provides a DTS Subscription Job resource.

For information about DTS Subscription Job and how to use it, see [What is Subscription Job](https://www.alibabacloud.com/help/en/data-transmission-service/latest/configuresubscription).

> **NOTE:** Available since v1.138.0.

## Example Usage

Basic Usage

```go package main

import (

"encoding/json"

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		example, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetZones, err := rds.GetZones(ctx, &rds.GetZonesArgs{
			Engine:                pulumi.StringRef("MySQL"),
			EngineVersion:         pulumi.StringRef("8.0"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
			Category:              pulumi.StringRef("Basic"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetInstanceClasses, err := rds.GetInstanceClasses(ctx, &rds.GetInstanceClassesArgs{
			ZoneId:                pulumi.StringRef(exampleGetZones.Zones[0].Id),
			Engine:                pulumi.StringRef("MySQL"),
			EngineVersion:         pulumi.StringRef("8.0"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
			Category:              pulumi.StringRef("Basic"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
		}, nil)
		if err != nil {
			return err
		}
		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
			VpcId:       exampleNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(exampleGetZones.Zones[0].Id),
			VswitchName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		exampleSecurityGroup, err := ecs.NewSecurityGroup(ctx, "example", &ecs.SecurityGroupArgs{
			Name:  pulumi.String(name),
			VpcId: exampleNetwork.ID(),
		})
		if err != nil {
			return err
		}
		exampleInstance, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			Engine:                pulumi.String("MySQL"),
			EngineVersion:         pulumi.String("8.0"),
			InstanceType:          pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].InstanceClass),
			InstanceStorage:       pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].StorageRange.Min),
			InstanceChargeType:    pulumi.String("Postpaid"),
			InstanceName:          pulumi.String(name),
			VswitchId:             exampleSwitch.ID(),
			MonitoringPeriod:      pulumi.Int(60),
			DbInstanceStorageType: pulumi.String("cloud_essd"),
			SecurityGroupIds: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
		})
		if err != nil {
			return err
		}
		exampleRdsAccount, err := rds.NewRdsAccount(ctx, "example", &rds.RdsAccountArgs{
			DbInstanceId:    exampleInstance.ID(),
			AccountName:     pulumi.String("test_mysql"),
			AccountPassword: pulumi.String("N1cetest"),
		})
		if err != nil {
			return err
		}
		exampleDatabase, err := rds.NewDatabase(ctx, "example", &rds.DatabaseArgs{
			InstanceId: exampleInstance.ID(),
			Name:       pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewAccountPrivilege(ctx, "example", &rds.AccountPrivilegeArgs{
			InstanceId:  exampleInstance.ID(),
			AccountName: exampleRdsAccount.Name,
			Privilege:   pulumi.String("ReadWrite"),
			DbNames: pulumi.StringArray{
				exampleDatabase.Name,
			},
		})
		if err != nil {
			return err
		}
		_, err = dts.NewSubscriptionJob(ctx, "example", &dts.SubscriptionJobArgs{
			DtsJobName:                 pulumi.String(name),
			PaymentType:                pulumi.String("PayAsYouGo"),
			SourceEndpointEngineName:   pulumi.String("MySQL"),
			SourceEndpointRegion:       pulumi.String(example.Regions[0].Id),
			SourceEndpointInstanceType: pulumi.String("RDS"),
			SourceEndpointInstanceId:   exampleInstance.ID(),
			SourceEndpointDatabaseName: exampleDatabase.Name,
			SourceEndpointUserName:     exampleRdsAccount.AccountName,
			SourceEndpointPassword:     exampleRdsAccount.AccountPassword,
			DbList: pulumi.All(exampleDatabase.Name, exampleDatabase.Name).ApplyT(func(_args []interface{}) (string, error) {
				exampleDatabaseName := _args[0].(string)
				exampleDatabaseName1 := _args[1].(string)
				var _zero string
				tmpJSON0, err := json.Marshal(map[string]map[string]interface{}{
					exampleDatabaseName: map[string]interface{}{
						"name": exampleDatabaseName1,
						"all":  true,
					},
				})
				if err != nil {
					return _zero, err
				}
				json0 := string(tmpJSON0)
				return json0, nil
			}).(pulumi.StringOutput),
			SubscriptionInstanceNetworkType: pulumi.String("vpc"),
			SubscriptionInstanceVpcId:       exampleNetwork.ID(),
			SubscriptionInstanceVswitchId:   exampleSwitch.ID(),
			Status:                          pulumi.String("Normal"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

DTS Subscription Job can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/subscriptionJob:SubscriptionJob example <id> ```

func GetSubscriptionJob

func GetSubscriptionJob(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SubscriptionJobState, opts ...pulumi.ResourceOption) (*SubscriptionJob, error)

GetSubscriptionJob gets an existing SubscriptionJob resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSubscriptionJob

func NewSubscriptionJob(ctx *pulumi.Context,
	name string, args *SubscriptionJobArgs, opts ...pulumi.ResourceOption) (*SubscriptionJob, error)

NewSubscriptionJob registers a new resource with the given unique name, arguments, and options.

func (*SubscriptionJob) ElementType

func (*SubscriptionJob) ElementType() reflect.Type

func (*SubscriptionJob) ToSubscriptionJobOutput

func (i *SubscriptionJob) ToSubscriptionJobOutput() SubscriptionJobOutput

func (*SubscriptionJob) ToSubscriptionJobOutputWithContext

func (i *SubscriptionJob) ToSubscriptionJobOutputWithContext(ctx context.Context) SubscriptionJobOutput

type SubscriptionJobArgs

type SubscriptionJobArgs struct {
	// Subscription start time in Unix timestamp format.
	Checkpoint pulumi.StringPtrInput
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrInput
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrInput
	// Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects [document](https://help.aliyun.com/document_detail/209545.html).
	DbList pulumi.StringPtrInput
	// This parameter decides whether to monitor the delay status. Valid values: `true`, `false`.
	DelayNotice pulumi.BoolPtrInput
	// The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	DelayPhone pulumi.StringPtrInput
	// When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.
	DelayRuleTime pulumi.StringPtrInput
	// The destination endpoint engine name. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`.
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The destination region. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationRegion pulumi.StringPtrInput
	// The ID of subscription instance.
	DtsInstanceId pulumi.StringPtrInput
	// The name of subscription task.
	DtsJobName pulumi.StringPtrInput
	// This parameter decides whether to monitor abnormal status. Valid values: `true`, `false`.
	ErrorNotice pulumi.BoolPtrInput
	// The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	ErrorPhone pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.
	InstanceClass pulumi.StringPtrInput
	// The duration of prepaid instance purchase. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDuration pulumi.IntPtrInput
	// The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDurationUnit pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringInput
	// DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the [Reserve parameter](https://help.aliyun.com/document_detail/176470.html).
	Reserve pulumi.StringPtrInput
	// To subscribe to the name of the database.
	SourceEndpointDatabaseName pulumi.StringPtrInput
	// The source database type value is MySQL or Oracle. Valid values: `MySQL`, `Oracle`.
	SourceEndpointEngineName pulumi.StringInput
	// The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
	SourceEndpointInstanceId pulumi.StringPtrInput
	// The type of source instance. Valid values: `RDS`, `PolarDB`, `DRDS`, `LocalInstance`, `ECS`, `Express`, `CEN`, `dg`.
	SourceEndpointInstanceType pulumi.StringInput
	// The IP of source endpoint.
	SourceEndpointIp pulumi.StringPtrInput
	// The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid pulumi.StringPtrInput
	// The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
	SourceEndpointOwnerId pulumi.StringPtrInput
	// The password of source database instance account.
	SourceEndpointPassword pulumi.StringPtrInput
	// The port of source database.
	SourceEndpointPort pulumi.StringPtrInput
	// The region of source database.
	SourceEndpointRegion pulumi.StringInput
	// Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
	SourceEndpointRole pulumi.StringPtrInput
	// The username of source database instance account.
	SourceEndpointUserName pulumi.StringPtrInput
	// The status of the task. Valid values: `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state to `Normal` to start the job, and specify this state of `Abnormal` to stop the job. **Note: We treat the state `Starting` as the state of `Normal`, and consider the two states to be consistent on the user side.**
	Status pulumi.StringPtrInput
	// Whether to subscribe the DDL type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDdl pulumi.BoolPtrInput
	// Whether to subscribe the DML type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDml pulumi.BoolPtrInput
	// Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: `classic`, `vpc`.
	SubscriptionInstanceNetworkType pulumi.StringPtrInput
	// The ID of subscription vpc instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.
	SubscriptionInstanceVpcId pulumi.StringPtrInput
	// The ID of subscription VSwitch instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.
	SubscriptionInstanceVswitchId pulumi.StringPtrInput
	// The sync architecture. Valid values: `bidirectional`, `oneway`.
	SyncArchitecture pulumi.StringPtrInput
	// The synchronization direction. Valid values: `Forward`, `Reverse`. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.
	SynchronizationDirection pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
}

The set of arguments for constructing a SubscriptionJob resource.

func (SubscriptionJobArgs) ElementType

func (SubscriptionJobArgs) ElementType() reflect.Type

type SubscriptionJobArray

type SubscriptionJobArray []SubscriptionJobInput

func (SubscriptionJobArray) ElementType

func (SubscriptionJobArray) ElementType() reflect.Type

func (SubscriptionJobArray) ToSubscriptionJobArrayOutput

func (i SubscriptionJobArray) ToSubscriptionJobArrayOutput() SubscriptionJobArrayOutput

func (SubscriptionJobArray) ToSubscriptionJobArrayOutputWithContext

func (i SubscriptionJobArray) ToSubscriptionJobArrayOutputWithContext(ctx context.Context) SubscriptionJobArrayOutput

type SubscriptionJobArrayInput

type SubscriptionJobArrayInput interface {
	pulumi.Input

	ToSubscriptionJobArrayOutput() SubscriptionJobArrayOutput
	ToSubscriptionJobArrayOutputWithContext(context.Context) SubscriptionJobArrayOutput
}

SubscriptionJobArrayInput is an input type that accepts SubscriptionJobArray and SubscriptionJobArrayOutput values. You can construct a concrete instance of `SubscriptionJobArrayInput` via:

SubscriptionJobArray{ SubscriptionJobArgs{...} }

type SubscriptionJobArrayOutput

type SubscriptionJobArrayOutput struct{ *pulumi.OutputState }

func (SubscriptionJobArrayOutput) ElementType

func (SubscriptionJobArrayOutput) ElementType() reflect.Type

func (SubscriptionJobArrayOutput) Index

func (SubscriptionJobArrayOutput) ToSubscriptionJobArrayOutput

func (o SubscriptionJobArrayOutput) ToSubscriptionJobArrayOutput() SubscriptionJobArrayOutput

func (SubscriptionJobArrayOutput) ToSubscriptionJobArrayOutputWithContext

func (o SubscriptionJobArrayOutput) ToSubscriptionJobArrayOutputWithContext(ctx context.Context) SubscriptionJobArrayOutput

type SubscriptionJobInput

type SubscriptionJobInput interface {
	pulumi.Input

	ToSubscriptionJobOutput() SubscriptionJobOutput
	ToSubscriptionJobOutputWithContext(ctx context.Context) SubscriptionJobOutput
}

type SubscriptionJobMap

type SubscriptionJobMap map[string]SubscriptionJobInput

func (SubscriptionJobMap) ElementType

func (SubscriptionJobMap) ElementType() reflect.Type

func (SubscriptionJobMap) ToSubscriptionJobMapOutput

func (i SubscriptionJobMap) ToSubscriptionJobMapOutput() SubscriptionJobMapOutput

func (SubscriptionJobMap) ToSubscriptionJobMapOutputWithContext

func (i SubscriptionJobMap) ToSubscriptionJobMapOutputWithContext(ctx context.Context) SubscriptionJobMapOutput

type SubscriptionJobMapInput

type SubscriptionJobMapInput interface {
	pulumi.Input

	ToSubscriptionJobMapOutput() SubscriptionJobMapOutput
	ToSubscriptionJobMapOutputWithContext(context.Context) SubscriptionJobMapOutput
}

SubscriptionJobMapInput is an input type that accepts SubscriptionJobMap and SubscriptionJobMapOutput values. You can construct a concrete instance of `SubscriptionJobMapInput` via:

SubscriptionJobMap{ "key": SubscriptionJobArgs{...} }

type SubscriptionJobMapOutput

type SubscriptionJobMapOutput struct{ *pulumi.OutputState }

func (SubscriptionJobMapOutput) ElementType

func (SubscriptionJobMapOutput) ElementType() reflect.Type

func (SubscriptionJobMapOutput) MapIndex

func (SubscriptionJobMapOutput) ToSubscriptionJobMapOutput

func (o SubscriptionJobMapOutput) ToSubscriptionJobMapOutput() SubscriptionJobMapOutput

func (SubscriptionJobMapOutput) ToSubscriptionJobMapOutputWithContext

func (o SubscriptionJobMapOutput) ToSubscriptionJobMapOutputWithContext(ctx context.Context) SubscriptionJobMapOutput

type SubscriptionJobOutput

type SubscriptionJobOutput struct{ *pulumi.OutputState }

func (SubscriptionJobOutput) Checkpoint added in v3.27.0

func (o SubscriptionJobOutput) Checkpoint() pulumi.StringOutput

Subscription start time in Unix timestamp format.

func (SubscriptionJobOutput) ComputeUnit added in v3.27.0

func (o SubscriptionJobOutput) ComputeUnit() pulumi.IntPtrOutput

[ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.

func (SubscriptionJobOutput) DatabaseCount added in v3.27.0

func (o SubscriptionJobOutput) DatabaseCount() pulumi.IntPtrOutput

The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.

func (SubscriptionJobOutput) DbList added in v3.27.0

Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects [document](https://help.aliyun.com/document_detail/209545.html).

func (SubscriptionJobOutput) DelayNotice added in v3.27.0

func (o SubscriptionJobOutput) DelayNotice() pulumi.BoolPtrOutput

This parameter decides whether to monitor the delay status. Valid values: `true`, `false`.

func (SubscriptionJobOutput) DelayPhone added in v3.27.0

The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.

func (SubscriptionJobOutput) DelayRuleTime added in v3.27.0

func (o SubscriptionJobOutput) DelayRuleTime() pulumi.StringPtrOutput

When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.

func (SubscriptionJobOutput) DestinationEndpointEngineName added in v3.27.0

func (o SubscriptionJobOutput) DestinationEndpointEngineName() pulumi.StringPtrOutput

The destination endpoint engine name. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`.

func (SubscriptionJobOutput) DestinationRegion added in v3.27.0

func (o SubscriptionJobOutput) DestinationRegion() pulumi.StringPtrOutput

The destination region. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).

func (SubscriptionJobOutput) DtsInstanceId added in v3.27.0

func (o SubscriptionJobOutput) DtsInstanceId() pulumi.StringOutput

The ID of subscription instance.

func (SubscriptionJobOutput) DtsJobName added in v3.27.0

The name of subscription task.

func (SubscriptionJobOutput) ElementType

func (SubscriptionJobOutput) ElementType() reflect.Type

func (SubscriptionJobOutput) ErrorNotice added in v3.27.0

func (o SubscriptionJobOutput) ErrorNotice() pulumi.BoolPtrOutput

This parameter decides whether to monitor abnormal status. Valid values: `true`, `false`.

func (SubscriptionJobOutput) ErrorPhone added in v3.27.0

The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.

func (SubscriptionJobOutput) InstanceClass added in v3.27.0

func (o SubscriptionJobOutput) InstanceClass() pulumi.StringPtrOutput

The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.

func (SubscriptionJobOutput) PaymentDuration added in v3.27.0

func (o SubscriptionJobOutput) PaymentDuration() pulumi.IntPtrOutput

The duration of prepaid instance purchase. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.

func (SubscriptionJobOutput) PaymentDurationUnit added in v3.27.0

func (o SubscriptionJobOutput) PaymentDurationUnit() pulumi.StringPtrOutput

The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.

func (SubscriptionJobOutput) PaymentType added in v3.27.0

func (o SubscriptionJobOutput) PaymentType() pulumi.StringOutput

The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.

func (SubscriptionJobOutput) Reserve added in v3.27.0

DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the [Reserve parameter](https://help.aliyun.com/document_detail/176470.html).

func (SubscriptionJobOutput) SourceEndpointDatabaseName added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointDatabaseName() pulumi.StringPtrOutput

To subscribe to the name of the database.

func (SubscriptionJobOutput) SourceEndpointEngineName added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointEngineName() pulumi.StringOutput

The source database type value is MySQL or Oracle. Valid values: `MySQL`, `Oracle`.

func (SubscriptionJobOutput) SourceEndpointInstanceId added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointInstanceId() pulumi.StringPtrOutput

The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.

func (SubscriptionJobOutput) SourceEndpointInstanceType added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointInstanceType() pulumi.StringOutput

The type of source instance. Valid values: `RDS`, `PolarDB`, `DRDS`, `LocalInstance`, `ECS`, `Express`, `CEN`, `dg`.

func (SubscriptionJobOutput) SourceEndpointIp added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointIp() pulumi.StringPtrOutput

The IP of source endpoint.

func (SubscriptionJobOutput) SourceEndpointOracleSid added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointOracleSid() pulumi.StringPtrOutput

The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.

func (SubscriptionJobOutput) SourceEndpointOwnerId added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointOwnerId() pulumi.StringPtrOutput

The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.

func (SubscriptionJobOutput) SourceEndpointPassword added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointPassword() pulumi.StringPtrOutput

The password of source database instance account.

func (SubscriptionJobOutput) SourceEndpointPort added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointPort() pulumi.StringPtrOutput

The port of source database.

func (SubscriptionJobOutput) SourceEndpointRegion added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointRegion() pulumi.StringOutput

The region of source database.

func (SubscriptionJobOutput) SourceEndpointRole added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointRole() pulumi.StringPtrOutput

Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.

func (SubscriptionJobOutput) SourceEndpointUserName added in v3.27.0

func (o SubscriptionJobOutput) SourceEndpointUserName() pulumi.StringPtrOutput

The username of source database instance account.

func (SubscriptionJobOutput) Status added in v3.27.0

The status of the task. Valid values: `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state to `Normal` to start the job, and specify this state of `Abnormal` to stop the job. **Note: We treat the state `Starting` as the state of `Normal`, and consider the two states to be consistent on the user side.**

func (SubscriptionJobOutput) SubscriptionDataTypeDdl added in v3.27.0

func (o SubscriptionJobOutput) SubscriptionDataTypeDdl() pulumi.BoolOutput

Whether to subscribe the DDL type of data. Valid values: `true`, `false`.

func (SubscriptionJobOutput) SubscriptionDataTypeDml added in v3.27.0

func (o SubscriptionJobOutput) SubscriptionDataTypeDml() pulumi.BoolOutput

Whether to subscribe the DML type of data. Valid values: `true`, `false`.

func (SubscriptionJobOutput) SubscriptionInstanceNetworkType added in v3.27.0

func (o SubscriptionJobOutput) SubscriptionInstanceNetworkType() pulumi.StringPtrOutput

Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: `classic`, `vpc`.

func (SubscriptionJobOutput) SubscriptionInstanceVpcId added in v3.27.0

func (o SubscriptionJobOutput) SubscriptionInstanceVpcId() pulumi.StringPtrOutput

The ID of subscription vpc instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.

func (SubscriptionJobOutput) SubscriptionInstanceVswitchId added in v3.27.0

func (o SubscriptionJobOutput) SubscriptionInstanceVswitchId() pulumi.StringPtrOutput

The ID of subscription VSwitch instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.

func (SubscriptionJobOutput) SyncArchitecture added in v3.27.0

func (o SubscriptionJobOutput) SyncArchitecture() pulumi.StringPtrOutput

The sync architecture. Valid values: `bidirectional`, `oneway`.

func (SubscriptionJobOutput) SynchronizationDirection added in v3.27.0

func (o SubscriptionJobOutput) SynchronizationDirection() pulumi.StringPtrOutput

The synchronization direction. Valid values: `Forward`, `Reverse`. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.

func (SubscriptionJobOutput) Tags added in v3.27.0

A mapping of tags to assign to the resource.

func (SubscriptionJobOutput) ToSubscriptionJobOutput

func (o SubscriptionJobOutput) ToSubscriptionJobOutput() SubscriptionJobOutput

func (SubscriptionJobOutput) ToSubscriptionJobOutputWithContext

func (o SubscriptionJobOutput) ToSubscriptionJobOutputWithContext(ctx context.Context) SubscriptionJobOutput

type SubscriptionJobState

type SubscriptionJobState struct {
	// Subscription start time in Unix timestamp format.
	Checkpoint pulumi.StringPtrInput
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrInput
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrInput
	// Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects [document](https://help.aliyun.com/document_detail/209545.html).
	DbList pulumi.StringPtrInput
	// This parameter decides whether to monitor the delay status. Valid values: `true`, `false`.
	DelayNotice pulumi.BoolPtrInput
	// The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	DelayPhone pulumi.StringPtrInput
	// When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.
	DelayRuleTime pulumi.StringPtrInput
	// The destination endpoint engine name. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`.
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The destination region. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationRegion pulumi.StringPtrInput
	// The ID of subscription instance.
	DtsInstanceId pulumi.StringPtrInput
	// The name of subscription task.
	DtsJobName pulumi.StringPtrInput
	// This parameter decides whether to monitor abnormal status. Valid values: `true`, `false`.
	ErrorNotice pulumi.BoolPtrInput
	// The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	ErrorPhone pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`.
	InstanceClass pulumi.StringPtrInput
	// The duration of prepaid instance purchase. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDuration pulumi.IntPtrInput
	// The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDurationUnit pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringPtrInput
	// DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the [Reserve parameter](https://help.aliyun.com/document_detail/176470.html).
	Reserve pulumi.StringPtrInput
	// To subscribe to the name of the database.
	SourceEndpointDatabaseName pulumi.StringPtrInput
	// The source database type value is MySQL or Oracle. Valid values: `MySQL`, `Oracle`.
	SourceEndpointEngineName pulumi.StringPtrInput
	// The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
	SourceEndpointInstanceId pulumi.StringPtrInput
	// The type of source instance. Valid values: `RDS`, `PolarDB`, `DRDS`, `LocalInstance`, `ECS`, `Express`, `CEN`, `dg`.
	SourceEndpointInstanceType pulumi.StringPtrInput
	// The IP of source endpoint.
	SourceEndpointIp pulumi.StringPtrInput
	// The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid pulumi.StringPtrInput
	// The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
	SourceEndpointOwnerId pulumi.StringPtrInput
	// The password of source database instance account.
	SourceEndpointPassword pulumi.StringPtrInput
	// The port of source database.
	SourceEndpointPort pulumi.StringPtrInput
	// The region of source database.
	SourceEndpointRegion pulumi.StringPtrInput
	// Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
	SourceEndpointRole pulumi.StringPtrInput
	// The username of source database instance account.
	SourceEndpointUserName pulumi.StringPtrInput
	// The status of the task. Valid values: `Normal`, `Abnormal`. When a task created, it is in this state of `NotStarted`. You can specify this state to `Normal` to start the job, and specify this state of `Abnormal` to stop the job. **Note: We treat the state `Starting` as the state of `Normal`, and consider the two states to be consistent on the user side.**
	Status pulumi.StringPtrInput
	// Whether to subscribe the DDL type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDdl pulumi.BoolPtrInput
	// Whether to subscribe the DML type of data. Valid values: `true`, `false`.
	SubscriptionDataTypeDml pulumi.BoolPtrInput
	// Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: `classic`, `vpc`.
	SubscriptionInstanceNetworkType pulumi.StringPtrInput
	// The ID of subscription vpc instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.
	SubscriptionInstanceVpcId pulumi.StringPtrInput
	// The ID of subscription VSwitch instance. When the value of `subscriptionInstanceNetworkType` is vpc, this parameter is available and must be passed in.
	SubscriptionInstanceVswitchId pulumi.StringPtrInput
	// The sync architecture. Valid values: `bidirectional`, `oneway`.
	SyncArchitecture pulumi.StringPtrInput
	// The synchronization direction. Valid values: `Forward`, `Reverse`. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.
	SynchronizationDirection pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.MapInput
}

func (SubscriptionJobState) ElementType

func (SubscriptionJobState) ElementType() reflect.Type

type SynchronizationInstance

type SynchronizationInstance struct {
	pulumi.CustomResourceState

	// Whether to automatically renew when it expires. Valid values: `true`, `false`.
	AutoPay pulumi.StringPtrOutput `pulumi:"autoPay"`
	// Whether to automatically start the task after the purchase completed. Valid values: `true`, `false`.
	AutoStart pulumi.StringPtrOutput `pulumi:"autoStart"`
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrOutput `pulumi:"computeUnit"`
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrOutput `pulumi:"databaseCount"`
	// The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	DestinationEndpointEngineName pulumi.StringOutput `pulumi:"destinationEndpointEngineName"`
	// The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationEndpointRegion pulumi.StringOutput `pulumi:"destinationEndpointRegion"`
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringOutput `pulumi:"instanceClass"`
	// The duration of prepaid instance purchase. this parameter is required When `paymentType` equals `Subscription`.
	PaymentDuration pulumi.IntPtrOutput `pulumi:"paymentDuration"`
	// The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDurationUnit pulumi.StringPtrOutput `pulumi:"paymentDurationUnit"`
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringOutput `pulumi:"paymentType"`
	// The number of instances purchased.
	Quantity pulumi.IntPtrOutput `pulumi:"quantity"`
	// The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	SourceEndpointEngineName pulumi.StringOutput `pulumi:"sourceEndpointEngineName"`
	// The region of source instance.
	SourceEndpointRegion pulumi.StringOutput `pulumi:"sourceEndpointRegion"`
	// The status.
	Status pulumi.StringOutput `pulumi:"status"`
	// The sync architecture. Valid values: `oneway`, `bidirectional`.
	SyncArchitecture pulumi.StringPtrOutput `pulumi:"syncArchitecture"`
}

Provides a DTS Synchronization Instance resource.

For information about DTS Synchronization Instance and how to use it, see [What is Synchronization Instance](https://www.alibabacloud.com/help/en/doc-detail/130744.html).

> **NOTE:** Available since v1.138.0.

## Example Usage

Basic Usage

```go package main

import (

"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = dts.NewSynchronizationInstance(ctx, "default", &dts.SynchronizationInstanceArgs{
			PaymentType:                   pulumi.String("PayAsYouGo"),
			SourceEndpointEngineName:      pulumi.String("MySQL"),
			SourceEndpointRegion:          pulumi.String(_default.Regions[0].Id),
			DestinationEndpointEngineName: pulumi.String("MySQL"),
			DestinationEndpointRegion:     pulumi.String(_default.Regions[0].Id),
			InstanceClass:                 pulumi.String("small"),
			SyncArchitecture:              pulumi.String("oneway"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

DTS Synchronization Instance can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/synchronizationInstance:SynchronizationInstance example <id> ```

func GetSynchronizationInstance

func GetSynchronizationInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SynchronizationInstanceState, opts ...pulumi.ResourceOption) (*SynchronizationInstance, error)

GetSynchronizationInstance gets an existing SynchronizationInstance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSynchronizationInstance

func NewSynchronizationInstance(ctx *pulumi.Context,
	name string, args *SynchronizationInstanceArgs, opts ...pulumi.ResourceOption) (*SynchronizationInstance, error)

NewSynchronizationInstance registers a new resource with the given unique name, arguments, and options.

func (*SynchronizationInstance) ElementType

func (*SynchronizationInstance) ElementType() reflect.Type

func (*SynchronizationInstance) ToSynchronizationInstanceOutput

func (i *SynchronizationInstance) ToSynchronizationInstanceOutput() SynchronizationInstanceOutput

func (*SynchronizationInstance) ToSynchronizationInstanceOutputWithContext

func (i *SynchronizationInstance) ToSynchronizationInstanceOutputWithContext(ctx context.Context) SynchronizationInstanceOutput

type SynchronizationInstanceArgs

type SynchronizationInstanceArgs struct {
	// Whether to automatically renew when it expires. Valid values: `true`, `false`.
	AutoPay pulumi.StringPtrInput
	// Whether to automatically start the task after the purchase completed. Valid values: `true`, `false`.
	AutoStart pulumi.StringPtrInput
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrInput
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrInput
	// The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	DestinationEndpointEngineName pulumi.StringInput
	// The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationEndpointRegion pulumi.StringInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringPtrInput
	// The duration of prepaid instance purchase. this parameter is required When `paymentType` equals `Subscription`.
	PaymentDuration pulumi.IntPtrInput
	// The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDurationUnit pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringInput
	// The number of instances purchased.
	Quantity pulumi.IntPtrInput
	// The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	SourceEndpointEngineName pulumi.StringInput
	// The region of source instance.
	SourceEndpointRegion pulumi.StringInput
	// The sync architecture. Valid values: `oneway`, `bidirectional`.
	SyncArchitecture pulumi.StringPtrInput
}

The set of arguments for constructing a SynchronizationInstance resource.

func (SynchronizationInstanceArgs) ElementType

type SynchronizationInstanceArray

type SynchronizationInstanceArray []SynchronizationInstanceInput

func (SynchronizationInstanceArray) ElementType

func (SynchronizationInstanceArray) ToSynchronizationInstanceArrayOutput

func (i SynchronizationInstanceArray) ToSynchronizationInstanceArrayOutput() SynchronizationInstanceArrayOutput

func (SynchronizationInstanceArray) ToSynchronizationInstanceArrayOutputWithContext

func (i SynchronizationInstanceArray) ToSynchronizationInstanceArrayOutputWithContext(ctx context.Context) SynchronizationInstanceArrayOutput

type SynchronizationInstanceArrayInput

type SynchronizationInstanceArrayInput interface {
	pulumi.Input

	ToSynchronizationInstanceArrayOutput() SynchronizationInstanceArrayOutput
	ToSynchronizationInstanceArrayOutputWithContext(context.Context) SynchronizationInstanceArrayOutput
}

SynchronizationInstanceArrayInput is an input type that accepts SynchronizationInstanceArray and SynchronizationInstanceArrayOutput values. You can construct a concrete instance of `SynchronizationInstanceArrayInput` via:

SynchronizationInstanceArray{ SynchronizationInstanceArgs{...} }

type SynchronizationInstanceArrayOutput

type SynchronizationInstanceArrayOutput struct{ *pulumi.OutputState }

func (SynchronizationInstanceArrayOutput) ElementType

func (SynchronizationInstanceArrayOutput) Index

func (SynchronizationInstanceArrayOutput) ToSynchronizationInstanceArrayOutput

func (o SynchronizationInstanceArrayOutput) ToSynchronizationInstanceArrayOutput() SynchronizationInstanceArrayOutput

func (SynchronizationInstanceArrayOutput) ToSynchronizationInstanceArrayOutputWithContext

func (o SynchronizationInstanceArrayOutput) ToSynchronizationInstanceArrayOutputWithContext(ctx context.Context) SynchronizationInstanceArrayOutput

type SynchronizationInstanceInput

type SynchronizationInstanceInput interface {
	pulumi.Input

	ToSynchronizationInstanceOutput() SynchronizationInstanceOutput
	ToSynchronizationInstanceOutputWithContext(ctx context.Context) SynchronizationInstanceOutput
}

type SynchronizationInstanceMap

type SynchronizationInstanceMap map[string]SynchronizationInstanceInput

func (SynchronizationInstanceMap) ElementType

func (SynchronizationInstanceMap) ElementType() reflect.Type

func (SynchronizationInstanceMap) ToSynchronizationInstanceMapOutput

func (i SynchronizationInstanceMap) ToSynchronizationInstanceMapOutput() SynchronizationInstanceMapOutput

func (SynchronizationInstanceMap) ToSynchronizationInstanceMapOutputWithContext

func (i SynchronizationInstanceMap) ToSynchronizationInstanceMapOutputWithContext(ctx context.Context) SynchronizationInstanceMapOutput

type SynchronizationInstanceMapInput

type SynchronizationInstanceMapInput interface {
	pulumi.Input

	ToSynchronizationInstanceMapOutput() SynchronizationInstanceMapOutput
	ToSynchronizationInstanceMapOutputWithContext(context.Context) SynchronizationInstanceMapOutput
}

SynchronizationInstanceMapInput is an input type that accepts SynchronizationInstanceMap and SynchronizationInstanceMapOutput values. You can construct a concrete instance of `SynchronizationInstanceMapInput` via:

SynchronizationInstanceMap{ "key": SynchronizationInstanceArgs{...} }

type SynchronizationInstanceMapOutput

type SynchronizationInstanceMapOutput struct{ *pulumi.OutputState }

func (SynchronizationInstanceMapOutput) ElementType

func (SynchronizationInstanceMapOutput) MapIndex

func (SynchronizationInstanceMapOutput) ToSynchronizationInstanceMapOutput

func (o SynchronizationInstanceMapOutput) ToSynchronizationInstanceMapOutput() SynchronizationInstanceMapOutput

func (SynchronizationInstanceMapOutput) ToSynchronizationInstanceMapOutputWithContext

func (o SynchronizationInstanceMapOutput) ToSynchronizationInstanceMapOutputWithContext(ctx context.Context) SynchronizationInstanceMapOutput

type SynchronizationInstanceOutput

type SynchronizationInstanceOutput struct{ *pulumi.OutputState }

func (SynchronizationInstanceOutput) AutoPay added in v3.27.0

Whether to automatically renew when it expires. Valid values: `true`, `false`.

func (SynchronizationInstanceOutput) AutoStart added in v3.27.0

Whether to automatically start the task after the purchase completed. Valid values: `true`, `false`.

func (SynchronizationInstanceOutput) ComputeUnit added in v3.27.0

[ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.

func (SynchronizationInstanceOutput) DatabaseCount added in v3.27.0

The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.

func (SynchronizationInstanceOutput) DestinationEndpointEngineName added in v3.27.0

func (o SynchronizationInstanceOutput) DestinationEndpointEngineName() pulumi.StringOutput

The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).

func (SynchronizationInstanceOutput) DestinationEndpointRegion added in v3.27.0

func (o SynchronizationInstanceOutput) DestinationEndpointRegion() pulumi.StringOutput

The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).

func (SynchronizationInstanceOutput) ElementType

func (SynchronizationInstanceOutput) InstanceClass added in v3.27.0

The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).

func (SynchronizationInstanceOutput) PaymentDuration added in v3.27.0

The duration of prepaid instance purchase. this parameter is required When `paymentType` equals `Subscription`.

func (SynchronizationInstanceOutput) PaymentDurationUnit added in v3.27.0

func (o SynchronizationInstanceOutput) PaymentDurationUnit() pulumi.StringPtrOutput

The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.

func (SynchronizationInstanceOutput) PaymentType added in v3.27.0

The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.

func (SynchronizationInstanceOutput) Quantity added in v3.27.0

The number of instances purchased.

func (SynchronizationInstanceOutput) SourceEndpointEngineName added in v3.27.0

func (o SynchronizationInstanceOutput) SourceEndpointEngineName() pulumi.StringOutput

The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).

func (SynchronizationInstanceOutput) SourceEndpointRegion added in v3.27.0

func (o SynchronizationInstanceOutput) SourceEndpointRegion() pulumi.StringOutput

The region of source instance.

func (SynchronizationInstanceOutput) Status added in v3.27.0

The status.

func (SynchronizationInstanceOutput) SyncArchitecture added in v3.27.0

The sync architecture. Valid values: `oneway`, `bidirectional`.

func (SynchronizationInstanceOutput) ToSynchronizationInstanceOutput

func (o SynchronizationInstanceOutput) ToSynchronizationInstanceOutput() SynchronizationInstanceOutput

func (SynchronizationInstanceOutput) ToSynchronizationInstanceOutputWithContext

func (o SynchronizationInstanceOutput) ToSynchronizationInstanceOutputWithContext(ctx context.Context) SynchronizationInstanceOutput

type SynchronizationInstanceState

type SynchronizationInstanceState struct {
	// Whether to automatically renew when it expires. Valid values: `true`, `false`.
	AutoPay pulumi.StringPtrInput
	// Whether to automatically start the task after the purchase completed. Valid values: `true`, `false`.
	AutoStart pulumi.StringPtrInput
	// [ETL specifications](https://help.aliyun.com/document_detail/212324.html). The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
	ComputeUnit pulumi.IntPtrInput
	// The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when `sourceEndpointEngineName` equals `drds`.
	DatabaseCount pulumi.IntPtrInput
	// The type of destination engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The region of destination instance. List of [supported regions](https://help.aliyun.com/document_detail/141033.html).
	DestinationEndpointRegion pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringPtrInput
	// The duration of prepaid instance purchase. this parameter is required When `paymentType` equals `Subscription`.
	PaymentDuration pulumi.IntPtrInput
	// The payment duration unit. Valid values: `Month`, `Year`. When `paymentType` is `Subscription`, this parameter is valid and must be passed in.
	PaymentDurationUnit pulumi.StringPtrInput
	// The payment type of the resource. Valid values: `Subscription`, `PayAsYouGo`.
	PaymentType pulumi.StringPtrInput
	// The number of instances purchased.
	Quantity pulumi.IntPtrInput
	// The type of source endpoint engine. Valid values: `ADS`, `DB2`, `DRDS`, `DataHub`, `Greenplum`, `MSSQL`, `MySQL`, `PolarDB`, `PostgreSQL`, `Redis`, `Tablestore`, `as400`, `clickhouse`, `kafka`, `mongodb`, `odps`, `oracle`, `polardbO`, `polardbPg`, `tidb`. For the correspondence between the supported source and target libraries, see [Supported Databases, Synchronization Initialization Types and Synchronization Topologies](https://help.aliyun.com/document_detail/130744.html), [Supported Databases and Migration Types](https://help.aliyun.com/document_detail/26618.html).
	SourceEndpointEngineName pulumi.StringPtrInput
	// The region of source instance.
	SourceEndpointRegion pulumi.StringPtrInput
	// The status.
	Status pulumi.StringPtrInput
	// The sync architecture. Valid values: `oneway`, `bidirectional`.
	SyncArchitecture pulumi.StringPtrInput
}

func (SynchronizationInstanceState) ElementType

type SynchronizationJob

type SynchronizationJob struct {
	pulumi.CustomResourceState

	// The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
	Checkpoint pulumi.StringOutput `pulumi:"checkpoint"`
	// The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description [datacheckconfigure-parameter](https://help.aliyun.com/zh/dts/developer-reference/datacheckconfigure-parameter).
	DataCheckConfigure pulumi.StringPtrOutput `pulumi:"dataCheckConfigure"`
	// Whether to perform full data migration or full data initialization. Valid values: `true`, `false`.
	DataInitialization pulumi.BoolOutput `pulumi:"dataInitialization"`
	// Whether to perform incremental data migration or synchronization. Valid values: `true`, `false`.
	DataSynchronization pulumi.BoolOutput `pulumi:"dataSynchronization"`
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, synchronization or subscription objects](https://help.aliyun.com/document_detail/209545.html). **NOTE:** From version 1.173.0, `dbList` can be modified.
	DbList pulumi.StringOutput `pulumi:"dbList"`
	// When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
	DedicatedClusterId pulumi.StringPtrOutput `pulumi:"dedicatedClusterId"`
	// The delay notice. Valid values: `true`, `false`.
	DelayNotice pulumi.BoolPtrOutput `pulumi:"delayNotice"`
	// The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	DelayPhone pulumi.StringPtrOutput `pulumi:"delayPhone"`
	// The delay rule time. When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.
	DelayRuleTime pulumi.StringPtrOutput `pulumi:"delayRuleTime"`
	// The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
	DestinationEndpointDatabaseName pulumi.StringPtrOutput `pulumi:"destinationEndpointDatabaseName"`
	// The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter `reserve`. For the configuration method, see the description of `reserve` parameters. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName pulumi.StringOutput `pulumi:"destinationEndpointEngineName"`
	// The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of `destinationEndpointInstanceType`. For example, the value of `destinationEndpointInstanceType` is:
	// ** `ECS`, then this parameter needs to be passed into the instance ID of ECS.
	// ** `DG`, then this parameter needs to be passed into the ID of database gateway.
	// ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.
	DestinationEndpointInstanceId pulumi.StringPtrOutput `pulumi:"destinationEndpointInstanceId"`
	// The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to be `ECS` or `EXPRESS` as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the [overview of preparations](https://help.aliyun.com/document_detail/146958.htm). Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType pulumi.StringOutput `pulumi:"destinationEndpointInstanceType"`
	// The IP of source endpoint. When `destinationEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.
	DestinationEndpointIp pulumi.StringPtrOutput `pulumi:"destinationEndpointIp"`
	// The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	DestinationEndpointOracleSid pulumi.StringPtrOutput `pulumi:"destinationEndpointOracleSid"`
	// The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the **destinationendpointrle** parameter.
	DestinationEndpointOwnerId pulumi.StringPtrOutput `pulumi:"destinationEndpointOwnerId"`
	// The password of database account.
	DestinationEndpointPassword pulumi.StringPtrOutput `pulumi:"destinationEndpointPassword"`
	// The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
	DestinationEndpointPort pulumi.StringPtrOutput `pulumi:"destinationEndpointPort"`
	// The region of destination instance. For the target instance region, please refer to the [list of supported regions](https://help.aliyun.com/document_detail/141033.htm). Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
	DestinationEndpointRegion pulumi.StringPtrOutput `pulumi:"destinationEndpointRegion"`
	// The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
	DestinationEndpointRole pulumi.StringPtrOutput `pulumi:"destinationEndpointRole"`
	// The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).
	DestinationEndpointUserName pulumi.StringPtrOutput `pulumi:"destinationEndpointUserName"`
	// The environment label of the DTS instance. The value is: **normal**, **online**.
	//
	// > **NOTE:** From the status of `NotStarted` to `Synchronizing`, the resource goes through the `Prechecking` and `Initializing` phases. Because of the `Initializing` phase takes too long, and once the resource passes to the status of `Prechecking`, it can be considered that the task can be executed normally. Therefore, we treat the status of `Initializing` as an equivalent to `Synchronizing`.
	//
	// > **NOTE:** If you want to upgrade the synchronization job specifications by the property `instanceClass`, you must also modify the property `instanceClass` of it's instance to keep them consistent.
	DtsBisLabel pulumi.StringPtrOutput `pulumi:"dtsBisLabel"`
	// The ID of synchronization instance, it must be an ID of `dts.SynchronizationInstance`.
	DtsInstanceId pulumi.StringOutput `pulumi:"dtsInstanceId"`
	// The name of synchronization job.
	DtsJobName pulumi.StringOutput `pulumi:"dtsJobName"`
	// The error notice. Valid values: `true`, `false`.
	ErrorNotice pulumi.BoolPtrOutput `pulumi:"errorNotice"`
	// The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	ErrorPhone pulumi.StringPtrOutput `pulumi:"errorPhone"`
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringOutput `pulumi:"instanceClass"`
	// DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter [description of the Reserve parameter](https://help.aliyun.com/document_detail/273111.html).
	Reserve pulumi.StringOutput `pulumi:"reserve"`
	// The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
	SourceEndpointDatabaseName pulumi.StringPtrOutput `pulumi:"sourceEndpointDatabaseName"`
	// The type of source database. The default value is `MySQL`. For the correspondence between supported source libraries and target libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the source instance is `MONGODB`, you also need to pass in some information in the reserved parameter `Reserve`, for the configuration method, see the description of Reserve parameters. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName pulumi.StringOutput `pulumi:"sourceEndpointEngineName"`
	// The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of `sourceEndpointInstanceType`. For example, the value of `sourceEndpointInstanceType` is:
	// ** `ECS`, then this parameter needs to be passed into the instance ID of ECS.
	// ** `DG`, then this parameter needs to be passed into the ID of database gateway.
	// ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.
	SourceEndpointInstanceId pulumi.StringPtrOutput `pulumi:"sourceEndpointInstanceId"`
	// The type of source instance. If the source instance is a `PolarDB O` engine cluster, the source instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see [Preparations Overview](https://help.aliyun.com/document_detail/146958.htm). Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType pulumi.StringOutput `pulumi:"sourceEndpointInstanceType"`
	// The IP of source endpoint. When `sourceEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.
	SourceEndpointIp pulumi.StringPtrOutput `pulumi:"sourceEndpointIp"`
	// The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid pulumi.StringPtrOutput `pulumi:"sourceEndpointOracleSid"`
	// The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the `sourceEndpointRole` parameter.
	SourceEndpointOwnerId pulumi.StringPtrOutput `pulumi:"sourceEndpointOwnerId"`
	// The password of database account.
	SourceEndpointPassword pulumi.StringPtrOutput `pulumi:"sourceEndpointPassword"`
	// The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
	SourceEndpointPort pulumi.StringPtrOutput `pulumi:"sourceEndpointPort"`
	// Source instance area, please refer to the [list of supported areas](https://help.aliyun.com/document_detail/141033.htm) for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
	SourceEndpointRegion pulumi.StringPtrOutput `pulumi:"sourceEndpointRegion"`
	// The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to [How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization](https://help.aliyun.com/document_detail/48468.htm).
	SourceEndpointRole pulumi.StringPtrOutput `pulumi:"sourceEndpointRole"`
	// The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).
	SourceEndpointUserName pulumi.StringPtrOutput `pulumi:"sourceEndpointUserName"`
	// Data Delivery link switch instance id
	SourceEndpointVswitchId pulumi.StringPtrOutput `pulumi:"sourceEndpointVswitchId"`
	// The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.
	Status pulumi.StringOutput `pulumi:"status"`
	// Whether to perform library table structure migration or initialization. Valid values: `true`, `false`.
	StructureInitialization pulumi.BoolOutput `pulumi:"structureInitialization"`
	// Synchronization direction. Valid values: `Forward`, `Reverse`. Only when the property `syncArchitecture` of the `dts.SynchronizationInstance` was `bidirectional` this parameter should be passed, otherwise this parameter should not be specified.
	SynchronizationDirection pulumi.StringOutput `pulumi:"synchronizationDirection"`
}

Provides a DTS Synchronization Job resource.

For information about DTS Synchronization Job and how to use it, see [What is Synchronization Job](https://www.alibabacloud.com/product/data-transmission-service).

> **NOTE:** Available since v1.138.0.

## Import

DTS Synchronization Job can be imported using the id, e.g.

```sh $ pulumi import alicloud:dts/synchronizationJob:SynchronizationJob example <id> ```

func GetSynchronizationJob

func GetSynchronizationJob(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SynchronizationJobState, opts ...pulumi.ResourceOption) (*SynchronizationJob, error)

GetSynchronizationJob gets an existing SynchronizationJob resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSynchronizationJob

func NewSynchronizationJob(ctx *pulumi.Context,
	name string, args *SynchronizationJobArgs, opts ...pulumi.ResourceOption) (*SynchronizationJob, error)

NewSynchronizationJob registers a new resource with the given unique name, arguments, and options.

func (*SynchronizationJob) ElementType

func (*SynchronizationJob) ElementType() reflect.Type

func (*SynchronizationJob) ToSynchronizationJobOutput

func (i *SynchronizationJob) ToSynchronizationJobOutput() SynchronizationJobOutput

func (*SynchronizationJob) ToSynchronizationJobOutputWithContext

func (i *SynchronizationJob) ToSynchronizationJobOutputWithContext(ctx context.Context) SynchronizationJobOutput

type SynchronizationJobArgs

type SynchronizationJobArgs struct {
	// The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
	Checkpoint pulumi.StringPtrInput
	// The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description [datacheckconfigure-parameter](https://help.aliyun.com/zh/dts/developer-reference/datacheckconfigure-parameter).
	DataCheckConfigure pulumi.StringPtrInput
	// Whether to perform full data migration or full data initialization. Valid values: `true`, `false`.
	DataInitialization pulumi.BoolInput
	// Whether to perform incremental data migration or synchronization. Valid values: `true`, `false`.
	DataSynchronization pulumi.BoolInput
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, synchronization or subscription objects](https://help.aliyun.com/document_detail/209545.html). **NOTE:** From version 1.173.0, `dbList` can be modified.
	DbList pulumi.StringInput
	// When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
	DedicatedClusterId pulumi.StringPtrInput
	// The delay notice. Valid values: `true`, `false`.
	DelayNotice pulumi.BoolPtrInput
	// The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	DelayPhone pulumi.StringPtrInput
	// The delay rule time. When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.
	DelayRuleTime pulumi.StringPtrInput
	// The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
	DestinationEndpointDatabaseName pulumi.StringPtrInput
	// The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter `reserve`. For the configuration method, see the description of `reserve` parameters. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName pulumi.StringInput
	// The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of `destinationEndpointInstanceType`. For example, the value of `destinationEndpointInstanceType` is:
	// ** `ECS`, then this parameter needs to be passed into the instance ID of ECS.
	// ** `DG`, then this parameter needs to be passed into the ID of database gateway.
	// ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.
	DestinationEndpointInstanceId pulumi.StringPtrInput
	// The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to be `ECS` or `EXPRESS` as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the [overview of preparations](https://help.aliyun.com/document_detail/146958.htm). Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType pulumi.StringInput
	// The IP of source endpoint. When `destinationEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.
	DestinationEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	DestinationEndpointOracleSid pulumi.StringPtrInput
	// The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the **destinationendpointrle** parameter.
	DestinationEndpointOwnerId pulumi.StringPtrInput
	// The password of database account.
	DestinationEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
	DestinationEndpointPort pulumi.StringPtrInput
	// The region of destination instance. For the target instance region, please refer to the [list of supported regions](https://help.aliyun.com/document_detail/141033.htm). Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
	DestinationEndpointRegion pulumi.StringPtrInput
	// The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
	DestinationEndpointRole pulumi.StringPtrInput
	// The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).
	DestinationEndpointUserName pulumi.StringPtrInput
	// The environment label of the DTS instance. The value is: **normal**, **online**.
	//
	// > **NOTE:** From the status of `NotStarted` to `Synchronizing`, the resource goes through the `Prechecking` and `Initializing` phases. Because of the `Initializing` phase takes too long, and once the resource passes to the status of `Prechecking`, it can be considered that the task can be executed normally. Therefore, we treat the status of `Initializing` as an equivalent to `Synchronizing`.
	//
	// > **NOTE:** If you want to upgrade the synchronization job specifications by the property `instanceClass`, you must also modify the property `instanceClass` of it's instance to keep them consistent.
	DtsBisLabel pulumi.StringPtrInput
	// The ID of synchronization instance, it must be an ID of `dts.SynchronizationInstance`.
	DtsInstanceId pulumi.StringInput
	// The name of synchronization job.
	DtsJobName pulumi.StringInput
	// The error notice. Valid values: `true`, `false`.
	ErrorNotice pulumi.BoolPtrInput
	// The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	ErrorPhone pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringPtrInput
	// DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter [description of the Reserve parameter](https://help.aliyun.com/document_detail/273111.html).
	Reserve pulumi.StringPtrInput
	// The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
	SourceEndpointDatabaseName pulumi.StringPtrInput
	// The type of source database. The default value is `MySQL`. For the correspondence between supported source libraries and target libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the source instance is `MONGODB`, you also need to pass in some information in the reserved parameter `Reserve`, for the configuration method, see the description of Reserve parameters. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName pulumi.StringInput
	// The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of `sourceEndpointInstanceType`. For example, the value of `sourceEndpointInstanceType` is:
	// ** `ECS`, then this parameter needs to be passed into the instance ID of ECS.
	// ** `DG`, then this parameter needs to be passed into the ID of database gateway.
	// ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.
	SourceEndpointInstanceId pulumi.StringPtrInput
	// The type of source instance. If the source instance is a `PolarDB O` engine cluster, the source instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see [Preparations Overview](https://help.aliyun.com/document_detail/146958.htm). Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType pulumi.StringInput
	// The IP of source endpoint. When `sourceEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.
	SourceEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid pulumi.StringPtrInput
	// The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the `sourceEndpointRole` parameter.
	SourceEndpointOwnerId pulumi.StringPtrInput
	// The password of database account.
	SourceEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
	SourceEndpointPort pulumi.StringPtrInput
	// Source instance area, please refer to the [list of supported areas](https://help.aliyun.com/document_detail/141033.htm) for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
	SourceEndpointRegion pulumi.StringPtrInput
	// The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to [How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization](https://help.aliyun.com/document_detail/48468.htm).
	SourceEndpointRole pulumi.StringPtrInput
	// The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).
	SourceEndpointUserName pulumi.StringPtrInput
	// Data Delivery link switch instance id
	SourceEndpointVswitchId pulumi.StringPtrInput
	// The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.
	Status pulumi.StringPtrInput
	// Whether to perform library table structure migration or initialization. Valid values: `true`, `false`.
	StructureInitialization pulumi.BoolInput
	// Synchronization direction. Valid values: `Forward`, `Reverse`. Only when the property `syncArchitecture` of the `dts.SynchronizationInstance` was `bidirectional` this parameter should be passed, otherwise this parameter should not be specified.
	SynchronizationDirection pulumi.StringPtrInput
}

The set of arguments for constructing a SynchronizationJob resource.

func (SynchronizationJobArgs) ElementType

func (SynchronizationJobArgs) ElementType() reflect.Type

type SynchronizationJobArray

type SynchronizationJobArray []SynchronizationJobInput

func (SynchronizationJobArray) ElementType

func (SynchronizationJobArray) ElementType() reflect.Type

func (SynchronizationJobArray) ToSynchronizationJobArrayOutput

func (i SynchronizationJobArray) ToSynchronizationJobArrayOutput() SynchronizationJobArrayOutput

func (SynchronizationJobArray) ToSynchronizationJobArrayOutputWithContext

func (i SynchronizationJobArray) ToSynchronizationJobArrayOutputWithContext(ctx context.Context) SynchronizationJobArrayOutput

type SynchronizationJobArrayInput

type SynchronizationJobArrayInput interface {
	pulumi.Input

	ToSynchronizationJobArrayOutput() SynchronizationJobArrayOutput
	ToSynchronizationJobArrayOutputWithContext(context.Context) SynchronizationJobArrayOutput
}

SynchronizationJobArrayInput is an input type that accepts SynchronizationJobArray and SynchronizationJobArrayOutput values. You can construct a concrete instance of `SynchronizationJobArrayInput` via:

SynchronizationJobArray{ SynchronizationJobArgs{...} }

type SynchronizationJobArrayOutput

type SynchronizationJobArrayOutput struct{ *pulumi.OutputState }

func (SynchronizationJobArrayOutput) ElementType

func (SynchronizationJobArrayOutput) Index

func (SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutput

func (o SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutput() SynchronizationJobArrayOutput

func (SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutputWithContext

func (o SynchronizationJobArrayOutput) ToSynchronizationJobArrayOutputWithContext(ctx context.Context) SynchronizationJobArrayOutput

type SynchronizationJobInput

type SynchronizationJobInput interface {
	pulumi.Input

	ToSynchronizationJobOutput() SynchronizationJobOutput
	ToSynchronizationJobOutputWithContext(ctx context.Context) SynchronizationJobOutput
}

type SynchronizationJobMap

type SynchronizationJobMap map[string]SynchronizationJobInput

func (SynchronizationJobMap) ElementType

func (SynchronizationJobMap) ElementType() reflect.Type

func (SynchronizationJobMap) ToSynchronizationJobMapOutput

func (i SynchronizationJobMap) ToSynchronizationJobMapOutput() SynchronizationJobMapOutput

func (SynchronizationJobMap) ToSynchronizationJobMapOutputWithContext

func (i SynchronizationJobMap) ToSynchronizationJobMapOutputWithContext(ctx context.Context) SynchronizationJobMapOutput

type SynchronizationJobMapInput

type SynchronizationJobMapInput interface {
	pulumi.Input

	ToSynchronizationJobMapOutput() SynchronizationJobMapOutput
	ToSynchronizationJobMapOutputWithContext(context.Context) SynchronizationJobMapOutput
}

SynchronizationJobMapInput is an input type that accepts SynchronizationJobMap and SynchronizationJobMapOutput values. You can construct a concrete instance of `SynchronizationJobMapInput` via:

SynchronizationJobMap{ "key": SynchronizationJobArgs{...} }

type SynchronizationJobMapOutput

type SynchronizationJobMapOutput struct{ *pulumi.OutputState }

func (SynchronizationJobMapOutput) ElementType

func (SynchronizationJobMapOutput) MapIndex

func (SynchronizationJobMapOutput) ToSynchronizationJobMapOutput

func (o SynchronizationJobMapOutput) ToSynchronizationJobMapOutput() SynchronizationJobMapOutput

func (SynchronizationJobMapOutput) ToSynchronizationJobMapOutputWithContext

func (o SynchronizationJobMapOutput) ToSynchronizationJobMapOutputWithContext(ctx context.Context) SynchronizationJobMapOutput

type SynchronizationJobOutput

type SynchronizationJobOutput struct{ *pulumi.OutputState }

func (SynchronizationJobOutput) Checkpoint added in v3.27.0

The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.

func (SynchronizationJobOutput) DataCheckConfigure added in v3.45.1

func (o SynchronizationJobOutput) DataCheckConfigure() pulumi.StringPtrOutput

The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description [datacheckconfigure-parameter](https://help.aliyun.com/zh/dts/developer-reference/datacheckconfigure-parameter).

func (SynchronizationJobOutput) DataInitialization added in v3.27.0

func (o SynchronizationJobOutput) DataInitialization() pulumi.BoolOutput

Whether to perform full data migration or full data initialization. Valid values: `true`, `false`.

func (SynchronizationJobOutput) DataSynchronization added in v3.27.0

func (o SynchronizationJobOutput) DataSynchronization() pulumi.BoolOutput

Whether to perform incremental data migration or synchronization. Valid values: `true`, `false`.

func (SynchronizationJobOutput) DbList added in v3.27.0

Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, synchronization or subscription objects](https://help.aliyun.com/document_detail/209545.html). **NOTE:** From version 1.173.0, `dbList` can be modified.

func (SynchronizationJobOutput) DedicatedClusterId added in v3.45.1

func (o SynchronizationJobOutput) DedicatedClusterId() pulumi.StringPtrOutput

When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.

func (SynchronizationJobOutput) DelayNotice added in v3.27.0

The delay notice. Valid values: `true`, `false`.

func (SynchronizationJobOutput) DelayPhone added in v3.27.0

The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.

func (SynchronizationJobOutput) DelayRuleTime added in v3.27.0

The delay rule time. When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.

func (SynchronizationJobOutput) DestinationEndpointDatabaseName added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointDatabaseName() pulumi.StringPtrOutput

The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.

func (SynchronizationJobOutput) DestinationEndpointEngineName added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointEngineName() pulumi.StringOutput

The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter `reserve`. For the configuration method, see the description of `reserve` parameters. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.

func (SynchronizationJobOutput) DestinationEndpointInstanceId added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointInstanceId() pulumi.StringPtrOutput

The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of `destinationEndpointInstanceType`. For example, the value of `destinationEndpointInstanceType` is: ** `ECS`, then this parameter needs to be passed into the instance ID of ECS. ** `DG`, then this parameter needs to be passed into the ID of database gateway. ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.

func (SynchronizationJobOutput) DestinationEndpointInstanceType added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointInstanceType() pulumi.StringOutput

The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to be `ECS` or `EXPRESS` as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the [overview of preparations](https://help.aliyun.com/document_detail/146958.htm). Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.

func (SynchronizationJobOutput) DestinationEndpointIp added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointIp() pulumi.StringPtrOutput

The IP of source endpoint. When `destinationEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.

func (SynchronizationJobOutput) DestinationEndpointOracleSid added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointOracleSid() pulumi.StringPtrOutput

The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.

func (SynchronizationJobOutput) DestinationEndpointOwnerId added in v3.45.1

func (o SynchronizationJobOutput) DestinationEndpointOwnerId() pulumi.StringPtrOutput

The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the **destinationendpointrle** parameter.

func (SynchronizationJobOutput) DestinationEndpointPassword added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointPassword() pulumi.StringPtrOutput

The password of database account.

func (SynchronizationJobOutput) DestinationEndpointPort added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointPort() pulumi.StringPtrOutput

The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.

func (SynchronizationJobOutput) DestinationEndpointRegion added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointRegion() pulumi.StringPtrOutput

The region of destination instance. For the target instance region, please refer to the [list of supported regions](https://help.aliyun.com/document_detail/141033.htm). Note: if the target is an Alibaba Cloud database, this parameter must be passed in.

func (SynchronizationJobOutput) DestinationEndpointRole added in v3.45.1

func (o SynchronizationJobOutput) DestinationEndpointRole() pulumi.StringPtrOutput

The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.

func (SynchronizationJobOutput) DestinationEndpointUserName added in v3.27.0

func (o SynchronizationJobOutput) DestinationEndpointUserName() pulumi.StringPtrOutput

The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).

func (SynchronizationJobOutput) DtsBisLabel added in v3.45.1

The environment label of the DTS instance. The value is: **normal**, **online**.

> **NOTE:** From the status of `NotStarted` to `Synchronizing`, the resource goes through the `Prechecking` and `Initializing` phases. Because of the `Initializing` phase takes too long, and once the resource passes to the status of `Prechecking`, it can be considered that the task can be executed normally. Therefore, we treat the status of `Initializing` as an equivalent to `Synchronizing`.

> **NOTE:** If you want to upgrade the synchronization job specifications by the property `instanceClass`, you must also modify the property `instanceClass` of it's instance to keep them consistent.

func (SynchronizationJobOutput) DtsInstanceId added in v3.27.0

func (o SynchronizationJobOutput) DtsInstanceId() pulumi.StringOutput

The ID of synchronization instance, it must be an ID of `dts.SynchronizationInstance`.

func (SynchronizationJobOutput) DtsJobName added in v3.27.0

The name of synchronization job.

func (SynchronizationJobOutput) ElementType

func (SynchronizationJobOutput) ElementType() reflect.Type

func (SynchronizationJobOutput) ErrorNotice added in v3.27.0

The error notice. Valid values: `true`, `false`.

func (SynchronizationJobOutput) ErrorPhone added in v3.27.0

The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.

func (SynchronizationJobOutput) InstanceClass added in v3.27.0

func (o SynchronizationJobOutput) InstanceClass() pulumi.StringOutput

The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).

func (SynchronizationJobOutput) Reserve added in v3.27.0

DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter [description of the Reserve parameter](https://help.aliyun.com/document_detail/273111.html).

func (SynchronizationJobOutput) SourceEndpointDatabaseName added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointDatabaseName() pulumi.StringPtrOutput

The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.

func (SynchronizationJobOutput) SourceEndpointEngineName added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointEngineName() pulumi.StringOutput

The type of source database. The default value is `MySQL`. For the correspondence between supported source libraries and target libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the source instance is `MONGODB`, you also need to pass in some information in the reserved parameter `Reserve`, for the configuration method, see the description of Reserve parameters. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.

func (SynchronizationJobOutput) SourceEndpointInstanceId added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointInstanceId() pulumi.StringPtrOutput

The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of `sourceEndpointInstanceType`. For example, the value of `sourceEndpointInstanceType` is: ** `ECS`, then this parameter needs to be passed into the instance ID of ECS. ** `DG`, then this parameter needs to be passed into the ID of database gateway. ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.

func (SynchronizationJobOutput) SourceEndpointInstanceType added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointInstanceType() pulumi.StringOutput

The type of source instance. If the source instance is a `PolarDB O` engine cluster, the source instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see [Preparations Overview](https://help.aliyun.com/document_detail/146958.htm). Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.

func (SynchronizationJobOutput) SourceEndpointIp added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointIp() pulumi.StringPtrOutput

The IP of source endpoint. When `sourceEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.

func (SynchronizationJobOutput) SourceEndpointOracleSid added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointOracleSid() pulumi.StringPtrOutput

The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.

func (SynchronizationJobOutput) SourceEndpointOwnerId added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointOwnerId() pulumi.StringPtrOutput

The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the `sourceEndpointRole` parameter.

func (SynchronizationJobOutput) SourceEndpointPassword added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointPassword() pulumi.StringPtrOutput

The password of database account.

func (SynchronizationJobOutput) SourceEndpointPort added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointPort() pulumi.StringPtrOutput

The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.

func (SynchronizationJobOutput) SourceEndpointRegion added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointRegion() pulumi.StringPtrOutput

Source instance area, please refer to the [list of supported areas](https://help.aliyun.com/document_detail/141033.htm) for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.

func (SynchronizationJobOutput) SourceEndpointRole added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointRole() pulumi.StringPtrOutput

The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to [How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization](https://help.aliyun.com/document_detail/48468.htm).

func (SynchronizationJobOutput) SourceEndpointUserName added in v3.27.0

func (o SynchronizationJobOutput) SourceEndpointUserName() pulumi.StringPtrOutput

The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).

func (SynchronizationJobOutput) SourceEndpointVswitchId added in v3.45.1

func (o SynchronizationJobOutput) SourceEndpointVswitchId() pulumi.StringPtrOutput

Data Delivery link switch instance id

func (SynchronizationJobOutput) Status added in v3.27.0

The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.

func (SynchronizationJobOutput) StructureInitialization added in v3.27.0

func (o SynchronizationJobOutput) StructureInitialization() pulumi.BoolOutput

Whether to perform library table structure migration or initialization. Valid values: `true`, `false`.

func (SynchronizationJobOutput) SynchronizationDirection added in v3.27.0

func (o SynchronizationJobOutput) SynchronizationDirection() pulumi.StringOutput

Synchronization direction. Valid values: `Forward`, `Reverse`. Only when the property `syncArchitecture` of the `dts.SynchronizationInstance` was `bidirectional` this parameter should be passed, otherwise this parameter should not be specified.

func (SynchronizationJobOutput) ToSynchronizationJobOutput

func (o SynchronizationJobOutput) ToSynchronizationJobOutput() SynchronizationJobOutput

func (SynchronizationJobOutput) ToSynchronizationJobOutputWithContext

func (o SynchronizationJobOutput) ToSynchronizationJobOutputWithContext(ctx context.Context) SynchronizationJobOutput

type SynchronizationJobState

type SynchronizationJobState struct {
	// The start point or synchronization point of incremental data migration, the format is Unix timestamp, and the unit is seconds.
	Checkpoint pulumi.StringPtrInput
	// The data verification task of the migration or synchronization instance, in the format of a JSON string, such as parameter limits or alarm configurations. For more information, see the DataCheckConfigure parameter description [datacheckconfigure-parameter](https://help.aliyun.com/zh/dts/developer-reference/datacheckconfigure-parameter).
	DataCheckConfigure pulumi.StringPtrInput
	// Whether to perform full data migration or full data initialization. Valid values: `true`, `false`.
	DataInitialization pulumi.BoolPtrInput
	// Whether to perform incremental data migration or synchronization. Valid values: `true`, `false`.
	DataSynchronization pulumi.BoolPtrInput
	// Migration object, in the format of JSON strings. For detailed definition instructions, please refer to [the description of migration, synchronization or subscription objects](https://help.aliyun.com/document_detail/209545.html). **NOTE:** From version 1.173.0, `dbList` can be modified.
	DbList pulumi.StringPtrInput
	// When the ID of the dedicated cluster is input, the task is scheduled to the corresponding cluster.
	DedicatedClusterId pulumi.StringPtrInput
	// The delay notice. Valid values: `true`, `false`.
	DelayNotice pulumi.BoolPtrInput
	// The delay phone. The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	DelayPhone pulumi.StringPtrInput
	// The delay rule time. When `delayNotice` is set to `true`, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.
	DelayRuleTime pulumi.StringPtrInput
	// The name of the database to which the migration object belongs in the target instance. Note: when the target instance or target database type is PolarDB O engine, AnalyticDB PostgreSQL, PostgreSQL, MongoDB database, this parameter is available and must be passed in.
	DestinationEndpointDatabaseName pulumi.StringPtrInput
	// The type of destination database. The default value is MYSQL. For the correspondence between supported target libraries and source libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the target instance is KAFKA or MONGODB, you also need to pass in some information in the reserved parameter `reserve`. For the configuration method, see the description of `reserve` parameters. Valid values: `ADS`, `ADB30`, `AS400`, `DATAHUB`, `DB2`, `GREENPLUM`, `KAFKA`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `PostgreSQL`.
	DestinationEndpointEngineName pulumi.StringPtrInput
	// The ID of destination instance. If the target instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the target instance is a self-built database, the value of this parameter changes according to the value of `destinationEndpointInstanceType`. For example, the value of `destinationEndpointInstanceType` is:
	// ** `ECS`, then this parameter needs to be passed into the instance ID of ECS.
	// ** `DG`, then this parameter needs to be passed into the ID of database gateway.
	// ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.
	DestinationEndpointInstanceId pulumi.StringPtrInput
	// The type of destination instance. If the target instance is a PolarDB O engine cluster, the target instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. If the target instance is the Kafka version of Message Queuing, the target instance type needs to be `ECS` or `EXPRESS` as a self-built database, and access via ECS or dedicated line. For the correspondence between supported targets and source instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the target instance is a self-built database, you also need to perform corresponding preparations, please refer to the [overview of preparations](https://help.aliyun.com/document_detail/146958.htm). Valid values: `ADS`, `CEN`, `DATAHUB`, `DG`, `ECS`, `EXPRESS`, `GREENPLUM`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	DestinationEndpointInstanceType pulumi.StringPtrInput
	// The IP of source endpoint. When `destinationEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.
	DestinationEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database. Note: when the value of DestinationEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	DestinationEndpointOracleSid pulumi.StringPtrInput
	// The ID of the Alibaba Cloud account to which the target RDS MySQL instance belongs. can be configured only when the target instance is RDS MySQL. This parameter is used to migrate or synchronize data across Alibaba Cloud accounts. You also need to enter the **destinationendpointrle** parameter.
	DestinationEndpointOwnerId pulumi.StringPtrInput
	// The password of database account.
	DestinationEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint. When the target instance is a self-built database, this parameter is available and must be passed in.
	DestinationEndpointPort pulumi.StringPtrInput
	// The region of destination instance. For the target instance region, please refer to the [list of supported regions](https://help.aliyun.com/document_detail/141033.htm). Note: if the target is an Alibaba Cloud database, this parameter must be passed in.
	DestinationEndpointRegion pulumi.StringPtrInput
	// The role name of the Alibaba Cloud account to which the target instance belongs. This parameter must be entered when data migration or synchronization across Alibaba Cloud accounts is performed. For the permissions and authorization methods required by this role.
	DestinationEndpointRole pulumi.StringPtrInput
	// The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).
	DestinationEndpointUserName pulumi.StringPtrInput
	// The environment label of the DTS instance. The value is: **normal**, **online**.
	//
	// > **NOTE:** From the status of `NotStarted` to `Synchronizing`, the resource goes through the `Prechecking` and `Initializing` phases. Because of the `Initializing` phase takes too long, and once the resource passes to the status of `Prechecking`, it can be considered that the task can be executed normally. Therefore, we treat the status of `Initializing` as an equivalent to `Synchronizing`.
	//
	// > **NOTE:** If you want to upgrade the synchronization job specifications by the property `instanceClass`, you must also modify the property `instanceClass` of it's instance to keep them consistent.
	DtsBisLabel pulumi.StringPtrInput
	// The ID of synchronization instance, it must be an ID of `dts.SynchronizationInstance`.
	DtsInstanceId pulumi.StringPtrInput
	// The name of synchronization job.
	DtsJobName pulumi.StringPtrInput
	// The error notice. Valid values: `true`, `false`.
	ErrorNotice pulumi.BoolPtrInput
	// The error phone. The mobile phone number of the contact who error the alarm. Multiple mobile phone numbers separated by English commas `,`. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.
	ErrorPhone pulumi.StringPtrInput
	// The instance class. Valid values: `large`, `medium`, `micro`, `small`, `xlarge`, `xxlarge`. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to [submit a ticket](https://selfservice.console.aliyun.com/ticket/category/dts/today).
	InstanceClass pulumi.StringPtrInput
	// DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter [description of the Reserve parameter](https://help.aliyun.com/document_detail/273111.html).
	Reserve pulumi.StringPtrInput
	// The name of the database to which the migration object belongs in the source instance. Note: this parameter is only available and must be passed in when the source instance, or the database type of the source instance is PolarDB O engine, PostgreSQL, or MongoDB database.
	SourceEndpointDatabaseName pulumi.StringPtrInput
	// The type of source database. The default value is `MySQL`. For the correspondence between supported source libraries and target libraries, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the database type of the source instance is `MONGODB`, you also need to pass in some information in the reserved parameter `Reserve`, for the configuration method, see the description of Reserve parameters. Valid values: `AS400`, `DB2`, `DMSPOLARDB`, `HBASE`, `MONGODB`, `MSSQL`, `MySQL`, `ORACLE`, `PolarDB`, `POLARDBX20`, `POLARDB_O`, `POSTGRESQL`, `TERADATA`.
	SourceEndpointEngineName pulumi.StringPtrInput
	// The ID of source instance. If the source instance is a cloud database (such as RDS MySQL), you need to pass in the instance ID of the cloud database (such as the instance ID of RDS MySQL). If the source instance is a self-built database, the value of this parameter changes according to the value of `sourceEndpointInstanceType`. For example, the value of `sourceEndpointInstanceType` is:
	// ** `ECS`, then this parameter needs to be passed into the instance ID of ECS.
	// ** `DG`, then this parameter needs to be passed into the ID of database gateway.
	// ** `EXPRESS`, `CEN`, then this parameter needs to be passed in the ID of VPC that has been interconnected with the source database. **Note**: when the value is `CEN`, you also need to pass in the ID of CEN instance in the cloud enterprise network with the reserved parameter `reserve`.
	SourceEndpointInstanceId pulumi.StringPtrInput
	// The type of source instance. If the source instance is a `PolarDB O` engine cluster, the source instance type needs to be `OTHER` or `EXPRESS` as a self-built database, and access via public IP or dedicated line. For the correspondence between supported source and target instances, see [Supported Databases](https://help.aliyun.com/document_detail/131497.htm). When the source instance is a self-built database, you also need to perform corresponding preparations, for details, see [Preparations Overview](https://help.aliyun.com/document_detail/146958.htm). Valid values: `CEN`, `DG`, `DISTRIBUTED_DMSLOGICDB`, `ECS`, `EXPRESS`, `MONGODB`, `OTHER`, `PolarDB`, `POLARDBX20`, `RDS`.
	SourceEndpointInstanceType pulumi.StringPtrInput
	// The IP of source endpoint. When `sourceEndpointInstanceType` is `OTHER`, `EXPRESS`, `DG`, `CEN`, this parameter is available and must be passed in.
	SourceEndpointIp pulumi.StringPtrInput
	// The SID of Oracle database. When the value of SourceEndpointEngineName is Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
	SourceEndpointOracleSid pulumi.StringPtrInput
	// The ID of Alibaba Cloud account to which the source instance belongs. Note: passing in this parameter means performing data migration or synchronization across Alibaba Cloud accounts, and you also need to pass in the `sourceEndpointRole` parameter.
	SourceEndpointOwnerId pulumi.StringPtrInput
	// The password of database account.
	SourceEndpointPassword pulumi.StringPtrInput
	// The port of source endpoint. When the source instance is a self-built database, this parameter is available and must be passed in.
	SourceEndpointPort pulumi.StringPtrInput
	// Source instance area, please refer to the [list of supported areas](https://help.aliyun.com/document_detail/141033.htm) for details. Note if the source is an Alibaba Cloud database, this parameter must be passed in.
	SourceEndpointRegion pulumi.StringPtrInput
	// The name of the role configured for the cloud account to which the source instance belongs. Note: this parameter must be passed in when performing cross Alibaba Cloud account data migration or synchronization. For the permissions and authorization methods required by this role, please refer to [How to configure RAM authorization when cross-Alibaba Cloud account data migration or synchronization](https://help.aliyun.com/document_detail/48468.htm).
	SourceEndpointRole pulumi.StringPtrInput
	// The username of database account. Note: in most cases, you need to pass in the database account of the source library. The permissions required for migrating or synchronizing different databases are different. For specific permission requirements, see [Preparing database accounts for data migration](https://help.aliyun.com/document_detail/175878.htm) and [Preparing database accounts for data synchronization](https://help.aliyun.com/document_detail/213152.htm).
	SourceEndpointUserName pulumi.StringPtrInput
	// Data Delivery link switch instance id
	SourceEndpointVswitchId pulumi.StringPtrInput
	// The status of the resource. Valid values: `Synchronizing`, `Suspending`. You can stop the task by specifying `Suspending` and start the task by specifying `Synchronizing`.
	Status pulumi.StringPtrInput
	// Whether to perform library table structure migration or initialization. Valid values: `true`, `false`.
	StructureInitialization pulumi.BoolPtrInput
	// Synchronization direction. Valid values: `Forward`, `Reverse`. Only when the property `syncArchitecture` of the `dts.SynchronizationInstance` was `bidirectional` this parameter should be passed, otherwise this parameter should not be specified.
	SynchronizationDirection pulumi.StringPtrInput
}

func (SynchronizationJobState) ElementType

func (SynchronizationJobState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL