opentelekomcloud.DmsSmartConnectTaskV2
Explore with Pulumi AI
Up-to-date reference of API arguments for DMS instance you can get at documentation portal
Manage DMS kafka smart connect task resource within OpenTelekomCloud.
Example Usage
Create a task to dump Kafka data to OBS
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const taskName = config.requireObject("taskName");
const topics = config.requireObject("topics");
const accessKey = config.requireObject("accessKey");
const secretKey = config.requireObject("secretKey");
const obsBucketName = config.requireObject("obsBucketName");
const obsPath = config.requireObject("obsPath");
const test = new opentelekomcloud.DmsSmartConnectTaskV2("test", {
instanceId: instanceId,
taskName: taskName,
topics: topics,
destinationType: "OBS_SINK",
destinationTask: {
consumerStrategy: "latest",
destinationFileType: "TEXT",
accessKey: accessKey,
secretKey: secretKey,
obsBucketName: obsBucketName,
obsPath: obsPath,
partitionFormat: "yyyy/MM/dd/HH/mm",
recordDelimiter: "\n",
deliverTimeInterval: 300,
},
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
config = pulumi.Config()
instance_id = config.require_object("instanceId")
task_name = config.require_object("taskName")
topics = config.require_object("topics")
access_key = config.require_object("accessKey")
secret_key = config.require_object("secretKey")
obs_bucket_name = config.require_object("obsBucketName")
obs_path = config.require_object("obsPath")
test = opentelekomcloud.DmsSmartConnectTaskV2("test",
instance_id=instance_id,
task_name=task_name,
topics=topics,
destination_type="OBS_SINK",
destination_task={
"consumer_strategy": "latest",
"destination_file_type": "TEXT",
"access_key": access_key,
"secret_key": secret_key,
"obs_bucket_name": obs_bucket_name,
"obs_path": obs_path,
"partition_format": "yyyy/MM/dd/HH/mm",
"record_delimiter": "\n",
"deliver_time_interval": 300,
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"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, "")
instanceId := cfg.RequireObject("instanceId")
taskName := cfg.RequireObject("taskName")
topics := cfg.RequireObject("topics")
accessKey := cfg.RequireObject("accessKey")
secretKey := cfg.RequireObject("secretKey")
obsBucketName := cfg.RequireObject("obsBucketName")
obsPath := cfg.RequireObject("obsPath")
_, err := opentelekomcloud.NewDmsSmartConnectTaskV2(ctx, "test", &opentelekomcloud.DmsSmartConnectTaskV2Args{
InstanceId: pulumi.Any(instanceId),
TaskName: pulumi.Any(taskName),
Topics: pulumi.Any(topics),
DestinationType: pulumi.String("OBS_SINK"),
DestinationTask: &opentelekomcloud.DmsSmartConnectTaskV2DestinationTaskArgs{
ConsumerStrategy: pulumi.String("latest"),
DestinationFileType: pulumi.String("TEXT"),
AccessKey: pulumi.Any(accessKey),
SecretKey: pulumi.Any(secretKey),
ObsBucketName: pulumi.Any(obsBucketName),
ObsPath: pulumi.Any(obsPath),
PartitionFormat: pulumi.String("yyyy/MM/dd/HH/mm"),
RecordDelimiter: pulumi.String("\n"),
DeliverTimeInterval: pulumi.Float64(300),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var instanceId = config.RequireObject<dynamic>("instanceId");
var taskName = config.RequireObject<dynamic>("taskName");
var topics = config.RequireObject<dynamic>("topics");
var accessKey = config.RequireObject<dynamic>("accessKey");
var secretKey = config.RequireObject<dynamic>("secretKey");
var obsBucketName = config.RequireObject<dynamic>("obsBucketName");
var obsPath = config.RequireObject<dynamic>("obsPath");
var test = new Opentelekomcloud.DmsSmartConnectTaskV2("test", new()
{
InstanceId = instanceId,
TaskName = taskName,
Topics = topics,
DestinationType = "OBS_SINK",
DestinationTask = new Opentelekomcloud.Inputs.DmsSmartConnectTaskV2DestinationTaskArgs
{
ConsumerStrategy = "latest",
DestinationFileType = "TEXT",
AccessKey = accessKey,
SecretKey = secretKey,
ObsBucketName = obsBucketName,
ObsPath = obsPath,
PartitionFormat = "yyyy/MM/dd/HH/mm",
RecordDelimiter = @"
",
DeliverTimeInterval = 300,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.DmsSmartConnectTaskV2;
import com.pulumi.opentelekomcloud.DmsSmartConnectTaskV2Args;
import com.pulumi.opentelekomcloud.inputs.DmsSmartConnectTaskV2DestinationTaskArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var instanceId = config.get("instanceId");
final var taskName = config.get("taskName");
final var topics = config.get("topics");
final var accessKey = config.get("accessKey");
final var secretKey = config.get("secretKey");
final var obsBucketName = config.get("obsBucketName");
final var obsPath = config.get("obsPath");
var test = new DmsSmartConnectTaskV2("test", DmsSmartConnectTaskV2Args.builder()
.instanceId(instanceId)
.taskName(taskName)
.topics(topics)
.destinationType("OBS_SINK")
.destinationTask(DmsSmartConnectTaskV2DestinationTaskArgs.builder()
.consumerStrategy("latest")
.destinationFileType("TEXT")
.accessKey(accessKey)
.secretKey(secretKey)
.obsBucketName(obsBucketName)
.obsPath(obsPath)
.partitionFormat("yyyy/MM/dd/HH/mm")
.recordDelimiter("""
""")
.deliverTimeInterval(300)
.build())
.build());
}
}
configuration:
instanceId:
type: dynamic
taskName:
type: dynamic
topics:
type: dynamic
accessKey:
type: dynamic
secretKey:
type: dynamic
obsBucketName:
type: dynamic
obsPath:
type: dynamic
resources:
test:
type: opentelekomcloud:DmsSmartConnectTaskV2
properties:
instanceId: ${instanceId}
taskName: ${taskName}
topics: ${topics}
destinationType: OBS_SINK
destinationTask:
consumerStrategy: latest
destinationFileType: TEXT
accessKey: ${accessKey}
secretKey: ${secretKey}
obsBucketName: ${obsBucketName}
obsPath: ${obsPath}
partitionFormat: yyyy/MM/dd/HH/mm
recordDelimiter: |2+
deliverTimeInterval: 300
Create a Kafka data replication task
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const taskName = config.requireObject("taskName");
const peerInstanceId = config.requireObject("peerInstanceId");
const test = new opentelekomcloud.DmsSmartConnectTaskV2("test", {
instanceId: instanceId,
taskName: taskName,
topics: ["topic-test"],
sourceType: "KAFKA_REPLICATOR_SOURCE",
sourceTask: {
peerInstanceId: peerInstanceId,
direction: "push",
replicationFactor: 3,
taskNum: 2,
provenanceHeaderEnabled: false,
syncConsumerOffsetsEnabled: false,
renameTopicEnabled: false,
consumerStrategy: "latest",
compressionType: "none",
topicsMappings: ["topic-test:topic-test-mapping"],
},
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
config = pulumi.Config()
instance_id = config.require_object("instanceId")
task_name = config.require_object("taskName")
peer_instance_id = config.require_object("peerInstanceId")
test = opentelekomcloud.DmsSmartConnectTaskV2("test",
instance_id=instance_id,
task_name=task_name,
topics=["topic-test"],
source_type="KAFKA_REPLICATOR_SOURCE",
source_task={
"peer_instance_id": peer_instance_id,
"direction": "push",
"replication_factor": 3,
"task_num": 2,
"provenance_header_enabled": False,
"sync_consumer_offsets_enabled": False,
"rename_topic_enabled": False,
"consumer_strategy": "latest",
"compression_type": "none",
"topics_mappings": ["topic-test:topic-test-mapping"],
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"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, "")
instanceId := cfg.RequireObject("instanceId")
taskName := cfg.RequireObject("taskName")
peerInstanceId := cfg.RequireObject("peerInstanceId")
_, err := opentelekomcloud.NewDmsSmartConnectTaskV2(ctx, "test", &opentelekomcloud.DmsSmartConnectTaskV2Args{
InstanceId: pulumi.Any(instanceId),
TaskName: pulumi.Any(taskName),
Topics: pulumi.StringArray{
pulumi.String("topic-test"),
},
SourceType: pulumi.String("KAFKA_REPLICATOR_SOURCE"),
SourceTask: &opentelekomcloud.DmsSmartConnectTaskV2SourceTaskArgs{
PeerInstanceId: pulumi.Any(peerInstanceId),
Direction: pulumi.String("push"),
ReplicationFactor: pulumi.Float64(3),
TaskNum: pulumi.Float64(2),
ProvenanceHeaderEnabled: pulumi.Bool(false),
SyncConsumerOffsetsEnabled: pulumi.Bool(false),
RenameTopicEnabled: pulumi.Bool(false),
ConsumerStrategy: pulumi.String("latest"),
CompressionType: pulumi.String("none"),
TopicsMappings: pulumi.StringArray{
pulumi.String("topic-test:topic-test-mapping"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var instanceId = config.RequireObject<dynamic>("instanceId");
var taskName = config.RequireObject<dynamic>("taskName");
var peerInstanceId = config.RequireObject<dynamic>("peerInstanceId");
var test = new Opentelekomcloud.DmsSmartConnectTaskV2("test", new()
{
InstanceId = instanceId,
TaskName = taskName,
Topics = new[]
{
"topic-test",
},
SourceType = "KAFKA_REPLICATOR_SOURCE",
SourceTask = new Opentelekomcloud.Inputs.DmsSmartConnectTaskV2SourceTaskArgs
{
PeerInstanceId = peerInstanceId,
Direction = "push",
ReplicationFactor = 3,
TaskNum = 2,
ProvenanceHeaderEnabled = false,
SyncConsumerOffsetsEnabled = false,
RenameTopicEnabled = false,
ConsumerStrategy = "latest",
CompressionType = "none",
TopicsMappings = new[]
{
"topic-test:topic-test-mapping",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.DmsSmartConnectTaskV2;
import com.pulumi.opentelekomcloud.DmsSmartConnectTaskV2Args;
import com.pulumi.opentelekomcloud.inputs.DmsSmartConnectTaskV2SourceTaskArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var instanceId = config.get("instanceId");
final var taskName = config.get("taskName");
final var peerInstanceId = config.get("peerInstanceId");
var test = new DmsSmartConnectTaskV2("test", DmsSmartConnectTaskV2Args.builder()
.instanceId(instanceId)
.taskName(taskName)
.topics("topic-test")
.sourceType("KAFKA_REPLICATOR_SOURCE")
.sourceTask(DmsSmartConnectTaskV2SourceTaskArgs.builder()
.peerInstanceId(peerInstanceId)
.direction("push")
.replicationFactor(3)
.taskNum(2)
.provenanceHeaderEnabled(false)
.syncConsumerOffsetsEnabled(false)
.renameTopicEnabled(false)
.consumerStrategy("latest")
.compressionType("none")
.topicsMappings("topic-test:topic-test-mapping")
.build())
.build());
}
}
configuration:
instanceId:
type: dynamic
taskName:
type: dynamic
peerInstanceId:
type: dynamic
resources:
test:
type: opentelekomcloud:DmsSmartConnectTaskV2
properties:
instanceId: ${instanceId}
taskName: ${taskName}
topics:
- topic-test
sourceType: KAFKA_REPLICATOR_SOURCE
sourceTask:
peerInstanceId: ${peerInstanceId}
direction: push
replicationFactor: 3
taskNum: 2
provenanceHeaderEnabled: false
syncConsumerOffsetsEnabled: false
renameTopicEnabled: false
consumerStrategy: latest
compressionType: none
topicsMappings:
- topic-test:topic-test-mapping
Create DmsSmartConnectTaskV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DmsSmartConnectTaskV2(name: string, args: DmsSmartConnectTaskV2Args, opts?: CustomResourceOptions);
@overload
def DmsSmartConnectTaskV2(resource_name: str,
args: DmsSmartConnectTaskV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def DmsSmartConnectTaskV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None,
task_name: Optional[str] = None,
destination_task: Optional[DmsSmartConnectTaskV2DestinationTaskArgs] = None,
destination_type: Optional[str] = None,
dms_smart_connect_task_v2_id: Optional[str] = None,
source_task: Optional[DmsSmartConnectTaskV2SourceTaskArgs] = None,
source_type: Optional[str] = None,
start_later: Optional[bool] = None,
timeouts: Optional[DmsSmartConnectTaskV2TimeoutsArgs] = None,
topics: Optional[Sequence[str]] = None,
topics_regex: Optional[str] = None)
func NewDmsSmartConnectTaskV2(ctx *Context, name string, args DmsSmartConnectTaskV2Args, opts ...ResourceOption) (*DmsSmartConnectTaskV2, error)
public DmsSmartConnectTaskV2(string name, DmsSmartConnectTaskV2Args args, CustomResourceOptions? opts = null)
public DmsSmartConnectTaskV2(String name, DmsSmartConnectTaskV2Args args)
public DmsSmartConnectTaskV2(String name, DmsSmartConnectTaskV2Args args, CustomResourceOptions options)
type: opentelekomcloud:DmsSmartConnectTaskV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DmsSmartConnectTaskV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DmsSmartConnectTaskV2Args
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DmsSmartConnectTaskV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DmsSmartConnectTaskV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DmsSmartConnectTaskV2Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dmsSmartConnectTaskV2Resource = new Opentelekomcloud.DmsSmartConnectTaskV2("dmsSmartConnectTaskV2Resource", new()
{
InstanceId = "string",
TaskName = "string",
DestinationTask = new Opentelekomcloud.Inputs.DmsSmartConnectTaskV2DestinationTaskArgs
{
AccessKey = "string",
ConsumerStrategy = "string",
DeliverTimeInterval = 0,
DestinationFileType = "string",
ObsBucketName = "string",
ObsPath = "string",
PartitionFormat = "string",
RecordDelimiter = "string",
SecretKey = "string",
StoreKeys = false,
},
DestinationType = "string",
DmsSmartConnectTaskV2Id = "string",
SourceTask = new Opentelekomcloud.Inputs.DmsSmartConnectTaskV2SourceTaskArgs
{
CompressionType = "string",
ConsumerStrategy = "string",
CurrentInstanceAlias = "string",
Direction = "string",
Password = "string",
PeerInstanceAddresses = new[]
{
"string",
},
PeerInstanceAlias = "string",
PeerInstanceId = "string",
ProvenanceHeaderEnabled = false,
RenameTopicEnabled = false,
ReplicationFactor = 0,
SaslMechanism = "string",
SecurityProtocol = "string",
SyncConsumerOffsetsEnabled = false,
TaskNum = 0,
TopicsMappings = new[]
{
"string",
},
UserName = "string",
},
SourceType = "string",
StartLater = false,
Timeouts = new Opentelekomcloud.Inputs.DmsSmartConnectTaskV2TimeoutsArgs
{
Create = "string",
},
Topics = new[]
{
"string",
},
TopicsRegex = "string",
});
example, err := opentelekomcloud.NewDmsSmartConnectTaskV2(ctx, "dmsSmartConnectTaskV2Resource", &opentelekomcloud.DmsSmartConnectTaskV2Args{
InstanceId: pulumi.String("string"),
TaskName: pulumi.String("string"),
DestinationTask: &opentelekomcloud.DmsSmartConnectTaskV2DestinationTaskArgs{
AccessKey: pulumi.String("string"),
ConsumerStrategy: pulumi.String("string"),
DeliverTimeInterval: pulumi.Float64(0),
DestinationFileType: pulumi.String("string"),
ObsBucketName: pulumi.String("string"),
ObsPath: pulumi.String("string"),
PartitionFormat: pulumi.String("string"),
RecordDelimiter: pulumi.String("string"),
SecretKey: pulumi.String("string"),
StoreKeys: pulumi.Bool(false),
},
DestinationType: pulumi.String("string"),
DmsSmartConnectTaskV2Id: pulumi.String("string"),
SourceTask: &opentelekomcloud.DmsSmartConnectTaskV2SourceTaskArgs{
CompressionType: pulumi.String("string"),
ConsumerStrategy: pulumi.String("string"),
CurrentInstanceAlias: pulumi.String("string"),
Direction: pulumi.String("string"),
Password: pulumi.String("string"),
PeerInstanceAddresses: pulumi.StringArray{
pulumi.String("string"),
},
PeerInstanceAlias: pulumi.String("string"),
PeerInstanceId: pulumi.String("string"),
ProvenanceHeaderEnabled: pulumi.Bool(false),
RenameTopicEnabled: pulumi.Bool(false),
ReplicationFactor: pulumi.Float64(0),
SaslMechanism: pulumi.String("string"),
SecurityProtocol: pulumi.String("string"),
SyncConsumerOffsetsEnabled: pulumi.Bool(false),
TaskNum: pulumi.Float64(0),
TopicsMappings: pulumi.StringArray{
pulumi.String("string"),
},
UserName: pulumi.String("string"),
},
SourceType: pulumi.String("string"),
StartLater: pulumi.Bool(false),
Timeouts: &opentelekomcloud.DmsSmartConnectTaskV2TimeoutsArgs{
Create: pulumi.String("string"),
},
Topics: pulumi.StringArray{
pulumi.String("string"),
},
TopicsRegex: pulumi.String("string"),
})
var dmsSmartConnectTaskV2Resource = new DmsSmartConnectTaskV2("dmsSmartConnectTaskV2Resource", DmsSmartConnectTaskV2Args.builder()
.instanceId("string")
.taskName("string")
.destinationTask(DmsSmartConnectTaskV2DestinationTaskArgs.builder()
.accessKey("string")
.consumerStrategy("string")
.deliverTimeInterval(0)
.destinationFileType("string")
.obsBucketName("string")
.obsPath("string")
.partitionFormat("string")
.recordDelimiter("string")
.secretKey("string")
.storeKeys(false)
.build())
.destinationType("string")
.dmsSmartConnectTaskV2Id("string")
.sourceTask(DmsSmartConnectTaskV2SourceTaskArgs.builder()
.compressionType("string")
.consumerStrategy("string")
.currentInstanceAlias("string")
.direction("string")
.password("string")
.peerInstanceAddresses("string")
.peerInstanceAlias("string")
.peerInstanceId("string")
.provenanceHeaderEnabled(false)
.renameTopicEnabled(false)
.replicationFactor(0)
.saslMechanism("string")
.securityProtocol("string")
.syncConsumerOffsetsEnabled(false)
.taskNum(0)
.topicsMappings("string")
.userName("string")
.build())
.sourceType("string")
.startLater(false)
.timeouts(DmsSmartConnectTaskV2TimeoutsArgs.builder()
.create("string")
.build())
.topics("string")
.topicsRegex("string")
.build());
dms_smart_connect_task_v2_resource = opentelekomcloud.DmsSmartConnectTaskV2("dmsSmartConnectTaskV2Resource",
instance_id="string",
task_name="string",
destination_task={
"access_key": "string",
"consumer_strategy": "string",
"deliver_time_interval": 0,
"destination_file_type": "string",
"obs_bucket_name": "string",
"obs_path": "string",
"partition_format": "string",
"record_delimiter": "string",
"secret_key": "string",
"store_keys": False,
},
destination_type="string",
dms_smart_connect_task_v2_id="string",
source_task={
"compression_type": "string",
"consumer_strategy": "string",
"current_instance_alias": "string",
"direction": "string",
"password": "string",
"peer_instance_addresses": ["string"],
"peer_instance_alias": "string",
"peer_instance_id": "string",
"provenance_header_enabled": False,
"rename_topic_enabled": False,
"replication_factor": 0,
"sasl_mechanism": "string",
"security_protocol": "string",
"sync_consumer_offsets_enabled": False,
"task_num": 0,
"topics_mappings": ["string"],
"user_name": "string",
},
source_type="string",
start_later=False,
timeouts={
"create": "string",
},
topics=["string"],
topics_regex="string")
const dmsSmartConnectTaskV2Resource = new opentelekomcloud.DmsSmartConnectTaskV2("dmsSmartConnectTaskV2Resource", {
instanceId: "string",
taskName: "string",
destinationTask: {
accessKey: "string",
consumerStrategy: "string",
deliverTimeInterval: 0,
destinationFileType: "string",
obsBucketName: "string",
obsPath: "string",
partitionFormat: "string",
recordDelimiter: "string",
secretKey: "string",
storeKeys: false,
},
destinationType: "string",
dmsSmartConnectTaskV2Id: "string",
sourceTask: {
compressionType: "string",
consumerStrategy: "string",
currentInstanceAlias: "string",
direction: "string",
password: "string",
peerInstanceAddresses: ["string"],
peerInstanceAlias: "string",
peerInstanceId: "string",
provenanceHeaderEnabled: false,
renameTopicEnabled: false,
replicationFactor: 0,
saslMechanism: "string",
securityProtocol: "string",
syncConsumerOffsetsEnabled: false,
taskNum: 0,
topicsMappings: ["string"],
userName: "string",
},
sourceType: "string",
startLater: false,
timeouts: {
create: "string",
},
topics: ["string"],
topicsRegex: "string",
});
type: opentelekomcloud:DmsSmartConnectTaskV2
properties:
destinationTask:
accessKey: string
consumerStrategy: string
deliverTimeInterval: 0
destinationFileType: string
obsBucketName: string
obsPath: string
partitionFormat: string
recordDelimiter: string
secretKey: string
storeKeys: false
destinationType: string
dmsSmartConnectTaskV2Id: string
instanceId: string
sourceTask:
compressionType: string
consumerStrategy: string
currentInstanceAlias: string
direction: string
password: string
peerInstanceAddresses:
- string
peerInstanceAlias: string
peerInstanceId: string
provenanceHeaderEnabled: false
renameTopicEnabled: false
replicationFactor: 0
saslMechanism: string
securityProtocol: string
syncConsumerOffsetsEnabled: false
taskNum: 0
topicsMappings:
- string
userName: string
sourceType: string
startLater: false
taskName: string
timeouts:
create: string
topics:
- string
topicsRegex: string
DmsSmartConnectTaskV2 Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DmsSmartConnectTaskV2 resource accepts the following input properties:
- Instance
Id string - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- Task
Name string - Specifies the smart connect task name. Changing this parameter will create a new resource.
- Destination
Task DmsSmart Connect Task V2Destination Task Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- Destination
Type string - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- Dms
Smart stringConnect Task V2Id - The resource ID.
- Source
Task DmsSmart Connect Task V2Source Task - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- Source
Type string - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- Start
Later bool - Specifies whether to start a task later. Changing this parameter will create a new resource.
- Timeouts
Dms
Smart Connect Task V2Timeouts - Topics List<string>
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- Topics
Regex string Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- Instance
Id string - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- Task
Name string - Specifies the smart connect task name. Changing this parameter will create a new resource.
- Destination
Task DmsSmart Connect Task V2Destination Task Args Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- Destination
Type string - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- Dms
Smart stringConnect Task V2Id - The resource ID.
- Source
Task DmsSmart Connect Task V2Source Task Args - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- Source
Type string - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- Start
Later bool - Specifies whether to start a task later. Changing this parameter will create a new resource.
- Timeouts
Dms
Smart Connect Task V2Timeouts Args - Topics []string
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- Topics
Regex string Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- instance
Id String - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- task
Name String - Specifies the smart connect task name. Changing this parameter will create a new resource.
- destination
Task DmsSmart Connect Task V2Destination Task Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination
Type String - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms
Smart StringConnect Task V2Id - The resource ID.
- source
Task DmsSmart Connect Task V2Source Task - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source
Type String - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start
Later Boolean - Specifies whether to start a task later. Changing this parameter will create a new resource.
- timeouts
Dms
Smart Connect Task V2Timeouts - topics List<String>
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics
Regex String Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- instance
Id string - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- task
Name string - Specifies the smart connect task name. Changing this parameter will create a new resource.
- destination
Task DmsSmart Connect Task V2Destination Task Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination
Type string - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms
Smart stringConnect Task V2Id - The resource ID.
- source
Task DmsSmart Connect Task V2Source Task - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source
Type string - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start
Later boolean - Specifies whether to start a task later. Changing this parameter will create a new resource.
- timeouts
Dms
Smart Connect Task V2Timeouts - topics string[]
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics
Regex string Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- instance_
id str - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- task_
name str - Specifies the smart connect task name. Changing this parameter will create a new resource.
- destination_
task DmsSmart Connect Task V2Destination Task Args Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination_
type str - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms_
smart_ strconnect_ task_ v2_ id - The resource ID.
- source_
task DmsSmart Connect Task V2Source Task Args - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source_
type str - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start_
later bool - Specifies whether to start a task later. Changing this parameter will create a new resource.
- timeouts
Dms
Smart Connect Task V2Timeouts Args - topics Sequence[str]
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics_
regex str Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- instance
Id String - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- task
Name String - Specifies the smart connect task name. Changing this parameter will create a new resource.
- destination
Task Property Map Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination
Type String - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms
Smart StringConnect Task V2Id - The resource ID.
- source
Task Property Map - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source
Type String - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start
Later Boolean - Specifies whether to start a task later. Changing this parameter will create a new resource.
- timeouts Property Map
- topics List<String>
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics
Regex String Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
Outputs
All input properties are implicitly available as output properties. Additionally, the DmsSmartConnectTaskV2 resource produces the following output properties:
- created_
at str - Indicates the creation time of the smart connect task.
- id str
- The provider-assigned unique ID for this managed resource.
- region str
- The region in which the resource is created.
- status str
- Indicates the status of the smart connect task.
Look up Existing DmsSmartConnectTaskV2 Resource
Get an existing DmsSmartConnectTaskV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DmsSmartConnectTaskV2State, opts?: CustomResourceOptions): DmsSmartConnectTaskV2
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
destination_task: Optional[DmsSmartConnectTaskV2DestinationTaskArgs] = None,
destination_type: Optional[str] = None,
dms_smart_connect_task_v2_id: Optional[str] = None,
instance_id: Optional[str] = None,
region: Optional[str] = None,
source_task: Optional[DmsSmartConnectTaskV2SourceTaskArgs] = None,
source_type: Optional[str] = None,
start_later: Optional[bool] = None,
status: Optional[str] = None,
task_name: Optional[str] = None,
timeouts: Optional[DmsSmartConnectTaskV2TimeoutsArgs] = None,
topics: Optional[Sequence[str]] = None,
topics_regex: Optional[str] = None) -> DmsSmartConnectTaskV2
func GetDmsSmartConnectTaskV2(ctx *Context, name string, id IDInput, state *DmsSmartConnectTaskV2State, opts ...ResourceOption) (*DmsSmartConnectTaskV2, error)
public static DmsSmartConnectTaskV2 Get(string name, Input<string> id, DmsSmartConnectTaskV2State? state, CustomResourceOptions? opts = null)
public static DmsSmartConnectTaskV2 get(String name, Output<String> id, DmsSmartConnectTaskV2State state, CustomResourceOptions options)
resources: _: type: opentelekomcloud:DmsSmartConnectTaskV2 get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Created
At string - Indicates the creation time of the smart connect task.
- Destination
Task DmsSmart Connect Task V2Destination Task Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- Destination
Type string - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- Dms
Smart stringConnect Task V2Id - The resource ID.
- Instance
Id string - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- Region string
- The region in which the resource is created.
- Source
Task DmsSmart Connect Task V2Source Task - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- Source
Type string - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- Start
Later bool - Specifies whether to start a task later. Changing this parameter will create a new resource.
- Status string
- Indicates the status of the smart connect task.
- Task
Name string - Specifies the smart connect task name. Changing this parameter will create a new resource.
- Timeouts
Dms
Smart Connect Task V2Timeouts - Topics List<string>
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- Topics
Regex string Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- Created
At string - Indicates the creation time of the smart connect task.
- Destination
Task DmsSmart Connect Task V2Destination Task Args Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- Destination
Type string - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- Dms
Smart stringConnect Task V2Id - The resource ID.
- Instance
Id string - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- Region string
- The region in which the resource is created.
- Source
Task DmsSmart Connect Task V2Source Task Args - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- Source
Type string - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- Start
Later bool - Specifies whether to start a task later. Changing this parameter will create a new resource.
- Status string
- Indicates the status of the smart connect task.
- Task
Name string - Specifies the smart connect task name. Changing this parameter will create a new resource.
- Timeouts
Dms
Smart Connect Task V2Timeouts Args - Topics []string
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- Topics
Regex string Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- created
At String - Indicates the creation time of the smart connect task.
- destination
Task DmsSmart Connect Task V2Destination Task Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination
Type String - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms
Smart StringConnect Task V2Id - The resource ID.
- instance
Id String - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- region String
- The region in which the resource is created.
- source
Task DmsSmart Connect Task V2Source Task - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source
Type String - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start
Later Boolean - Specifies whether to start a task later. Changing this parameter will create a new resource.
- status String
- Indicates the status of the smart connect task.
- task
Name String - Specifies the smart connect task name. Changing this parameter will create a new resource.
- timeouts
Dms
Smart Connect Task V2Timeouts - topics List<String>
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics
Regex String Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- created
At string - Indicates the creation time of the smart connect task.
- destination
Task DmsSmart Connect Task V2Destination Task Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination
Type string - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms
Smart stringConnect Task V2Id - The resource ID.
- instance
Id string - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- region string
- The region in which the resource is created.
- source
Task DmsSmart Connect Task V2Source Task - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source
Type string - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start
Later boolean - Specifies whether to start a task later. Changing this parameter will create a new resource.
- status string
- Indicates the status of the smart connect task.
- task
Name string - Specifies the smart connect task name. Changing this parameter will create a new resource.
- timeouts
Dms
Smart Connect Task V2Timeouts - topics string[]
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics
Regex string Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- created_
at str - Indicates the creation time of the smart connect task.
- destination_
task DmsSmart Connect Task V2Destination Task Args Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination_
type str - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms_
smart_ strconnect_ task_ v2_ id - The resource ID.
- instance_
id str - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- region str
- The region in which the resource is created.
- source_
task DmsSmart Connect Task V2Source Task Args - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source_
type str - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start_
later bool - Specifies whether to start a task later. Changing this parameter will create a new resource.
- status str
- Indicates the status of the smart connect task.
- task_
name str - Specifies the smart connect task name. Changing this parameter will create a new resource.
- timeouts
Dms
Smart Connect Task V2Timeouts Args - topics Sequence[str]
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics_
regex str Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
- created
At String - Indicates the creation time of the smart connect task.
- destination
Task Property Map Specifies the destination configuration of a smart connect task. The destination_task structure is documented below. Changing this parameter will create a new resource.
The
source_task
block supports:- destination
Type String - Specifies the destination type of the smart connect task. Valid values are OBS_SINK and NONE. Changing this parameter will create a new resource.
- dms
Smart StringConnect Task V2Id - The resource ID.
- instance
Id String - Specifies the kafka instance ID. Changing this parameter will create a new resource.
- region String
- The region in which the resource is created.
- source
Task Property Map - Specifies the source configuration of a smart connect task. The source_task structure is documented below. Changing this parameter will create a new resource.
- source
Type String - Specifies the source type of the smart connect task. Valid values are KAFKA_REPLICATOR_SOURCE and NONE. Changing this parameter will create a new resource.
- start
Later Boolean - Specifies whether to start a task later. Changing this parameter will create a new resource.
- status String
- Indicates the status of the smart connect task.
- task
Name String - Specifies the smart connect task name. Changing this parameter will create a new resource.
- timeouts Property Map
- topics List<String>
- Specifies the topic names list of the smart connect task. Changing this parameter will create a new resource.
- topics
Regex String Specifies the regular expression of topic name for the smart connect task. Changing this parameter will create a new resource.
Exactly one of
topics
,topics_regex
should be specified.
Supporting Types
DmsSmartConnectTaskV2DestinationTask, DmsSmartConnectTaskV2DestinationTaskArgs
- Access
Key string - Specifies the access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Consumer
Strategy string Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- Deliver
Time doubleInterval - Specifies the deliver time interval of the smart connect task.
It's required when
destination_type
is OBS_SINK. The value should be between30
and900
. Changing this parameter will create a new resource. - Destination
File stringType - Specifies the destination file type of the smart connect task. Only TEXT is supported. Changing this parameter will create a new resource.
- Obs
Bucket stringName - Specifies the obs bucket name of the smart connect task.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Obs
Path string - Specifies the obs path of the smart connect task. Obs path is separated by a slash. Changing this parameter will create a new resource.
- Partition
Format string - Specifies the time directory format of the smart connect task.
Value options: yyyy, yyyy/MM, yyyy/MM/dd, yyyy/MM/dd/HH, yyyy/MM/dd/HH/mm.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Record
Delimiter string - Specifies the record delimiter of the smart connect task. Value options: ,, ;, |, \n. Changing this parameter will create a new resource.
- Secret
Key string - Specifies the secret access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Store
Keys bool - Specifies whether to dump keys. Changing this parameter will create a new resource.
- Access
Key string - Specifies the access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Consumer
Strategy string Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- Deliver
Time float64Interval - Specifies the deliver time interval of the smart connect task.
It's required when
destination_type
is OBS_SINK. The value should be between30
and900
. Changing this parameter will create a new resource. - Destination
File stringType - Specifies the destination file type of the smart connect task. Only TEXT is supported. Changing this parameter will create a new resource.
- Obs
Bucket stringName - Specifies the obs bucket name of the smart connect task.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Obs
Path string - Specifies the obs path of the smart connect task. Obs path is separated by a slash. Changing this parameter will create a new resource.
- Partition
Format string - Specifies the time directory format of the smart connect task.
Value options: yyyy, yyyy/MM, yyyy/MM/dd, yyyy/MM/dd/HH, yyyy/MM/dd/HH/mm.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Record
Delimiter string - Specifies the record delimiter of the smart connect task. Value options: ,, ;, |, \n. Changing this parameter will create a new resource.
- Secret
Key string - Specifies the secret access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - Store
Keys bool - Specifies whether to dump keys. Changing this parameter will create a new resource.
- access
Key String - Specifies the access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - consumer
Strategy String Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- deliver
Time DoubleInterval - Specifies the deliver time interval of the smart connect task.
It's required when
destination_type
is OBS_SINK. The value should be between30
and900
. Changing this parameter will create a new resource. - destination
File StringType - Specifies the destination file type of the smart connect task. Only TEXT is supported. Changing this parameter will create a new resource.
- obs
Bucket StringName - Specifies the obs bucket name of the smart connect task.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - obs
Path String - Specifies the obs path of the smart connect task. Obs path is separated by a slash. Changing this parameter will create a new resource.
- partition
Format String - Specifies the time directory format of the smart connect task.
Value options: yyyy, yyyy/MM, yyyy/MM/dd, yyyy/MM/dd/HH, yyyy/MM/dd/HH/mm.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - record
Delimiter String - Specifies the record delimiter of the smart connect task. Value options: ,, ;, |, \n. Changing this parameter will create a new resource.
- secret
Key String - Specifies the secret access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - store
Keys Boolean - Specifies whether to dump keys. Changing this parameter will create a new resource.
- access
Key string - Specifies the access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - consumer
Strategy string Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- deliver
Time numberInterval - Specifies the deliver time interval of the smart connect task.
It's required when
destination_type
is OBS_SINK. The value should be between30
and900
. Changing this parameter will create a new resource. - destination
File stringType - Specifies the destination file type of the smart connect task. Only TEXT is supported. Changing this parameter will create a new resource.
- obs
Bucket stringName - Specifies the obs bucket name of the smart connect task.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - obs
Path string - Specifies the obs path of the smart connect task. Obs path is separated by a slash. Changing this parameter will create a new resource.
- partition
Format string - Specifies the time directory format of the smart connect task.
Value options: yyyy, yyyy/MM, yyyy/MM/dd, yyyy/MM/dd/HH, yyyy/MM/dd/HH/mm.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - record
Delimiter string - Specifies the record delimiter of the smart connect task. Value options: ,, ;, |, \n. Changing this parameter will create a new resource.
- secret
Key string - Specifies the secret access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - store
Keys boolean - Specifies whether to dump keys. Changing this parameter will create a new resource.
- access_
key str - Specifies the access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - consumer_
strategy str Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- deliver_
time_ floatinterval - Specifies the deliver time interval of the smart connect task.
It's required when
destination_type
is OBS_SINK. The value should be between30
and900
. Changing this parameter will create a new resource. - destination_
file_ strtype - Specifies the destination file type of the smart connect task. Only TEXT is supported. Changing this parameter will create a new resource.
- obs_
bucket_ strname - Specifies the obs bucket name of the smart connect task.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - obs_
path str - Specifies the obs path of the smart connect task. Obs path is separated by a slash. Changing this parameter will create a new resource.
- partition_
format str - Specifies the time directory format of the smart connect task.
Value options: yyyy, yyyy/MM, yyyy/MM/dd, yyyy/MM/dd/HH, yyyy/MM/dd/HH/mm.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - record_
delimiter str - Specifies the record delimiter of the smart connect task. Value options: ,, ;, |, \n. Changing this parameter will create a new resource.
- secret_
key str - Specifies the secret access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - store_
keys bool - Specifies whether to dump keys. Changing this parameter will create a new resource.
- access
Key String - Specifies the access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - consumer
Strategy String Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- deliver
Time NumberInterval - Specifies the deliver time interval of the smart connect task.
It's required when
destination_type
is OBS_SINK. The value should be between30
and900
. Changing this parameter will create a new resource. - destination
File StringType - Specifies the destination file type of the smart connect task. Only TEXT is supported. Changing this parameter will create a new resource.
- obs
Bucket StringName - Specifies the obs bucket name of the smart connect task.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - obs
Path String - Specifies the obs path of the smart connect task. Obs path is separated by a slash. Changing this parameter will create a new resource.
- partition
Format String - Specifies the time directory format of the smart connect task.
Value options: yyyy, yyyy/MM, yyyy/MM/dd, yyyy/MM/dd/HH, yyyy/MM/dd/HH/mm.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - record
Delimiter String - Specifies the record delimiter of the smart connect task. Value options: ,, ;, |, \n. Changing this parameter will create a new resource.
- secret
Key String - Specifies the secret access key used to access the OBS bucket.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource. - store
Keys Boolean - Specifies whether to dump keys. Changing this parameter will create a new resource.
DmsSmartConnectTaskV2SourceTask, DmsSmartConnectTaskV2SourceTaskArgs
- Compression
Type string Specifies the compression algorithm to use for copying messages. Valid values are none, gzip, snappy, lz4 and zstd. Changing this parameter will create a new resource.
The
destination_task
block supports:- Consumer
Strategy string Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- Current
Instance stringAlias - Specifies the current Kafka instance alias. Changing this parameter will create a new resource.
- Direction string
Specifies the sync direction. Valid values are:
- pull: Copy the data of the peer Kafka instance to the current Kafka instance.
- push: Copy the data of the current Kafka instance to the peer Kafka instance.
- two-way: Copy the data of the Kafka instances at both ends in both directions.
Changing this parameter will create a new resource.
- Password string
- Specifies the peer Kafka user password.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource. - Peer
Instance List<string>Addresses Specifies the peer Kafka instance address list. Changing this parameter will create a new resource.
Exactly one of
peer_instance_id
andpeer_instance_address
should be specified.- Peer
Instance stringAlias - Specifies the peer Kafka instance alias. Changing this parameter will create a new resource.
- Peer
Instance stringId - Specifies the peer Kafka instance ID. Changing this parameter will create a new resource.
- Provenance
Header boolEnabled - Specifies whether the message header contains the message source. Changing this parameter will create a new resource.
- Rename
Topic boolEnabled - Specifies whether to rename the topic. If true, will add the alias of the source Kafka instance before the target topic name to form a new name of the target topic. Changing this parameter will create a new resource.
- Replication
Factor double - Specifies the number of topic replicas. The value of this parameter cannot exceed the number of brokers in the peer instance. Changing this parameter will create a new resource.
- Sasl
Mechanism string - Specifies the peer Kafka authentication mode. Changing this parameter will create a new resource.
- Security
Protocol string Specifies the peer Kafka authentication. Valid values are:
- SASL_SSL: SASL_SSL is enabled.
- PLAINTEXT: SASL_SSL is disabled.
Changing this parameter will create a new resource.
- Sync
Consumer boolOffsets Enabled - Specifies whether to sync the consumption progress. Changing this parameter will create a new resource.
- Task
Num double - Specifies the number of data replication tasks.
If the
direction
is set to two-way, the actual number of tasks will be twice the number of tasks you configure here. Changing this parameter will create a new resource. - Topics
Mappings List<string> Specifies the topic mapping string list, which is used to customize the target topic name, e.g., topic-sc-1:topic-sc-2. Changing this parameter will create a new resource.
When
rename_topic_enabled
is true,topics_mapping
can not be specified.- User
Name string - Specifies the peer Kafka user name.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource.
- Compression
Type string Specifies the compression algorithm to use for copying messages. Valid values are none, gzip, snappy, lz4 and zstd. Changing this parameter will create a new resource.
The
destination_task
block supports:- Consumer
Strategy string Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- Current
Instance stringAlias - Specifies the current Kafka instance alias. Changing this parameter will create a new resource.
- Direction string
Specifies the sync direction. Valid values are:
- pull: Copy the data of the peer Kafka instance to the current Kafka instance.
- push: Copy the data of the current Kafka instance to the peer Kafka instance.
- two-way: Copy the data of the Kafka instances at both ends in both directions.
Changing this parameter will create a new resource.
- Password string
- Specifies the peer Kafka user password.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource. - Peer
Instance []stringAddresses Specifies the peer Kafka instance address list. Changing this parameter will create a new resource.
Exactly one of
peer_instance_id
andpeer_instance_address
should be specified.- Peer
Instance stringAlias - Specifies the peer Kafka instance alias. Changing this parameter will create a new resource.
- Peer
Instance stringId - Specifies the peer Kafka instance ID. Changing this parameter will create a new resource.
- Provenance
Header boolEnabled - Specifies whether the message header contains the message source. Changing this parameter will create a new resource.
- Rename
Topic boolEnabled - Specifies whether to rename the topic. If true, will add the alias of the source Kafka instance before the target topic name to form a new name of the target topic. Changing this parameter will create a new resource.
- Replication
Factor float64 - Specifies the number of topic replicas. The value of this parameter cannot exceed the number of brokers in the peer instance. Changing this parameter will create a new resource.
- Sasl
Mechanism string - Specifies the peer Kafka authentication mode. Changing this parameter will create a new resource.
- Security
Protocol string Specifies the peer Kafka authentication. Valid values are:
- SASL_SSL: SASL_SSL is enabled.
- PLAINTEXT: SASL_SSL is disabled.
Changing this parameter will create a new resource.
- Sync
Consumer boolOffsets Enabled - Specifies whether to sync the consumption progress. Changing this parameter will create a new resource.
- Task
Num float64 - Specifies the number of data replication tasks.
If the
direction
is set to two-way, the actual number of tasks will be twice the number of tasks you configure here. Changing this parameter will create a new resource. - Topics
Mappings []string Specifies the topic mapping string list, which is used to customize the target topic name, e.g., topic-sc-1:topic-sc-2. Changing this parameter will create a new resource.
When
rename_topic_enabled
is true,topics_mapping
can not be specified.- User
Name string - Specifies the peer Kafka user name.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource.
- compression
Type String Specifies the compression algorithm to use for copying messages. Valid values are none, gzip, snappy, lz4 and zstd. Changing this parameter will create a new resource.
The
destination_task
block supports:- consumer
Strategy String Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- current
Instance StringAlias - Specifies the current Kafka instance alias. Changing this parameter will create a new resource.
- direction String
Specifies the sync direction. Valid values are:
- pull: Copy the data of the peer Kafka instance to the current Kafka instance.
- push: Copy the data of the current Kafka instance to the peer Kafka instance.
- two-way: Copy the data of the Kafka instances at both ends in both directions.
Changing this parameter will create a new resource.
- password String
- Specifies the peer Kafka user password.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource. - peer
Instance List<String>Addresses Specifies the peer Kafka instance address list. Changing this parameter will create a new resource.
Exactly one of
peer_instance_id
andpeer_instance_address
should be specified.- peer
Instance StringAlias - Specifies the peer Kafka instance alias. Changing this parameter will create a new resource.
- peer
Instance StringId - Specifies the peer Kafka instance ID. Changing this parameter will create a new resource.
- provenance
Header BooleanEnabled - Specifies whether the message header contains the message source. Changing this parameter will create a new resource.
- rename
Topic BooleanEnabled - Specifies whether to rename the topic. If true, will add the alias of the source Kafka instance before the target topic name to form a new name of the target topic. Changing this parameter will create a new resource.
- replication
Factor Double - Specifies the number of topic replicas. The value of this parameter cannot exceed the number of brokers in the peer instance. Changing this parameter will create a new resource.
- sasl
Mechanism String - Specifies the peer Kafka authentication mode. Changing this parameter will create a new resource.
- security
Protocol String Specifies the peer Kafka authentication. Valid values are:
- SASL_SSL: SASL_SSL is enabled.
- PLAINTEXT: SASL_SSL is disabled.
Changing this parameter will create a new resource.
- sync
Consumer BooleanOffsets Enabled - Specifies whether to sync the consumption progress. Changing this parameter will create a new resource.
- task
Num Double - Specifies the number of data replication tasks.
If the
direction
is set to two-way, the actual number of tasks will be twice the number of tasks you configure here. Changing this parameter will create a new resource. - topics
Mappings List<String> Specifies the topic mapping string list, which is used to customize the target topic name, e.g., topic-sc-1:topic-sc-2. Changing this parameter will create a new resource.
When
rename_topic_enabled
is true,topics_mapping
can not be specified.- user
Name String - Specifies the peer Kafka user name.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource.
- compression
Type string Specifies the compression algorithm to use for copying messages. Valid values are none, gzip, snappy, lz4 and zstd. Changing this parameter will create a new resource.
The
destination_task
block supports:- consumer
Strategy string Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- current
Instance stringAlias - Specifies the current Kafka instance alias. Changing this parameter will create a new resource.
- direction string
Specifies the sync direction. Valid values are:
- pull: Copy the data of the peer Kafka instance to the current Kafka instance.
- push: Copy the data of the current Kafka instance to the peer Kafka instance.
- two-way: Copy the data of the Kafka instances at both ends in both directions.
Changing this parameter will create a new resource.
- password string
- Specifies the peer Kafka user password.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource. - peer
Instance string[]Addresses Specifies the peer Kafka instance address list. Changing this parameter will create a new resource.
Exactly one of
peer_instance_id
andpeer_instance_address
should be specified.- peer
Instance stringAlias - Specifies the peer Kafka instance alias. Changing this parameter will create a new resource.
- peer
Instance stringId - Specifies the peer Kafka instance ID. Changing this parameter will create a new resource.
- provenance
Header booleanEnabled - Specifies whether the message header contains the message source. Changing this parameter will create a new resource.
- rename
Topic booleanEnabled - Specifies whether to rename the topic. If true, will add the alias of the source Kafka instance before the target topic name to form a new name of the target topic. Changing this parameter will create a new resource.
- replication
Factor number - Specifies the number of topic replicas. The value of this parameter cannot exceed the number of brokers in the peer instance. Changing this parameter will create a new resource.
- sasl
Mechanism string - Specifies the peer Kafka authentication mode. Changing this parameter will create a new resource.
- security
Protocol string Specifies the peer Kafka authentication. Valid values are:
- SASL_SSL: SASL_SSL is enabled.
- PLAINTEXT: SASL_SSL is disabled.
Changing this parameter will create a new resource.
- sync
Consumer booleanOffsets Enabled - Specifies whether to sync the consumption progress. Changing this parameter will create a new resource.
- task
Num number - Specifies the number of data replication tasks.
If the
direction
is set to two-way, the actual number of tasks will be twice the number of tasks you configure here. Changing this parameter will create a new resource. - topics
Mappings string[] Specifies the topic mapping string list, which is used to customize the target topic name, e.g., topic-sc-1:topic-sc-2. Changing this parameter will create a new resource.
When
rename_topic_enabled
is true,topics_mapping
can not be specified.- user
Name string - Specifies the peer Kafka user name.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource.
- compression_
type str Specifies the compression algorithm to use for copying messages. Valid values are none, gzip, snappy, lz4 and zstd. Changing this parameter will create a new resource.
The
destination_task
block supports:- consumer_
strategy str Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- current_
instance_ stralias - Specifies the current Kafka instance alias. Changing this parameter will create a new resource.
- direction str
Specifies the sync direction. Valid values are:
- pull: Copy the data of the peer Kafka instance to the current Kafka instance.
- push: Copy the data of the current Kafka instance to the peer Kafka instance.
- two-way: Copy the data of the Kafka instances at both ends in both directions.
Changing this parameter will create a new resource.
- password str
- Specifies the peer Kafka user password.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource. - peer_
instance_ Sequence[str]addresses Specifies the peer Kafka instance address list. Changing this parameter will create a new resource.
Exactly one of
peer_instance_id
andpeer_instance_address
should be specified.- peer_
instance_ stralias - Specifies the peer Kafka instance alias. Changing this parameter will create a new resource.
- peer_
instance_ strid - Specifies the peer Kafka instance ID. Changing this parameter will create a new resource.
- provenance_
header_ boolenabled - Specifies whether the message header contains the message source. Changing this parameter will create a new resource.
- rename_
topic_ boolenabled - Specifies whether to rename the topic. If true, will add the alias of the source Kafka instance before the target topic name to form a new name of the target topic. Changing this parameter will create a new resource.
- replication_
factor float - Specifies the number of topic replicas. The value of this parameter cannot exceed the number of brokers in the peer instance. Changing this parameter will create a new resource.
- sasl_
mechanism str - Specifies the peer Kafka authentication mode. Changing this parameter will create a new resource.
- security_
protocol str Specifies the peer Kafka authentication. Valid values are:
- SASL_SSL: SASL_SSL is enabled.
- PLAINTEXT: SASL_SSL is disabled.
Changing this parameter will create a new resource.
- sync_
consumer_ booloffsets_ enabled - Specifies whether to sync the consumption progress. Changing this parameter will create a new resource.
- task_
num float - Specifies the number of data replication tasks.
If the
direction
is set to two-way, the actual number of tasks will be twice the number of tasks you configure here. Changing this parameter will create a new resource. - topics_
mappings Sequence[str] Specifies the topic mapping string list, which is used to customize the target topic name, e.g., topic-sc-1:topic-sc-2. Changing this parameter will create a new resource.
When
rename_topic_enabled
is true,topics_mapping
can not be specified.- user_
name str - Specifies the peer Kafka user name.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource.
- compression
Type String Specifies the compression algorithm to use for copying messages. Valid values are none, gzip, snappy, lz4 and zstd. Changing this parameter will create a new resource.
The
destination_task
block supports:- consumer
Strategy String Specifies the consumer strategy of the smart connect task. Value options:
- latest: Read the latest data.
- earliest: Read the earliest data.
It's required when
destination_type
is OBS_SINK. Changing this parameter will create a new resource.- current
Instance StringAlias - Specifies the current Kafka instance alias. Changing this parameter will create a new resource.
- direction String
Specifies the sync direction. Valid values are:
- pull: Copy the data of the peer Kafka instance to the current Kafka instance.
- push: Copy the data of the current Kafka instance to the peer Kafka instance.
- two-way: Copy the data of the Kafka instances at both ends in both directions.
Changing this parameter will create a new resource.
- password String
- Specifies the peer Kafka user password.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource. - peer
Instance List<String>Addresses Specifies the peer Kafka instance address list. Changing this parameter will create a new resource.
Exactly one of
peer_instance_id
andpeer_instance_address
should be specified.- peer
Instance StringAlias - Specifies the peer Kafka instance alias. Changing this parameter will create a new resource.
- peer
Instance StringId - Specifies the peer Kafka instance ID. Changing this parameter will create a new resource.
- provenance
Header BooleanEnabled - Specifies whether the message header contains the message source. Changing this parameter will create a new resource.
- rename
Topic BooleanEnabled - Specifies whether to rename the topic. If true, will add the alias of the source Kafka instance before the target topic name to form a new name of the target topic. Changing this parameter will create a new resource.
- replication
Factor Number - Specifies the number of topic replicas. The value of this parameter cannot exceed the number of brokers in the peer instance. Changing this parameter will create a new resource.
- sasl
Mechanism String - Specifies the peer Kafka authentication mode. Changing this parameter will create a new resource.
- security
Protocol String Specifies the peer Kafka authentication. Valid values are:
- SASL_SSL: SASL_SSL is enabled.
- PLAINTEXT: SASL_SSL is disabled.
Changing this parameter will create a new resource.
- sync
Consumer BooleanOffsets Enabled - Specifies whether to sync the consumption progress. Changing this parameter will create a new resource.
- task
Num Number - Specifies the number of data replication tasks.
If the
direction
is set to two-way, the actual number of tasks will be twice the number of tasks you configure here. Changing this parameter will create a new resource. - topics
Mappings List<String> Specifies the topic mapping string list, which is used to customize the target topic name, e.g., topic-sc-1:topic-sc-2. Changing this parameter will create a new resource.
When
rename_topic_enabled
is true,topics_mapping
can not be specified.- user
Name String - Specifies the peer Kafka user name.
It's required when
security_protocol
is SASL_SSL. Changing this parameter will create a new resource.
DmsSmartConnectTaskV2Timeouts, DmsSmartConnectTaskV2TimeoutsArgs
- Create string
- Create string
- create String
- create string
- create str
- create String
Import
The kafka smart connect task can be imported using the kafka instance instance_id
and task_id
separated by a slash, e.g.
bash
$ pulumi import opentelekomcloud:index/dmsSmartConnectTaskV2:DmsSmartConnectTaskV2 test <instance_id>/<task_id>
Note that the imported state may not be identical to your resource definition, due to some attributes missing from
the API response. The missing attributes include: start_later
, destination_task.0.access_key
,
destination_task.0.secret_key
and source_task.0.password
. It is generally recommended running pulumi preview
after importing a kafka smart connect task. You can then decide if changes should be applied to the kafka smart connect
task, or the resource definition should be updated to align with the kafka smart connect task. Also you can ignore
changes as below.
hcl
resource “opentelekomcloud_dms_smart_connect_task_v2” “test” {
lifecycle {
ignore_changes = [
destination_task.0.access_key, destination_task.0.secret_key, source_task.0.password,
]
}
}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloud
Terraform Provider.