Skip to content

Files

Latest commit

team-tf-cdkteam-tf-cdk
feat: upgrade provider from 6.36.1 to version 6.37.0 (#2019)
May 28, 2025
4668213 · May 28, 2025

History

History
9440 lines (5983 loc) · 413 KB
·

dataplexTask.python.md

File metadata and controls

9440 lines (5983 loc) · 413 KB
·

dataplexTask Submodule

Constructs

DataplexTask

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task google_dataplex_task}.

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTask(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  execution_spec: DataplexTaskExecutionSpec,
  trigger_spec: DataplexTaskTriggerSpec,
  description: str = None,
  display_name: str = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  lake: str = None,
  location: str = None,
  notebook: DataplexTaskNotebook = None,
  project: str = None,
  spark: DataplexTaskSpark = None,
  task_id: str = None,
  timeouts: DataplexTaskTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
execution_spec DataplexTaskExecutionSpec execution_spec block.
trigger_spec DataplexTaskTriggerSpec trigger_spec block.
description str User-provided description of the task.
display_name str User friendly display name.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#id DataplexTask#id}.
labels typing.Mapping[str] User-defined labels for the task.
lake str The lake in which the task will be created in.
location str The location in which the task will be created in.
notebook DataplexTaskNotebook notebook block.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#project DataplexTask#project}.
spark DataplexTaskSpark spark block.
task_id str The task Id of the task.
timeouts DataplexTaskTimeouts timeouts block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
execution_specRequired

execution_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#execution_spec DataplexTask#execution_spec}

trigger_specRequired

trigger_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#trigger_spec DataplexTask#trigger_spec}

descriptionOptional
  • Type: str

User-provided description of the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#description DataplexTask#description}

display_nameOptional
  • Type: str

User friendly display name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#display_name DataplexTask#display_name}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#id DataplexTask#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

labelsOptional
  • Type: typing.Mapping[str]

User-defined labels for the task.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#labels DataplexTask#labels}

lakeOptional
  • Type: str

The lake in which the task will be created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#lake DataplexTask#lake}

locationOptional
  • Type: str

The location in which the task will be created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#location DataplexTask#location}

notebookOptional

notebook block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#notebook DataplexTask#notebook}

projectOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#project DataplexTask#project}.

sparkOptional

spark block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#spark DataplexTask#spark}

task_idOptional
  • Type: str

The task Id of the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#task_id DataplexTask#task_id}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#timeouts DataplexTask#timeouts}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_execution_spec No description.
put_notebook No description.
put_spark No description.
put_timeouts No description.
put_trigger_spec No description.
reset_description No description.
reset_display_name No description.
reset_id No description.
reset_labels No description.
reset_lake No description.
reset_location No description.
reset_notebook No description.
reset_project No description.
reset_spark No description.
reset_task_id No description.
reset_timeouts No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_execution_spec 
def put_execution_spec(
  service_account: str,
  args: typing.Mapping[str] = None,
  kms_key: str = None,
  max_job_execution_lifetime: str = None,
  project: str = None
) -> None
service_accountRequired
  • Type: str

Service account to use to execute a task.

If not provided, the default Compute service account for the project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#service_account DataplexTask#service_account}

argsOptional
  • Type: typing.Mapping[str]

The arguments to pass to the task.

The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${taskId} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument. An object containing a list of 'key': value pairs. Example: { 'name': 'wrench', 'mass': '1.3kg', 'count': '3' }.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#args DataplexTask#args}

kms_keyOptional
  • Type: str

The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{locationId}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#kms_key DataplexTask#kms_key}

max_job_execution_lifetimeOptional
  • Type: str

The maximum duration after which the job execution is expired.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: '3.5s'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_job_execution_lifetime DataplexTask#max_job_execution_lifetime}

projectOptional
  • Type: str

The project in which jobs are run.

By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#project DataplexTask#project}

put_notebook 
def put_notebook(
  notebook: str,
  archive_uris: typing.List[str] = None,
  file_uris: typing.List[str] = None,
  infrastructure_spec: DataplexTaskNotebookInfrastructureSpec = None
) -> None
notebookRequired
  • Type: str

Path to input notebook.

This can be the Cloud Storage URI of the notebook file or the path to a Notebook Content. The execution args are accessible as environment variables (TASK_key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#notebook DataplexTask#notebook}

archive_urisOptional
  • Type: typing.List[str]

Cloud Storage URIs of archives to be extracted into the working directory of each executor.

Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#archive_uris DataplexTask#archive_uris}

file_urisOptional
  • Type: typing.List[str]

Cloud Storage URIs of files to be placed in the working directory of each executor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#file_uris DataplexTask#file_uris}

infrastructure_specOptional

infrastructure_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#infrastructure_spec DataplexTask#infrastructure_spec}

put_spark 
def put_spark(
  archive_uris: typing.List[str] = None,
  file_uris: typing.List[str] = None,
  infrastructure_spec: DataplexTaskSparkInfrastructureSpec = None,
  main_class: str = None,
  main_jar_file_uri: str = None,
  python_script_file: str = None,
  sql_script: str = None,
  sql_script_file: str = None
) -> None
archive_urisOptional
  • Type: typing.List[str]

Cloud Storage URIs of archives to be extracted into the working directory of each executor.

Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#archive_uris DataplexTask#archive_uris}

file_urisOptional
  • Type: typing.List[str]

Cloud Storage URIs of files to be placed in the working directory of each executor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#file_uris DataplexTask#file_uris}

infrastructure_specOptional

infrastructure_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#infrastructure_spec DataplexTask#infrastructure_spec}

main_classOptional
  • Type: str

The name of the driver's main class.

The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. The execution args are passed in as a sequence of named process arguments (--key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#main_class DataplexTask#main_class}

main_jar_file_uriOptional
  • Type: str

The Cloud Storage URI of the jar file that contains the main class.

The execution args are passed in as a sequence of named process arguments (--key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#main_jar_file_uri DataplexTask#main_jar_file_uri}

python_script_fileOptional
  • Type: str

The Gcloud Storage URI of the main Python file to use as the driver.

Must be a .py file. The execution args are passed in as a sequence of named process arguments (--key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#python_script_file DataplexTask#python_script_file}

sql_scriptOptional
  • Type: str

The query text. The execution args are used to declare a set of script variables (set key='value';).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sql_script DataplexTask#sql_script}

sql_script_fileOptional
  • Type: str

A reference to a query file.

This can be the Cloud Storage URI of the query file or it can the path to a SqlScript Content. The execution args are used to declare a set of script variables (set key='value';).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sql_script_file DataplexTask#sql_script_file}

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#create DataplexTask#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#delete DataplexTask#delete}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#update DataplexTask#update}.

put_trigger_spec 
def put_trigger_spec(
  type: str,
  disabled: typing.Union[bool, IResolvable] = None,
  max_retries: typing.Union[int, float] = None,
  schedule: str = None,
  start_time: str = None
) -> None
typeRequired
  • Type: str

Trigger type of the user-specified Task Possible values: ["ON_DEMAND", "RECURRING"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#type DataplexTask#type}

disabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Prevent the task from executing.

This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#disabled DataplexTask#disabled}

max_retriesOptional
  • Type: typing.Union[int, float]

Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_retries DataplexTask#max_retries}

scheduleOptional
  • Type: str

Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#schedule DataplexTask#schedule}

start_timeOptional
  • Type: str

The first run of the task will be after this time.

If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#start_time DataplexTask#start_time}

reset_description 
def reset_description() -> None
reset_display_name 
def reset_display_name() -> None
reset_id 
def reset_id() -> None
reset_labels 
def reset_labels() -> None
reset_lake 
def reset_lake() -> None
reset_location 
def reset_location() -> None
reset_notebook 
def reset_notebook() -> None
reset_project 
def reset_project() -> None
reset_spark 
def reset_spark() -> None
reset_task_id 
def reset_task_id() -> None
reset_timeouts 
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a DataplexTask resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTask.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTask.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTask.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTask.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a DataplexTask resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the DataplexTask to import.

import_from_idRequired
  • Type: str

The id of the existing DataplexTask that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataplexTask to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
create_time str No description.
effective_labels cdktf.StringMap No description.
execution_spec DataplexTaskExecutionSpecOutputReference No description.
execution_status DataplexTaskExecutionStatusList No description.
name str No description.
notebook DataplexTaskNotebookOutputReference No description.
spark DataplexTaskSparkOutputReference No description.
state str No description.
terraform_labels cdktf.StringMap No description.
timeouts DataplexTaskTimeoutsOutputReference No description.
trigger_spec DataplexTaskTriggerSpecOutputReference No description.
uid str No description.
update_time str No description.
description_input str No description.
display_name_input str No description.
execution_spec_input DataplexTaskExecutionSpec No description.
id_input str No description.
labels_input typing.Mapping[str] No description.
lake_input str No description.
location_input str No description.
notebook_input DataplexTaskNotebook No description.
project_input str No description.
spark_input DataplexTaskSpark No description.
task_id_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, DataplexTaskTimeouts] No description.
trigger_spec_input DataplexTaskTriggerSpec No description.
description str No description.
display_name str No description.
id str No description.
labels typing.Mapping[str] No description.
lake str No description.
location str No description.
project str No description.
task_id str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
create_timeRequired 
create_time: str
  • Type: str
effective_labelsRequired 
effective_labels: StringMap
  • Type: cdktf.StringMap
execution_specRequired 
execution_spec: DataplexTaskExecutionSpecOutputReference
execution_statusRequired 
execution_status: DataplexTaskExecutionStatusList
nameRequired 
name: str
  • Type: str
notebookRequired 
notebook: DataplexTaskNotebookOutputReference
sparkRequired 
spark: DataplexTaskSparkOutputReference
stateRequired 
state: str
  • Type: str
terraform_labelsRequired 
terraform_labels: StringMap
  • Type: cdktf.StringMap
timeoutsRequired 
timeouts: DataplexTaskTimeoutsOutputReference
trigger_specRequired 
trigger_spec: DataplexTaskTriggerSpecOutputReference
uidRequired 
uid: str
  • Type: str
update_timeRequired 
update_time: str
  • Type: str
description_inputOptional 
description_input: str
  • Type: str
display_name_inputOptional 
display_name_input: str
  • Type: str
execution_spec_inputOptional 
execution_spec_input: DataplexTaskExecutionSpec
id_inputOptional 
id_input: str
  • Type: str
labels_inputOptional 
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
lake_inputOptional 
lake_input: str
  • Type: str
location_inputOptional 
location_input: str
  • Type: str
notebook_inputOptional 
notebook_input: DataplexTaskNotebook
project_inputOptional 
project_input: str
  • Type: str
spark_inputOptional 
spark_input: DataplexTaskSpark
task_id_inputOptional 
task_id_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, DataplexTaskTimeouts]
trigger_spec_inputOptional 
trigger_spec_input: DataplexTaskTriggerSpec
descriptionRequired 
description: str
  • Type: str
display_nameRequired 
display_name: str
  • Type: str
idRequired 
id: str
  • Type: str
labelsRequired 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]
lakeRequired 
lake: str
  • Type: str
locationRequired 
location: str
  • Type: str
projectRequired 
project: str
  • Type: str
task_idRequired 
task_id: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

DataplexTaskConfig

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  execution_spec: DataplexTaskExecutionSpec,
  trigger_spec: DataplexTaskTriggerSpec,
  description: str = None,
  display_name: str = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  lake: str = None,
  location: str = None,
  notebook: DataplexTaskNotebook = None,
  project: str = None,
  spark: DataplexTaskSpark = None,
  task_id: str = None,
  timeouts: DataplexTaskTimeouts = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
execution_spec DataplexTaskExecutionSpec execution_spec block.
trigger_spec DataplexTaskTriggerSpec trigger_spec block.
description str User-provided description of the task.
display_name str User friendly display name.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#id DataplexTask#id}.
labels typing.Mapping[str] User-defined labels for the task.
lake str The lake in which the task will be created in.
location str The location in which the task will be created in.
notebook DataplexTaskNotebook notebook block.
project str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#project DataplexTask#project}.
spark DataplexTaskSpark spark block.
task_id str The task Id of the task.
timeouts DataplexTaskTimeouts timeouts block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
execution_specRequired 
execution_spec: DataplexTaskExecutionSpec

execution_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#execution_spec DataplexTask#execution_spec}

trigger_specRequired 
trigger_spec: DataplexTaskTriggerSpec

trigger_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#trigger_spec DataplexTask#trigger_spec}

descriptionOptional 
description: str
  • Type: str

User-provided description of the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#description DataplexTask#description}

display_nameOptional 
display_name: str
  • Type: str

User friendly display name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#display_name DataplexTask#display_name}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#id DataplexTask#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

labelsOptional 
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

User-defined labels for the task.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#labels DataplexTask#labels}

lakeOptional 
lake: str
  • Type: str

The lake in which the task will be created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#lake DataplexTask#lake}

locationOptional 
location: str
  • Type: str

The location in which the task will be created in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#location DataplexTask#location}

notebookOptional 
notebook: DataplexTaskNotebook

notebook block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#notebook DataplexTask#notebook}

projectOptional 
project: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#project DataplexTask#project}.

sparkOptional 
spark: DataplexTaskSpark

spark block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#spark DataplexTask#spark}

task_idOptional 
task_id: str
  • Type: str

The task Id of the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#task_id DataplexTask#task_id}

timeoutsOptional 
timeouts: DataplexTaskTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#timeouts DataplexTask#timeouts}

DataplexTaskExecutionSpec

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionSpec(
  service_account: str,
  args: typing.Mapping[str] = None,
  kms_key: str = None,
  max_job_execution_lifetime: str = None,
  project: str = None
)

Properties

Name Type Description
service_account str Service account to use to execute a task.
args typing.Mapping[str] The arguments to pass to the task.
kms_key str The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{locationId}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.
max_job_execution_lifetime str The maximum duration after which the job execution is expired.
project str The project in which jobs are run.
service_accountRequired 
service_account: str
  • Type: str

Service account to use to execute a task.

If not provided, the default Compute service account for the project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#service_account DataplexTask#service_account}

argsOptional 
args: typing.Mapping[str]
  • Type: typing.Mapping[str]

The arguments to pass to the task.

The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${taskId} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument. An object containing a list of 'key': value pairs. Example: { 'name': 'wrench', 'mass': '1.3kg', 'count': '3' }.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#args DataplexTask#args}

kms_keyOptional 
kms_key: str
  • Type: str

The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{locationId}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#kms_key DataplexTask#kms_key}

max_job_execution_lifetimeOptional 
max_job_execution_lifetime: str
  • Type: str

The maximum duration after which the job execution is expired.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: '3.5s'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_job_execution_lifetime DataplexTask#max_job_execution_lifetime}

projectOptional 
project: str
  • Type: str

The project in which jobs are run.

By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#project DataplexTask#project}

DataplexTaskExecutionStatus

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionStatus()

DataplexTaskExecutionStatusLatestJob

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionStatusLatestJob()

DataplexTaskNotebook

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebook(
  notebook: str,
  archive_uris: typing.List[str] = None,
  file_uris: typing.List[str] = None,
  infrastructure_spec: DataplexTaskNotebookInfrastructureSpec = None
)

Properties

Name Type Description
notebook str Path to input notebook.
archive_uris typing.List[str] Cloud Storage URIs of archives to be extracted into the working directory of each executor.
file_uris typing.List[str] Cloud Storage URIs of files to be placed in the working directory of each executor.
infrastructure_spec DataplexTaskNotebookInfrastructureSpec infrastructure_spec block.
notebookRequired 
notebook: str
  • Type: str

Path to input notebook.

This can be the Cloud Storage URI of the notebook file or the path to a Notebook Content. The execution args are accessible as environment variables (TASK_key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#notebook DataplexTask#notebook}

archive_urisOptional 
archive_uris: typing.List[str]
  • Type: typing.List[str]

Cloud Storage URIs of archives to be extracted into the working directory of each executor.

Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#archive_uris DataplexTask#archive_uris}

file_urisOptional 
file_uris: typing.List[str]
  • Type: typing.List[str]

Cloud Storage URIs of files to be placed in the working directory of each executor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#file_uris DataplexTask#file_uris}

infrastructure_specOptional 
infrastructure_spec: DataplexTaskNotebookInfrastructureSpec

infrastructure_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#infrastructure_spec DataplexTask#infrastructure_spec}

DataplexTaskNotebookInfrastructureSpec

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpec(
  batch: DataplexTaskNotebookInfrastructureSpecBatch = None,
  container_image: DataplexTaskNotebookInfrastructureSpecContainerImage = None,
  vpc_network: DataplexTaskNotebookInfrastructureSpecVpcNetwork = None
)

Properties

Name Type Description
batch DataplexTaskNotebookInfrastructureSpecBatch batch block.
container_image DataplexTaskNotebookInfrastructureSpecContainerImage container_image block.
vpc_network DataplexTaskNotebookInfrastructureSpecVpcNetwork vpc_network block.
batchOptional 
batch: DataplexTaskNotebookInfrastructureSpecBatch

batch block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#batch DataplexTask#batch}

container_imageOptional 
container_image: DataplexTaskNotebookInfrastructureSpecContainerImage

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#container_image DataplexTask#container_image}

vpc_networkOptional 
vpc_network: DataplexTaskNotebookInfrastructureSpecVpcNetwork

vpc_network block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#vpc_network DataplexTask#vpc_network}

DataplexTaskNotebookInfrastructureSpecBatch

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpecBatch(
  executors_count: typing.Union[int, float] = None,
  max_executors_count: typing.Union[int, float] = None
)

Properties

Name Type Description
executors_count typing.Union[int, float] Total number of job executors. Executor Count should be between 2 and 100. [Default=2].
max_executors_count typing.Union[int, float] Max configurable executors.
executors_countOptional 
executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

Total number of job executors. Executor Count should be between 2 and 100. [Default=2].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#executors_count DataplexTask#executors_count}

max_executors_countOptional 
max_executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

Max configurable executors.

If maxExecutorsCount > executorsCount, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. [Default=1000]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_executors_count DataplexTask#max_executors_count}

DataplexTaskNotebookInfrastructureSpecContainerImage

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpecContainerImage(
  image: str = None,
  java_jars: typing.List[str] = None,
  properties: typing.Mapping[str] = None,
  python_packages: typing.List[str] = None
)

Properties

Name Type Description
image str Container image to use.
java_jars typing.List[str] A list of Java JARS to add to the classpath.
properties typing.Mapping[str] Override to common configuration of open source components installed on the Dataproc cluster.
python_packages typing.List[str] A list of python packages to be installed.
imageOptional 
image: str
  • Type: str

Container image to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#image DataplexTask#image}

java_jarsOptional 
java_jars: typing.List[str]
  • Type: typing.List[str]

A list of Java JARS to add to the classpath.

Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#java_jars DataplexTask#java_jars}

propertiesOptional 
properties: typing.Mapping[str]
  • Type: typing.Mapping[str]

Override to common configuration of open source components installed on the Dataproc cluster.

The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. For more information, see Cluster properties.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#properties DataplexTask#properties}

python_packagesOptional 
python_packages: typing.List[str]
  • Type: typing.List[str]

A list of python packages to be installed.

Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#python_packages DataplexTask#python_packages}

DataplexTaskNotebookInfrastructureSpecVpcNetwork

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpecVpcNetwork(
  network: str = None,
  network_tags: typing.List[str] = None,
  sub_network: str = None
)

Properties

Name Type Description
network str The Cloud VPC network in which the job is run.
network_tags typing.List[str] List of network tags to apply to the job.
sub_network str The Cloud VPC sub-network in which the job is run.
networkOptional 
network: str
  • Type: str

The Cloud VPC network in which the job is run.

By default, the Cloud VPC network named Default within the project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network DataplexTask#network}

network_tagsOptional 
network_tags: typing.List[str]
  • Type: typing.List[str]

List of network tags to apply to the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network_tags DataplexTask#network_tags}

sub_networkOptional 
sub_network: str
  • Type: str

The Cloud VPC sub-network in which the job is run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sub_network DataplexTask#sub_network}

DataplexTaskSpark

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSpark(
  archive_uris: typing.List[str] = None,
  file_uris: typing.List[str] = None,
  infrastructure_spec: DataplexTaskSparkInfrastructureSpec = None,
  main_class: str = None,
  main_jar_file_uri: str = None,
  python_script_file: str = None,
  sql_script: str = None,
  sql_script_file: str = None
)

Properties

Name Type Description
archive_uris typing.List[str] Cloud Storage URIs of archives to be extracted into the working directory of each executor.
file_uris typing.List[str] Cloud Storage URIs of files to be placed in the working directory of each executor.
infrastructure_spec DataplexTaskSparkInfrastructureSpec infrastructure_spec block.
main_class str The name of the driver's main class.
main_jar_file_uri str The Cloud Storage URI of the jar file that contains the main class.
python_script_file str The Gcloud Storage URI of the main Python file to use as the driver.
sql_script str The query text. The execution args are used to declare a set of script variables (set key='value';).
sql_script_file str A reference to a query file.
archive_urisOptional 
archive_uris: typing.List[str]
  • Type: typing.List[str]

Cloud Storage URIs of archives to be extracted into the working directory of each executor.

Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#archive_uris DataplexTask#archive_uris}

file_urisOptional 
file_uris: typing.List[str]
  • Type: typing.List[str]

Cloud Storage URIs of files to be placed in the working directory of each executor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#file_uris DataplexTask#file_uris}

infrastructure_specOptional 
infrastructure_spec: DataplexTaskSparkInfrastructureSpec

infrastructure_spec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#infrastructure_spec DataplexTask#infrastructure_spec}

main_classOptional 
main_class: str
  • Type: str

The name of the driver's main class.

The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris. The execution args are passed in as a sequence of named process arguments (--key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#main_class DataplexTask#main_class}

main_jar_file_uriOptional 
main_jar_file_uri: str
  • Type: str

The Cloud Storage URI of the jar file that contains the main class.

The execution args are passed in as a sequence of named process arguments (--key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#main_jar_file_uri DataplexTask#main_jar_file_uri}

python_script_fileOptional 
python_script_file: str
  • Type: str

The Gcloud Storage URI of the main Python file to use as the driver.

Must be a .py file. The execution args are passed in as a sequence of named process arguments (--key=value).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#python_script_file DataplexTask#python_script_file}

sql_scriptOptional 
sql_script: str
  • Type: str

The query text. The execution args are used to declare a set of script variables (set key='value';).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sql_script DataplexTask#sql_script}

sql_script_fileOptional 
sql_script_file: str
  • Type: str

A reference to a query file.

This can be the Cloud Storage URI of the query file or it can the path to a SqlScript Content. The execution args are used to declare a set of script variables (set key='value';).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sql_script_file DataplexTask#sql_script_file}

DataplexTaskSparkInfrastructureSpec

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpec(
  batch: DataplexTaskSparkInfrastructureSpecBatch = None,
  container_image: DataplexTaskSparkInfrastructureSpecContainerImage = None,
  vpc_network: DataplexTaskSparkInfrastructureSpecVpcNetwork = None
)

Properties

Name Type Description
batch DataplexTaskSparkInfrastructureSpecBatch batch block.
container_image DataplexTaskSparkInfrastructureSpecContainerImage container_image block.
vpc_network DataplexTaskSparkInfrastructureSpecVpcNetwork vpc_network block.
batchOptional 
batch: DataplexTaskSparkInfrastructureSpecBatch

batch block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#batch DataplexTask#batch}

container_imageOptional 
container_image: DataplexTaskSparkInfrastructureSpecContainerImage

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#container_image DataplexTask#container_image}

vpc_networkOptional 
vpc_network: DataplexTaskSparkInfrastructureSpecVpcNetwork

vpc_network block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#vpc_network DataplexTask#vpc_network}

DataplexTaskSparkInfrastructureSpecBatch

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpecBatch(
  executors_count: typing.Union[int, float] = None,
  max_executors_count: typing.Union[int, float] = None
)

Properties

Name Type Description
executors_count typing.Union[int, float] Total number of job executors. Executor Count should be between 2 and 100. [Default=2].
max_executors_count typing.Union[int, float] Max configurable executors.
executors_countOptional 
executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

Total number of job executors. Executor Count should be between 2 and 100. [Default=2].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#executors_count DataplexTask#executors_count}

max_executors_countOptional 
max_executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]

Max configurable executors.

If maxExecutorsCount > executorsCount, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. [Default=1000]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_executors_count DataplexTask#max_executors_count}

DataplexTaskSparkInfrastructureSpecContainerImage

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpecContainerImage(
  image: str = None,
  java_jars: typing.List[str] = None,
  properties: typing.Mapping[str] = None,
  python_packages: typing.List[str] = None
)

Properties

Name Type Description
image str Container image to use.
java_jars typing.List[str] A list of Java JARS to add to the classpath.
properties typing.Mapping[str] Override to common configuration of open source components installed on the Dataproc cluster.
python_packages typing.List[str] A list of python packages to be installed.
imageOptional 
image: str
  • Type: str

Container image to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#image DataplexTask#image}

java_jarsOptional 
java_jars: typing.List[str]
  • Type: typing.List[str]

A list of Java JARS to add to the classpath.

Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#java_jars DataplexTask#java_jars}

propertiesOptional 
properties: typing.Mapping[str]
  • Type: typing.Mapping[str]

Override to common configuration of open source components installed on the Dataproc cluster.

The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. For more information, see Cluster properties.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#properties DataplexTask#properties}

python_packagesOptional 
python_packages: typing.List[str]
  • Type: typing.List[str]

A list of python packages to be installed.

Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#python_packages DataplexTask#python_packages}

DataplexTaskSparkInfrastructureSpecVpcNetwork

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpecVpcNetwork(
  network: str = None,
  network_tags: typing.List[str] = None,
  sub_network: str = None
)

Properties

Name Type Description
network str The Cloud VPC network in which the job is run.
network_tags typing.List[str] List of network tags to apply to the job.
sub_network str The Cloud VPC sub-network in which the job is run.
networkOptional 
network: str
  • Type: str

The Cloud VPC network in which the job is run.

By default, the Cloud VPC network named Default within the project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network DataplexTask#network}

network_tagsOptional 
network_tags: typing.List[str]
  • Type: typing.List[str]

List of network tags to apply to the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network_tags DataplexTask#network_tags}

sub_networkOptional 
sub_network: str
  • Type: str

The Cloud VPC sub-network in which the job is run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sub_network DataplexTask#sub_network}

DataplexTaskTimeouts

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#create DataplexTask#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#delete DataplexTask#delete}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#update DataplexTask#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#create DataplexTask#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#delete DataplexTask#delete}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#update DataplexTask#update}.

DataplexTaskTriggerSpec

Initializer 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskTriggerSpec(
  type: str,
  disabled: typing.Union[bool, IResolvable] = None,
  max_retries: typing.Union[int, float] = None,
  schedule: str = None,
  start_time: str = None
)

Properties

Name Type Description
type str Trigger type of the user-specified Task Possible values: ["ON_DEMAND", "RECURRING"].
disabled typing.Union[bool, cdktf.IResolvable] Prevent the task from executing.
max_retries typing.Union[int, float] Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
schedule str Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.
start_time str The first run of the task will be after this time.
typeRequired 
type: str
  • Type: str

Trigger type of the user-specified Task Possible values: ["ON_DEMAND", "RECURRING"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#type DataplexTask#type}

disabledOptional 
disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Prevent the task from executing.

This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#disabled DataplexTask#disabled}

max_retriesOptional 
max_retries: typing.Union[int, float]
  • Type: typing.Union[int, float]

Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_retries DataplexTask#max_retries}

scheduleOptional 
schedule: str
  • Type: str

Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#schedule DataplexTask#schedule}

start_timeOptional 
start_time: str
  • Type: str

The first run of the task will be after this time.

If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#start_time DataplexTask#start_time}

Classes

DataplexTaskExecutionSpecOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionSpecOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_args No description.
reset_kms_key No description.
reset_max_job_execution_lifetime No description.
reset_project No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_args 
def reset_args() -> None
reset_kms_key 
def reset_kms_key() -> None
reset_max_job_execution_lifetime 
def reset_max_job_execution_lifetime() -> None
reset_project 
def reset_project() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
args_input typing.Mapping[str] No description.
kms_key_input str No description.
max_job_execution_lifetime_input str No description.
project_input str No description.
service_account_input str No description.
args typing.Mapping[str] No description.
kms_key str No description.
max_job_execution_lifetime str No description.
project str No description.
service_account str No description.
internal_value DataplexTaskExecutionSpec No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
args_inputOptional 
args_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
kms_key_inputOptional 
kms_key_input: str
  • Type: str
max_job_execution_lifetime_inputOptional 
max_job_execution_lifetime_input: str
  • Type: str
project_inputOptional 
project_input: str
  • Type: str
service_account_inputOptional 
service_account_input: str
  • Type: str
argsRequired 
args: typing.Mapping[str]
  • Type: typing.Mapping[str]
kms_keyRequired 
kms_key: str
  • Type: str
max_job_execution_lifetimeRequired 
max_job_execution_lifetime: str
  • Type: str
projectRequired 
project: str
  • Type: str
service_accountRequired 
service_account: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskExecutionSpec

DataplexTaskExecutionStatusLatestJobList

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionStatusLatestJobList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> DataplexTaskExecutionStatusLatestJobOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str

DataplexTaskExecutionStatusLatestJobOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionStatusLatestJobOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
end_time str No description.
message str No description.
name str No description.
retry_count typing.Union[int, float] No description.
service str No description.
service_job str No description.
start_time str No description.
state str No description.
uid str No description.
internal_value DataplexTaskExecutionStatusLatestJob No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
end_timeRequired 
end_time: str
  • Type: str
messageRequired 
message: str
  • Type: str
nameRequired 
name: str
  • Type: str
retry_countRequired 
retry_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
serviceRequired 
service: str
  • Type: str
service_jobRequired 
service_job: str
  • Type: str
start_timeRequired 
start_time: str
  • Type: str
stateRequired 
state: str
  • Type: str
uidRequired 
uid: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskExecutionStatusLatestJob

DataplexTaskExecutionStatusList

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionStatusList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> DataplexTaskExecutionStatusOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str

DataplexTaskExecutionStatusOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskExecutionStatusOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
latest_job DataplexTaskExecutionStatusLatestJobList No description.
update_time str No description.
internal_value DataplexTaskExecutionStatus No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
latest_jobRequired 
latest_job: DataplexTaskExecutionStatusLatestJobList
update_timeRequired 
update_time: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskExecutionStatus

DataplexTaskNotebookInfrastructureSpecBatchOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpecBatchOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_executors_count No description.
reset_max_executors_count No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_executors_count 
def reset_executors_count() -> None
reset_max_executors_count 
def reset_max_executors_count() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
executors_count_input typing.Union[int, float] No description.
max_executors_count_input typing.Union[int, float] No description.
executors_count typing.Union[int, float] No description.
max_executors_count typing.Union[int, float] No description.
internal_value DataplexTaskNotebookInfrastructureSpecBatch No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
executors_count_inputOptional 
executors_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_executors_count_inputOptional 
max_executors_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
executors_countRequired 
executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_executors_countRequired 
max_executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
internal_valueOptional 
internal_value: DataplexTaskNotebookInfrastructureSpecBatch

DataplexTaskNotebookInfrastructureSpecContainerImageOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpecContainerImageOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_image No description.
reset_java_jars No description.
reset_properties No description.
reset_python_packages No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_image 
def reset_image() -> None
reset_java_jars 
def reset_java_jars() -> None
reset_properties 
def reset_properties() -> None
reset_python_packages 
def reset_python_packages() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
image_input str No description.
java_jars_input typing.List[str] No description.
properties_input typing.Mapping[str] No description.
python_packages_input typing.List[str] No description.
image str No description.
java_jars typing.List[str] No description.
properties typing.Mapping[str] No description.
python_packages typing.List[str] No description.
internal_value DataplexTaskNotebookInfrastructureSpecContainerImage No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
image_inputOptional 
image_input: str
  • Type: str
java_jars_inputOptional 
java_jars_input: typing.List[str]
  • Type: typing.List[str]
properties_inputOptional 
properties_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
python_packages_inputOptional 
python_packages_input: typing.List[str]
  • Type: typing.List[str]
imageRequired 
image: str
  • Type: str
java_jarsRequired 
java_jars: typing.List[str]
  • Type: typing.List[str]
propertiesRequired 
properties: typing.Mapping[str]
  • Type: typing.Mapping[str]
python_packagesRequired 
python_packages: typing.List[str]
  • Type: typing.List[str]
internal_valueOptional 
internal_value: DataplexTaskNotebookInfrastructureSpecContainerImage

DataplexTaskNotebookInfrastructureSpecOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpecOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_batch No description.
put_container_image No description.
put_vpc_network No description.
reset_batch No description.
reset_container_image No description.
reset_vpc_network No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_batch 
def put_batch(
  executors_count: typing.Union[int, float] = None,
  max_executors_count: typing.Union[int, float] = None
) -> None
executors_countOptional
  • Type: typing.Union[int, float]

Total number of job executors. Executor Count should be between 2 and 100. [Default=2].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#executors_count DataplexTask#executors_count}

max_executors_countOptional
  • Type: typing.Union[int, float]

Max configurable executors.

If maxExecutorsCount > executorsCount, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. [Default=1000]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_executors_count DataplexTask#max_executors_count}

put_container_image 
def put_container_image(
  image: str = None,
  java_jars: typing.List[str] = None,
  properties: typing.Mapping[str] = None,
  python_packages: typing.List[str] = None
) -> None
imageOptional
  • Type: str

Container image to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#image DataplexTask#image}

java_jarsOptional
  • Type: typing.List[str]

A list of Java JARS to add to the classpath.

Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#java_jars DataplexTask#java_jars}

propertiesOptional
  • Type: typing.Mapping[str]

Override to common configuration of open source components installed on the Dataproc cluster.

The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. For more information, see Cluster properties.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#properties DataplexTask#properties}

python_packagesOptional
  • Type: typing.List[str]

A list of python packages to be installed.

Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#python_packages DataplexTask#python_packages}

put_vpc_network 
def put_vpc_network(
  network: str = None,
  network_tags: typing.List[str] = None,
  sub_network: str = None
) -> None
networkOptional
  • Type: str

The Cloud VPC network in which the job is run.

By default, the Cloud VPC network named Default within the project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network DataplexTask#network}

network_tagsOptional
  • Type: typing.List[str]

List of network tags to apply to the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network_tags DataplexTask#network_tags}

sub_networkOptional
  • Type: str

The Cloud VPC sub-network in which the job is run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sub_network DataplexTask#sub_network}

reset_batch 
def reset_batch() -> None
reset_container_image 
def reset_container_image() -> None
reset_vpc_network 
def reset_vpc_network() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
batch DataplexTaskNotebookInfrastructureSpecBatchOutputReference No description.
container_image DataplexTaskNotebookInfrastructureSpecContainerImageOutputReference No description.
vpc_network DataplexTaskNotebookInfrastructureSpecVpcNetworkOutputReference No description.
batch_input DataplexTaskNotebookInfrastructureSpecBatch No description.
container_image_input DataplexTaskNotebookInfrastructureSpecContainerImage No description.
vpc_network_input DataplexTaskNotebookInfrastructureSpecVpcNetwork No description.
internal_value DataplexTaskNotebookInfrastructureSpec No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
batchRequired 
batch: DataplexTaskNotebookInfrastructureSpecBatchOutputReference
container_imageRequired 
container_image: DataplexTaskNotebookInfrastructureSpecContainerImageOutputReference
vpc_networkRequired 
vpc_network: DataplexTaskNotebookInfrastructureSpecVpcNetworkOutputReference
batch_inputOptional 
batch_input: DataplexTaskNotebookInfrastructureSpecBatch
container_image_inputOptional 
container_image_input: DataplexTaskNotebookInfrastructureSpecContainerImage
vpc_network_inputOptional 
vpc_network_input: DataplexTaskNotebookInfrastructureSpecVpcNetwork
internal_valueOptional 
internal_value: DataplexTaskNotebookInfrastructureSpec

DataplexTaskNotebookInfrastructureSpecVpcNetworkOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookInfrastructureSpecVpcNetworkOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_network No description.
reset_network_tags No description.
reset_sub_network No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_network 
def reset_network() -> None
reset_network_tags 
def reset_network_tags() -> None
reset_sub_network 
def reset_sub_network() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
network_input str No description.
network_tags_input typing.List[str] No description.
sub_network_input str No description.
network str No description.
network_tags typing.List[str] No description.
sub_network str No description.
internal_value DataplexTaskNotebookInfrastructureSpecVpcNetwork No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
network_inputOptional 
network_input: str
  • Type: str
network_tags_inputOptional 
network_tags_input: typing.List[str]
  • Type: typing.List[str]
sub_network_inputOptional 
sub_network_input: str
  • Type: str
networkRequired 
network: str
  • Type: str
network_tagsRequired 
network_tags: typing.List[str]
  • Type: typing.List[str]
sub_networkRequired 
sub_network: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskNotebookInfrastructureSpecVpcNetwork

DataplexTaskNotebookOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskNotebookOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_infrastructure_spec No description.
reset_archive_uris No description.
reset_file_uris No description.
reset_infrastructure_spec No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_infrastructure_spec 
def put_infrastructure_spec(
  batch: DataplexTaskNotebookInfrastructureSpecBatch = None,
  container_image: DataplexTaskNotebookInfrastructureSpecContainerImage = None,
  vpc_network: DataplexTaskNotebookInfrastructureSpecVpcNetwork = None
) -> None
batchOptional

batch block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#batch DataplexTask#batch}

container_imageOptional

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#container_image DataplexTask#container_image}

vpc_networkOptional

vpc_network block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#vpc_network DataplexTask#vpc_network}

reset_archive_uris 
def reset_archive_uris() -> None
reset_file_uris 
def reset_file_uris() -> None
reset_infrastructure_spec 
def reset_infrastructure_spec() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
infrastructure_spec DataplexTaskNotebookInfrastructureSpecOutputReference No description.
archive_uris_input typing.List[str] No description.
file_uris_input typing.List[str] No description.
infrastructure_spec_input DataplexTaskNotebookInfrastructureSpec No description.
notebook_input str No description.
archive_uris typing.List[str] No description.
file_uris typing.List[str] No description.
notebook str No description.
internal_value DataplexTaskNotebook No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
infrastructure_specRequired 
infrastructure_spec: DataplexTaskNotebookInfrastructureSpecOutputReference
archive_uris_inputOptional 
archive_uris_input: typing.List[str]
  • Type: typing.List[str]
file_uris_inputOptional 
file_uris_input: typing.List[str]
  • Type: typing.List[str]
infrastructure_spec_inputOptional 
infrastructure_spec_input: DataplexTaskNotebookInfrastructureSpec
notebook_inputOptional 
notebook_input: str
  • Type: str
archive_urisRequired 
archive_uris: typing.List[str]
  • Type: typing.List[str]
file_urisRequired 
file_uris: typing.List[str]
  • Type: typing.List[str]
notebookRequired 
notebook: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskNotebook

DataplexTaskSparkInfrastructureSpecBatchOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpecBatchOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_executors_count No description.
reset_max_executors_count No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_executors_count 
def reset_executors_count() -> None
reset_max_executors_count 
def reset_max_executors_count() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
executors_count_input typing.Union[int, float] No description.
max_executors_count_input typing.Union[int, float] No description.
executors_count typing.Union[int, float] No description.
max_executors_count typing.Union[int, float] No description.
internal_value DataplexTaskSparkInfrastructureSpecBatch No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
executors_count_inputOptional 
executors_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_executors_count_inputOptional 
max_executors_count_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
executors_countRequired 
executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
max_executors_countRequired 
max_executors_count: typing.Union[int, float]
  • Type: typing.Union[int, float]
internal_valueOptional 
internal_value: DataplexTaskSparkInfrastructureSpecBatch

DataplexTaskSparkInfrastructureSpecContainerImageOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpecContainerImageOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_image No description.
reset_java_jars No description.
reset_properties No description.
reset_python_packages No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_image 
def reset_image() -> None
reset_java_jars 
def reset_java_jars() -> None
reset_properties 
def reset_properties() -> None
reset_python_packages 
def reset_python_packages() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
image_input str No description.
java_jars_input typing.List[str] No description.
properties_input typing.Mapping[str] No description.
python_packages_input typing.List[str] No description.
image str No description.
java_jars typing.List[str] No description.
properties typing.Mapping[str] No description.
python_packages typing.List[str] No description.
internal_value DataplexTaskSparkInfrastructureSpecContainerImage No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
image_inputOptional 
image_input: str
  • Type: str
java_jars_inputOptional 
java_jars_input: typing.List[str]
  • Type: typing.List[str]
properties_inputOptional 
properties_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
python_packages_inputOptional 
python_packages_input: typing.List[str]
  • Type: typing.List[str]
imageRequired 
image: str
  • Type: str
java_jarsRequired 
java_jars: typing.List[str]
  • Type: typing.List[str]
propertiesRequired 
properties: typing.Mapping[str]
  • Type: typing.Mapping[str]
python_packagesRequired 
python_packages: typing.List[str]
  • Type: typing.List[str]
internal_valueOptional 
internal_value: DataplexTaskSparkInfrastructureSpecContainerImage

DataplexTaskSparkInfrastructureSpecOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpecOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_batch No description.
put_container_image No description.
put_vpc_network No description.
reset_batch No description.
reset_container_image No description.
reset_vpc_network No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_batch 
def put_batch(
  executors_count: typing.Union[int, float] = None,
  max_executors_count: typing.Union[int, float] = None
) -> None
executors_countOptional
  • Type: typing.Union[int, float]

Total number of job executors. Executor Count should be between 2 and 100. [Default=2].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#executors_count DataplexTask#executors_count}

max_executors_countOptional
  • Type: typing.Union[int, float]

Max configurable executors.

If maxExecutorsCount > executorsCount, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. [Default=1000]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#max_executors_count DataplexTask#max_executors_count}

put_container_image 
def put_container_image(
  image: str = None,
  java_jars: typing.List[str] = None,
  properties: typing.Mapping[str] = None,
  python_packages: typing.List[str] = None
) -> None
imageOptional
  • Type: str

Container image to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#image DataplexTask#image}

java_jarsOptional
  • Type: typing.List[str]

A list of Java JARS to add to the classpath.

Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#java_jars DataplexTask#java_jars}

propertiesOptional
  • Type: typing.Mapping[str]

Override to common configuration of open source components installed on the Dataproc cluster.

The properties to set on daemon config files. Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. For more information, see Cluster properties.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#properties DataplexTask#properties}

python_packagesOptional
  • Type: typing.List[str]

A list of python packages to be installed.

Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#python_packages DataplexTask#python_packages}

put_vpc_network 
def put_vpc_network(
  network: str = None,
  network_tags: typing.List[str] = None,
  sub_network: str = None
) -> None
networkOptional
  • Type: str

The Cloud VPC network in which the job is run.

By default, the Cloud VPC network named Default within the project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network DataplexTask#network}

network_tagsOptional
  • Type: typing.List[str]

List of network tags to apply to the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#network_tags DataplexTask#network_tags}

sub_networkOptional
  • Type: str

The Cloud VPC sub-network in which the job is run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#sub_network DataplexTask#sub_network}

reset_batch 
def reset_batch() -> None
reset_container_image 
def reset_container_image() -> None
reset_vpc_network 
def reset_vpc_network() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
batch DataplexTaskSparkInfrastructureSpecBatchOutputReference No description.
container_image DataplexTaskSparkInfrastructureSpecContainerImageOutputReference No description.
vpc_network DataplexTaskSparkInfrastructureSpecVpcNetworkOutputReference No description.
batch_input DataplexTaskSparkInfrastructureSpecBatch No description.
container_image_input DataplexTaskSparkInfrastructureSpecContainerImage No description.
vpc_network_input DataplexTaskSparkInfrastructureSpecVpcNetwork No description.
internal_value DataplexTaskSparkInfrastructureSpec No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
batchRequired 
batch: DataplexTaskSparkInfrastructureSpecBatchOutputReference
container_imageRequired 
container_image: DataplexTaskSparkInfrastructureSpecContainerImageOutputReference
vpc_networkRequired 
vpc_network: DataplexTaskSparkInfrastructureSpecVpcNetworkOutputReference
batch_inputOptional 
batch_input: DataplexTaskSparkInfrastructureSpecBatch
container_image_inputOptional 
container_image_input: DataplexTaskSparkInfrastructureSpecContainerImage
vpc_network_inputOptional 
vpc_network_input: DataplexTaskSparkInfrastructureSpecVpcNetwork
internal_valueOptional 
internal_value: DataplexTaskSparkInfrastructureSpec

DataplexTaskSparkInfrastructureSpecVpcNetworkOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkInfrastructureSpecVpcNetworkOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_network No description.
reset_network_tags No description.
reset_sub_network No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_network 
def reset_network() -> None
reset_network_tags 
def reset_network_tags() -> None
reset_sub_network 
def reset_sub_network() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
network_input str No description.
network_tags_input typing.List[str] No description.
sub_network_input str No description.
network str No description.
network_tags typing.List[str] No description.
sub_network str No description.
internal_value DataplexTaskSparkInfrastructureSpecVpcNetwork No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
network_inputOptional 
network_input: str
  • Type: str
network_tags_inputOptional 
network_tags_input: typing.List[str]
  • Type: typing.List[str]
sub_network_inputOptional 
sub_network_input: str
  • Type: str
networkRequired 
network: str
  • Type: str
network_tagsRequired 
network_tags: typing.List[str]
  • Type: typing.List[str]
sub_networkRequired 
sub_network: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskSparkInfrastructureSpecVpcNetwork

DataplexTaskSparkOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskSparkOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_infrastructure_spec No description.
reset_archive_uris No description.
reset_file_uris No description.
reset_infrastructure_spec No description.
reset_main_class No description.
reset_main_jar_file_uri No description.
reset_python_script_file No description.
reset_sql_script No description.
reset_sql_script_file No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_infrastructure_spec 
def put_infrastructure_spec(
  batch: DataplexTaskSparkInfrastructureSpecBatch = None,
  container_image: DataplexTaskSparkInfrastructureSpecContainerImage = None,
  vpc_network: DataplexTaskSparkInfrastructureSpecVpcNetwork = None
) -> None
batchOptional

batch block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#batch DataplexTask#batch}

container_imageOptional

container_image block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#container_image DataplexTask#container_image}

vpc_networkOptional

vpc_network block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.37.0/docs/resources/dataplex_task#vpc_network DataplexTask#vpc_network}

reset_archive_uris 
def reset_archive_uris() -> None
reset_file_uris 
def reset_file_uris() -> None
reset_infrastructure_spec 
def reset_infrastructure_spec() -> None
reset_main_class 
def reset_main_class() -> None
reset_main_jar_file_uri 
def reset_main_jar_file_uri() -> None
reset_python_script_file 
def reset_python_script_file() -> None
reset_sql_script 
def reset_sql_script() -> None
reset_sql_script_file 
def reset_sql_script_file() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
infrastructure_spec DataplexTaskSparkInfrastructureSpecOutputReference No description.
archive_uris_input typing.List[str] No description.
file_uris_input typing.List[str] No description.
infrastructure_spec_input DataplexTaskSparkInfrastructureSpec No description.
main_class_input str No description.
main_jar_file_uri_input str No description.
python_script_file_input str No description.
sql_script_file_input str No description.
sql_script_input str No description.
archive_uris typing.List[str] No description.
file_uris typing.List[str] No description.
main_class str No description.
main_jar_file_uri str No description.
python_script_file str No description.
sql_script str No description.
sql_script_file str No description.
internal_value DataplexTaskSpark No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
infrastructure_specRequired 
infrastructure_spec: DataplexTaskSparkInfrastructureSpecOutputReference
archive_uris_inputOptional 
archive_uris_input: typing.List[str]
  • Type: typing.List[str]
file_uris_inputOptional 
file_uris_input: typing.List[str]
  • Type: typing.List[str]
infrastructure_spec_inputOptional 
infrastructure_spec_input: DataplexTaskSparkInfrastructureSpec
main_class_inputOptional 
main_class_input: str
  • Type: str
main_jar_file_uri_inputOptional 
main_jar_file_uri_input: str
  • Type: str
python_script_file_inputOptional 
python_script_file_input: str
  • Type: str
sql_script_file_inputOptional 
sql_script_file_input: str
  • Type: str
sql_script_inputOptional 
sql_script_input: str
  • Type: str
archive_urisRequired 
archive_uris: typing.List[str]
  • Type: typing.List[str]
file_urisRequired 
file_uris: typing.List[str]
  • Type: typing.List[str]
main_classRequired 
main_class: str
  • Type: str
main_jar_file_uriRequired 
main_jar_file_uri: str
  • Type: str
python_script_fileRequired 
python_script_file: str
  • Type: str
sql_scriptRequired 
sql_script: str
  • Type: str
sql_script_fileRequired 
sql_script_file: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskSpark

DataplexTaskTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
update_input str No description.
create str No description.
delete str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, DataplexTaskTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, DataplexTaskTimeouts]

DataplexTaskTriggerSpecOutputReference

Initializers 

from cdktf_cdktf_provider_google import dataplex_task

dataplexTask.DataplexTaskTriggerSpecOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_disabled No description.
reset_max_retries No description.
reset_schedule No description.
reset_start_time No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_disabled 
def reset_disabled() -> None
reset_max_retries 
def reset_max_retries() -> None
reset_schedule 
def reset_schedule() -> None
reset_start_time 
def reset_start_time() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
disabled_input typing.Union[bool, cdktf.IResolvable] No description.
max_retries_input typing.Union[int, float] No description.
schedule_input str No description.
start_time_input str No description.
type_input str No description.
disabled typing.Union[bool, cdktf.IResolvable] No description.
max_retries typing.Union[int, float] No description.
schedule str No description.
start_time str No description.
type str No description.
internal_value DataplexTaskTriggerSpec No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
disabled_inputOptional 
disabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
max_retries_inputOptional 
max_retries_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
schedule_inputOptional 
schedule_input: str
  • Type: str
start_time_inputOptional 
start_time_input: str
  • Type: str
type_inputOptional 
type_input: str
  • Type: str
disabledRequired 
disabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
max_retriesRequired 
max_retries: typing.Union[int, float]
  • Type: typing.Union[int, float]
scheduleRequired 
schedule: str
  • Type: str
start_timeRequired 
start_time: str
  • Type: str
typeRequired 
type: str
  • Type: str
internal_valueOptional 
internal_value: DataplexTaskTriggerSpec