flexibleengine.DliFlinksqlJob
Explore with Pulumi AI
Manages a flink sql job resource within FlexibleEngine DLI.
Example Usage
Create a flink job
import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";
const config = new pulumi.Config();
const sql = config.requireObject("sql");
const jobName = config.requireObject("jobName");
const test = new flexibleengine.DliFlinksqlJob("test", {
type: "flink_sql_job",
sql: sql,
});
import pulumi
import pulumi_flexibleengine as flexibleengine
config = pulumi.Config()
sql = config.require_object("sql")
job_name = config.require_object("jobName")
test = flexibleengine.DliFlinksqlJob("test",
type="flink_sql_job",
sql=sql)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
"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, "")
sql := cfg.RequireObject("sql")
jobName := cfg.RequireObject("jobName")
_, err := flexibleengine.NewDliFlinksqlJob(ctx, "test", &flexibleengine.DliFlinksqlJobArgs{
Type: pulumi.String("flink_sql_job"),
Sql: pulumi.Any(sql),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var sql = config.RequireObject<dynamic>("sql");
var jobName = config.RequireObject<dynamic>("jobName");
var test = new Flexibleengine.DliFlinksqlJob("test", new()
{
Type = "flink_sql_job",
Sql = sql,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.DliFlinksqlJob;
import com.pulumi.flexibleengine.DliFlinksqlJobArgs;
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 sql = config.get("sql");
final var jobName = config.get("jobName");
var test = new DliFlinksqlJob("test", DliFlinksqlJobArgs.builder()
.type("flink_sql_job")
.sql(sql)
.build());
}
}
configuration:
sql:
type: dynamic
jobName:
type: dynamic
resources:
test:
type: flexibleengine:DliFlinksqlJob
properties:
type: flink_sql_job
sql: ${sql}
Create DliFlinksqlJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DliFlinksqlJob(name: string, args?: DliFlinksqlJobArgs, opts?: CustomResourceOptions);
@overload
def DliFlinksqlJob(resource_name: str,
args: Optional[DliFlinksqlJobArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def DliFlinksqlJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
checkpoint_enabled: Optional[bool] = None,
checkpoint_interval: Optional[float] = None,
checkpoint_mode: Optional[str] = None,
cu_number: Optional[float] = None,
description: Optional[str] = None,
dirty_data_strategy: Optional[str] = None,
dli_flinksql_job_id: Optional[str] = None,
edge_group_ids: Optional[Sequence[str]] = None,
idle_state_retention: Optional[float] = None,
log_enabled: Optional[bool] = None,
manager_cu_number: Optional[float] = None,
name: Optional[str] = None,
obs_bucket: Optional[str] = None,
parallel_number: Optional[float] = None,
queue_name: Optional[str] = None,
region: Optional[str] = None,
restart_when_exception: Optional[bool] = None,
resume_checkpoint: Optional[bool] = None,
resume_max_num: Optional[float] = None,
run_mode: Optional[str] = None,
runtime_config: Optional[Mapping[str, str]] = None,
smn_topic: Optional[str] = None,
sql: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[DliFlinksqlJobTimeoutsArgs] = None,
tm_cus: Optional[float] = None,
tm_slot_num: Optional[float] = None,
type: Optional[str] = None,
udf_jar_url: Optional[str] = None)
func NewDliFlinksqlJob(ctx *Context, name string, args *DliFlinksqlJobArgs, opts ...ResourceOption) (*DliFlinksqlJob, error)
public DliFlinksqlJob(string name, DliFlinksqlJobArgs? args = null, CustomResourceOptions? opts = null)
public DliFlinksqlJob(String name, DliFlinksqlJobArgs args)
public DliFlinksqlJob(String name, DliFlinksqlJobArgs args, CustomResourceOptions options)
type: flexibleengine:DliFlinksqlJob
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 DliFlinksqlJobArgs
- 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 DliFlinksqlJobArgs
- 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 DliFlinksqlJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DliFlinksqlJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DliFlinksqlJobArgs
- 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 dliFlinksqlJobResource = new Flexibleengine.DliFlinksqlJob("dliFlinksqlJobResource", new()
{
CheckpointEnabled = false,
CheckpointInterval = 0,
CheckpointMode = "string",
CuNumber = 0,
Description = "string",
DirtyDataStrategy = "string",
DliFlinksqlJobId = "string",
EdgeGroupIds = new[]
{
"string",
},
IdleStateRetention = 0,
LogEnabled = false,
ManagerCuNumber = 0,
Name = "string",
ObsBucket = "string",
ParallelNumber = 0,
QueueName = "string",
Region = "string",
RestartWhenException = false,
ResumeCheckpoint = false,
ResumeMaxNum = 0,
RunMode = "string",
RuntimeConfig =
{
{ "string", "string" },
},
SmnTopic = "string",
Sql = "string",
Tags =
{
{ "string", "string" },
},
Timeouts = new Flexibleengine.Inputs.DliFlinksqlJobTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
TmCus = 0,
TmSlotNum = 0,
Type = "string",
UdfJarUrl = "string",
});
example, err := flexibleengine.NewDliFlinksqlJob(ctx, "dliFlinksqlJobResource", &flexibleengine.DliFlinksqlJobArgs{
CheckpointEnabled: pulumi.Bool(false),
CheckpointInterval: pulumi.Float64(0),
CheckpointMode: pulumi.String("string"),
CuNumber: pulumi.Float64(0),
Description: pulumi.String("string"),
DirtyDataStrategy: pulumi.String("string"),
DliFlinksqlJobId: pulumi.String("string"),
EdgeGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
IdleStateRetention: pulumi.Float64(0),
LogEnabled: pulumi.Bool(false),
ManagerCuNumber: pulumi.Float64(0),
Name: pulumi.String("string"),
ObsBucket: pulumi.String("string"),
ParallelNumber: pulumi.Float64(0),
QueueName: pulumi.String("string"),
Region: pulumi.String("string"),
RestartWhenException: pulumi.Bool(false),
ResumeCheckpoint: pulumi.Bool(false),
ResumeMaxNum: pulumi.Float64(0),
RunMode: pulumi.String("string"),
RuntimeConfig: pulumi.StringMap{
"string": pulumi.String("string"),
},
SmnTopic: pulumi.String("string"),
Sql: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeouts: &flexibleengine.DliFlinksqlJobTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
TmCus: pulumi.Float64(0),
TmSlotNum: pulumi.Float64(0),
Type: pulumi.String("string"),
UdfJarUrl: pulumi.String("string"),
})
var dliFlinksqlJobResource = new DliFlinksqlJob("dliFlinksqlJobResource", DliFlinksqlJobArgs.builder()
.checkpointEnabled(false)
.checkpointInterval(0)
.checkpointMode("string")
.cuNumber(0)
.description("string")
.dirtyDataStrategy("string")
.dliFlinksqlJobId("string")
.edgeGroupIds("string")
.idleStateRetention(0)
.logEnabled(false)
.managerCuNumber(0)
.name("string")
.obsBucket("string")
.parallelNumber(0)
.queueName("string")
.region("string")
.restartWhenException(false)
.resumeCheckpoint(false)
.resumeMaxNum(0)
.runMode("string")
.runtimeConfig(Map.of("string", "string"))
.smnTopic("string")
.sql("string")
.tags(Map.of("string", "string"))
.timeouts(DliFlinksqlJobTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.tmCus(0)
.tmSlotNum(0)
.type("string")
.udfJarUrl("string")
.build());
dli_flinksql_job_resource = flexibleengine.DliFlinksqlJob("dliFlinksqlJobResource",
checkpoint_enabled=False,
checkpoint_interval=0,
checkpoint_mode="string",
cu_number=0,
description="string",
dirty_data_strategy="string",
dli_flinksql_job_id="string",
edge_group_ids=["string"],
idle_state_retention=0,
log_enabled=False,
manager_cu_number=0,
name="string",
obs_bucket="string",
parallel_number=0,
queue_name="string",
region="string",
restart_when_exception=False,
resume_checkpoint=False,
resume_max_num=0,
run_mode="string",
runtime_config={
"string": "string",
},
smn_topic="string",
sql="string",
tags={
"string": "string",
},
timeouts={
"create": "string",
"delete": "string",
"update": "string",
},
tm_cus=0,
tm_slot_num=0,
type="string",
udf_jar_url="string")
const dliFlinksqlJobResource = new flexibleengine.DliFlinksqlJob("dliFlinksqlJobResource", {
checkpointEnabled: false,
checkpointInterval: 0,
checkpointMode: "string",
cuNumber: 0,
description: "string",
dirtyDataStrategy: "string",
dliFlinksqlJobId: "string",
edgeGroupIds: ["string"],
idleStateRetention: 0,
logEnabled: false,
managerCuNumber: 0,
name: "string",
obsBucket: "string",
parallelNumber: 0,
queueName: "string",
region: "string",
restartWhenException: false,
resumeCheckpoint: false,
resumeMaxNum: 0,
runMode: "string",
runtimeConfig: {
string: "string",
},
smnTopic: "string",
sql: "string",
tags: {
string: "string",
},
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
tmCus: 0,
tmSlotNum: 0,
type: "string",
udfJarUrl: "string",
});
type: flexibleengine:DliFlinksqlJob
properties:
checkpointEnabled: false
checkpointInterval: 0
checkpointMode: string
cuNumber: 0
description: string
dirtyDataStrategy: string
dliFlinksqlJobId: string
edgeGroupIds:
- string
idleStateRetention: 0
logEnabled: false
managerCuNumber: 0
name: string
obsBucket: string
parallelNumber: 0
queueName: string
region: string
restartWhenException: false
resumeCheckpoint: false
resumeMaxNum: 0
runMode: string
runtimeConfig:
string: string
smnTopic: string
sql: string
tags:
string: string
timeouts:
create: string
delete: string
update: string
tmCus: 0
tmSlotNum: 0
type: string
udfJarUrl: string
DliFlinksqlJob 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 DliFlinksqlJob resource accepts the following input properties:
- Checkpoint
Enabled bool Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- Checkpoint
Interval double - Specifies snapshot interval. The unit is second. The default value is 10.
- Checkpoint
Mode string Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- Cu
Number double - Specifies number of CUs selected for a job. The default value is 2.
- Description string
- Specifies job description. Length range: 1 to 512 characters.
- Dirty
Data stringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- Dli
Flinksql stringJob Id - The Job ID in Int format.
- Edge
Group List<string>Ids - Specifies edge computing group IDs.
- Idle
State doubleRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- Log
Enabled bool - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- Manager
Cu doubleNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- Name string
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- Obs
Bucket string - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - Parallel
Number double - Specifies number of parallel for a job. The default value is 1.
- Queue
Name string - Specifies name of a queue.
- Region string
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- Restart
When boolException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- Resume
Checkpoint bool - Specifies whether the abnormal restart is recovered from the checkpoint.
- Resume
Max doubleNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - Run
Mode string Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- Runtime
Config Dictionary<string, string> - Specifies customizes optimization parameters when a Flink job is running.
- Smn
Topic string - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- Sql string
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- Dictionary<string, string>
- Specifies the key/value pairs to associate with the resource.
- Timeouts
Dli
Flinksql Job Timeouts - Tm
Cus double - Specifies number of CUs for each Task Manager. The default value is 1.
- Tm
Slot doubleNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- Type string
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - Udf
Jar stringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- Checkpoint
Enabled bool Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- Checkpoint
Interval float64 - Specifies snapshot interval. The unit is second. The default value is 10.
- Checkpoint
Mode string Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- Cu
Number float64 - Specifies number of CUs selected for a job. The default value is 2.
- Description string
- Specifies job description. Length range: 1 to 512 characters.
- Dirty
Data stringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- Dli
Flinksql stringJob Id - The Job ID in Int format.
- Edge
Group []stringIds - Specifies edge computing group IDs.
- Idle
State float64Retention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- Log
Enabled bool - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- Manager
Cu float64Number - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- Name string
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- Obs
Bucket string - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - Parallel
Number float64 - Specifies number of parallel for a job. The default value is 1.
- Queue
Name string - Specifies name of a queue.
- Region string
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- Restart
When boolException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- Resume
Checkpoint bool - Specifies whether the abnormal restart is recovered from the checkpoint.
- Resume
Max float64Num - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - Run
Mode string Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- Runtime
Config map[string]string - Specifies customizes optimization parameters when a Flink job is running.
- Smn
Topic string - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- Sql string
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- map[string]string
- Specifies the key/value pairs to associate with the resource.
- Timeouts
Dli
Flinksql Job Timeouts Args - Tm
Cus float64 - Specifies number of CUs for each Task Manager. The default value is 1.
- Tm
Slot float64Num - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- Type string
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - Udf
Jar stringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint
Enabled Boolean Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint
Interval Double - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint
Mode String Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu
Number Double - Specifies number of CUs selected for a job. The default value is 2.
- description String
- Specifies job description. Length range: 1 to 512 characters.
- dirty
Data StringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli
Flinksql StringJob Id - The Job ID in Int format.
- edge
Group List<String>Ids - Specifies edge computing group IDs.
- idle
State DoubleRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log
Enabled Boolean - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager
Cu DoubleNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name String
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs
Bucket String - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel
Number Double - Specifies number of parallel for a job. The default value is 1.
- queue
Name String - Specifies name of a queue.
- region String
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart
When BooleanException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume
Checkpoint Boolean - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume
Max DoubleNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run
Mode String Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime
Config Map<String,String> - Specifies customizes optimization parameters when a Flink job is running.
- smn
Topic String - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql String
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- Map<String,String>
- Specifies the key/value pairs to associate with the resource.
- timeouts
Dli
Flinksql Job Timeouts - tm
Cus Double - Specifies number of CUs for each Task Manager. The default value is 1.
- tm
Slot DoubleNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type String
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf
Jar StringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint
Enabled boolean Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint
Interval number - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint
Mode string Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu
Number number - Specifies number of CUs selected for a job. The default value is 2.
- description string
- Specifies job description. Length range: 1 to 512 characters.
- dirty
Data stringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli
Flinksql stringJob Id - The Job ID in Int format.
- edge
Group string[]Ids - Specifies edge computing group IDs.
- idle
State numberRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log
Enabled boolean - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager
Cu numberNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name string
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs
Bucket string - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel
Number number - Specifies number of parallel for a job. The default value is 1.
- queue
Name string - Specifies name of a queue.
- region string
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart
When booleanException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume
Checkpoint boolean - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume
Max numberNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run
Mode string Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime
Config {[key: string]: string} - Specifies customizes optimization parameters when a Flink job is running.
- smn
Topic string - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql string
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- {[key: string]: string}
- Specifies the key/value pairs to associate with the resource.
- timeouts
Dli
Flinksql Job Timeouts - tm
Cus number - Specifies number of CUs for each Task Manager. The default value is 1.
- tm
Slot numberNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type string
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf
Jar stringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint_
enabled bool Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint_
interval float - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint_
mode str Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu_
number float - Specifies number of CUs selected for a job. The default value is 2.
- description str
- Specifies job description. Length range: 1 to 512 characters.
- dirty_
data_ strstrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli_
flinksql_ strjob_ id - The Job ID in Int format.
- edge_
group_ Sequence[str]ids - Specifies edge computing group IDs.
- idle_
state_ floatretention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log_
enabled bool - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager_
cu_ floatnumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name str
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs_
bucket str - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel_
number float - Specifies number of parallel for a job. The default value is 1.
- queue_
name str - Specifies name of a queue.
- region str
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart_
when_ boolexception - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume_
checkpoint bool - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume_
max_ floatnum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run_
mode str Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime_
config Mapping[str, str] - Specifies customizes optimization parameters when a Flink job is running.
- smn_
topic str - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql str
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- Mapping[str, str]
- Specifies the key/value pairs to associate with the resource.
- timeouts
Dli
Flinksql Job Timeouts Args - tm_
cus float - Specifies number of CUs for each Task Manager. The default value is 1.
- tm_
slot_ floatnum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type str
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf_
jar_ strurl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint
Enabled Boolean Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint
Interval Number - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint
Mode String Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu
Number Number - Specifies number of CUs selected for a job. The default value is 2.
- description String
- Specifies job description. Length range: 1 to 512 characters.
- dirty
Data StringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli
Flinksql StringJob Id - The Job ID in Int format.
- edge
Group List<String>Ids - Specifies edge computing group IDs.
- idle
State NumberRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log
Enabled Boolean - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager
Cu NumberNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name String
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs
Bucket String - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel
Number Number - Specifies number of parallel for a job. The default value is 1.
- queue
Name String - Specifies name of a queue.
- region String
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart
When BooleanException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume
Checkpoint Boolean - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume
Max NumberNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run
Mode String Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime
Config Map<String> - Specifies customizes optimization parameters when a Flink job is running.
- smn
Topic String - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql String
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- Map<String>
- Specifies the key/value pairs to associate with the resource.
- timeouts Property Map
- tm
Cus Number - Specifies number of CUs for each Task Manager. The default value is 1.
- tm
Slot NumberNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type String
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf
Jar StringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
Outputs
All input properties are implicitly available as output properties. Additionally, the DliFlinksqlJob resource produces the following output properties:
Look up Existing DliFlinksqlJob Resource
Get an existing DliFlinksqlJob 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?: DliFlinksqlJobState, opts?: CustomResourceOptions): DliFlinksqlJob
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
checkpoint_enabled: Optional[bool] = None,
checkpoint_interval: Optional[float] = None,
checkpoint_mode: Optional[str] = None,
cu_number: Optional[float] = None,
description: Optional[str] = None,
dirty_data_strategy: Optional[str] = None,
dli_flinksql_job_id: Optional[str] = None,
edge_group_ids: Optional[Sequence[str]] = None,
idle_state_retention: Optional[float] = None,
log_enabled: Optional[bool] = None,
manager_cu_number: Optional[float] = None,
name: Optional[str] = None,
obs_bucket: Optional[str] = None,
parallel_number: Optional[float] = None,
queue_name: Optional[str] = None,
region: Optional[str] = None,
restart_when_exception: Optional[bool] = None,
resume_checkpoint: Optional[bool] = None,
resume_max_num: Optional[float] = None,
run_mode: Optional[str] = None,
runtime_config: Optional[Mapping[str, str]] = None,
smn_topic: Optional[str] = None,
sql: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[DliFlinksqlJobTimeoutsArgs] = None,
tm_cus: Optional[float] = None,
tm_slot_num: Optional[float] = None,
type: Optional[str] = None,
udf_jar_url: Optional[str] = None) -> DliFlinksqlJob
func GetDliFlinksqlJob(ctx *Context, name string, id IDInput, state *DliFlinksqlJobState, opts ...ResourceOption) (*DliFlinksqlJob, error)
public static DliFlinksqlJob Get(string name, Input<string> id, DliFlinksqlJobState? state, CustomResourceOptions? opts = null)
public static DliFlinksqlJob get(String name, Output<String> id, DliFlinksqlJobState state, CustomResourceOptions options)
resources: _: type: flexibleengine:DliFlinksqlJob 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.
- Checkpoint
Enabled bool Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- Checkpoint
Interval double - Specifies snapshot interval. The unit is second. The default value is 10.
- Checkpoint
Mode string Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- Cu
Number double - Specifies number of CUs selected for a job. The default value is 2.
- Description string
- Specifies job description. Length range: 1 to 512 characters.
- Dirty
Data stringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- Dli
Flinksql stringJob Id - The Job ID in Int format.
- Edge
Group List<string>Ids - Specifies edge computing group IDs.
- Idle
State doubleRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- Log
Enabled bool - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- Manager
Cu doubleNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- Name string
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- Obs
Bucket string - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - Parallel
Number double - Specifies number of parallel for a job. The default value is 1.
- Queue
Name string - Specifies name of a queue.
- Region string
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- Restart
When boolException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- Resume
Checkpoint bool - Specifies whether the abnormal restart is recovered from the checkpoint.
- Resume
Max doubleNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - Run
Mode string Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- Runtime
Config Dictionary<string, string> - Specifies customizes optimization parameters when a Flink job is running.
- Smn
Topic string - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- Sql string
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- Status string
- Dictionary<string, string>
- Specifies the key/value pairs to associate with the resource.
- Timeouts
Dli
Flinksql Job Timeouts - Tm
Cus double - Specifies number of CUs for each Task Manager. The default value is 1.
- Tm
Slot doubleNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- Type string
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - Udf
Jar stringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- Checkpoint
Enabled bool Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- Checkpoint
Interval float64 - Specifies snapshot interval. The unit is second. The default value is 10.
- Checkpoint
Mode string Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- Cu
Number float64 - Specifies number of CUs selected for a job. The default value is 2.
- Description string
- Specifies job description. Length range: 1 to 512 characters.
- Dirty
Data stringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- Dli
Flinksql stringJob Id - The Job ID in Int format.
- Edge
Group []stringIds - Specifies edge computing group IDs.
- Idle
State float64Retention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- Log
Enabled bool - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- Manager
Cu float64Number - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- Name string
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- Obs
Bucket string - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - Parallel
Number float64 - Specifies number of parallel for a job. The default value is 1.
- Queue
Name string - Specifies name of a queue.
- Region string
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- Restart
When boolException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- Resume
Checkpoint bool - Specifies whether the abnormal restart is recovered from the checkpoint.
- Resume
Max float64Num - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - Run
Mode string Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- Runtime
Config map[string]string - Specifies customizes optimization parameters when a Flink job is running.
- Smn
Topic string - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- Sql string
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- Status string
- map[string]string
- Specifies the key/value pairs to associate with the resource.
- Timeouts
Dli
Flinksql Job Timeouts Args - Tm
Cus float64 - Specifies number of CUs for each Task Manager. The default value is 1.
- Tm
Slot float64Num - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- Type string
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - Udf
Jar stringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint
Enabled Boolean Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint
Interval Double - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint
Mode String Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu
Number Double - Specifies number of CUs selected for a job. The default value is 2.
- description String
- Specifies job description. Length range: 1 to 512 characters.
- dirty
Data StringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli
Flinksql StringJob Id - The Job ID in Int format.
- edge
Group List<String>Ids - Specifies edge computing group IDs.
- idle
State DoubleRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log
Enabled Boolean - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager
Cu DoubleNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name String
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs
Bucket String - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel
Number Double - Specifies number of parallel for a job. The default value is 1.
- queue
Name String - Specifies name of a queue.
- region String
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart
When BooleanException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume
Checkpoint Boolean - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume
Max DoubleNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run
Mode String Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime
Config Map<String,String> - Specifies customizes optimization parameters when a Flink job is running.
- smn
Topic String - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql String
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- status String
- Map<String,String>
- Specifies the key/value pairs to associate with the resource.
- timeouts
Dli
Flinksql Job Timeouts - tm
Cus Double - Specifies number of CUs for each Task Manager. The default value is 1.
- tm
Slot DoubleNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type String
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf
Jar StringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint
Enabled boolean Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint
Interval number - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint
Mode string Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu
Number number - Specifies number of CUs selected for a job. The default value is 2.
- description string
- Specifies job description. Length range: 1 to 512 characters.
- dirty
Data stringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli
Flinksql stringJob Id - The Job ID in Int format.
- edge
Group string[]Ids - Specifies edge computing group IDs.
- idle
State numberRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log
Enabled boolean - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager
Cu numberNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name string
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs
Bucket string - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel
Number number - Specifies number of parallel for a job. The default value is 1.
- queue
Name string - Specifies name of a queue.
- region string
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart
When booleanException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume
Checkpoint boolean - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume
Max numberNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run
Mode string Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime
Config {[key: string]: string} - Specifies customizes optimization parameters when a Flink job is running.
- smn
Topic string - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql string
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- status string
- {[key: string]: string}
- Specifies the key/value pairs to associate with the resource.
- timeouts
Dli
Flinksql Job Timeouts - tm
Cus number - Specifies number of CUs for each Task Manager. The default value is 1.
- tm
Slot numberNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type string
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf
Jar stringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint_
enabled bool Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint_
interval float - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint_
mode str Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu_
number float - Specifies number of CUs selected for a job. The default value is 2.
- description str
- Specifies job description. Length range: 1 to 512 characters.
- dirty_
data_ strstrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli_
flinksql_ strjob_ id - The Job ID in Int format.
- edge_
group_ Sequence[str]ids - Specifies edge computing group IDs.
- idle_
state_ floatretention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log_
enabled bool - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager_
cu_ floatnumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name str
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs_
bucket str - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel_
number float - Specifies number of parallel for a job. The default value is 1.
- queue_
name str - Specifies name of a queue.
- region str
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart_
when_ boolexception - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume_
checkpoint bool - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume_
max_ floatnum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run_
mode str Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime_
config Mapping[str, str] - Specifies customizes optimization parameters when a Flink job is running.
- smn_
topic str - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql str
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- status str
- Mapping[str, str]
- Specifies the key/value pairs to associate with the resource.
- timeouts
Dli
Flinksql Job Timeouts Args - tm_
cus float - Specifies number of CUs for each Task Manager. The default value is 1.
- tm_
slot_ floatnum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type str
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf_
jar_ strurl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
- checkpoint
Enabled Boolean Specifies whether to enable the automatic job snapshot function.
- true: indicates to enable the automatic job snapshot function.
- false: indicates to disable the automatic job snapshot function.
Default value: false
- checkpoint
Interval Number - Specifies snapshot interval. The unit is second. The default value is 10.
- checkpoint
Mode String Specifies snapshot mode. There are two options:
- exactly_once: indicates that data is processed only once.
- at_least_once: indicates that data is processed at least once.
The default value is 1.
- cu
Number Number - Specifies number of CUs selected for a job. The default value is 2.
- description String
- Specifies job description. Length range: 1 to 512 characters.
- dirty
Data StringStrategy Specifies dirty data policy of a job.
- 2:obsDir: Save the dirty data to the obs path
obsDir
. For example:2:yourBucket/output_path
- 1: Trigger a job exception
- 0: Ignore
The default value is
0
.- 2:obsDir: Save the dirty data to the obs path
- dli
Flinksql StringJob Id - The Job ID in Int format.
- edge
Group List<String>Ids - Specifies edge computing group IDs.
- idle
State NumberRetention - Specifies retention time of the idle state. The unit is hour. The default value is 1.
- log
Enabled Boolean - Specifies whether to enable the function of uploading job logs to users' OBS buckets. The default value is false.
- manager
Cu NumberNumber - Specifies number of CUs in the JobManager selected for a job. The default value is 1.
- name String
- Specifies the name of the job. Length range: 1 to 57 characters. which may consist of letters, digits, underscores (_) and hyphens (-).
- obs
Bucket String - Specifies OBS path. OBS path where users are authorized to save the
snapshot. This parameter is valid only when
checkpoint_enabled
is set totrue
. OBS path where users are authorized to save the snapshot. This parameter is valid only whenlog_enabled
is set totrue
. - parallel
Number Number - Specifies number of parallel for a job. The default value is 1.
- queue
Name String - Specifies name of a queue.
- region String
- The region in which to create the DLI flink job resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
- restart
When BooleanException - Specifies whether to enable the function of automatically restarting a job upon job exceptions. The default value is false.
- resume
Checkpoint Boolean - Specifies whether the abnormal restart is recovered from the checkpoint.
- resume
Max NumberNum - Specifies maximum number of retry times upon exceptions. The unit is
times/hour
. Value range:-1
or greater than0
. The default value is-1
, indicating that the number of times is unlimited. - run
Mode String Specifies job running mode. The options are as follows:
- shared_cluster: indicates that the job is running on a shared cluster.
- exclusive_cluster: indicates that the job is running on an exclusive cluster.
- edge_node: indicates that the job is running on an edge node.
The default value is
shared_cluster
.- runtime
Config Map<String> - Specifies customizes optimization parameters when a Flink job is running.
- smn
Topic String - Specifies SMN topic. If a job fails, the system will send a message to users subscribed to the SMN topic.
- sql String
- Specifies stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 1024x1024 characters.
- status String
- Map<String>
- Specifies the key/value pairs to associate with the resource.
- timeouts Property Map
- tm
Cus Number - Specifies number of CUs for each Task Manager. The default value is 1.
- tm
Slot NumberNum - Specifies number of slots in each Task Manager. The default value is (parallel_number * tm_cus)/(cu_number - manager_cu_number).
- type String
- Specifies the type of the job. The valid values are
flink_sql_job
,flink_opensource_sql_job
andflink_sql_edge_job
. Default value isflink_sql_job
. Changing this parameter will create a new resource. - udf
Jar StringUrl - Specifies name of the resource package that has been uploaded to the DLI resource management system. The UDF Jar file of the SQL job is specified by this parameter.
Supporting Types
DliFlinksqlJobTimeouts, DliFlinksqlJobTimeoutsArgs
Import
Clusters can be imported by their id
. For example,
$ pulumi import flexibleengine:index/dliFlinksqlJob:DliFlinksqlJob test 12345
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
- License
- Notes
- This Pulumi package is based on the
flexibleengine
Terraform Provider.