Skip to content

Latest commit

 

History

History
1795 lines (1122 loc) · 76.2 KB

task.java.md

File metadata and controls

1795 lines (1122 loc) · 76.2 KB
Raw

task Submodule

Constructs

Task

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task snowflake_task}.

Initializers 

import com.hashicorp.cdktf.providers.snowflake.task.Task;

Task.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .database(java.lang.String)
    .name(java.lang.String)
    .schema(java.lang.String)
    .sqlStatement(java.lang.String)
//  .after(java.util.List<java.lang.String>)
//  .allowOverlappingExecution(java.lang.Boolean)
//  .allowOverlappingExecution(IResolvable)
//  .comment(java.lang.String)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .errorIntegration(java.lang.String)
//  .id(java.lang.String)
//  .schedule(java.lang.String)
//  .sessionParameters(java.util.Map<java.lang.String, java.lang.String>)
//  .suspendTaskAfterNumFailures(java.lang.Number)
//  .userTaskManagedInitialWarehouseSize(java.lang.String)
//  .userTaskTimeoutMs(java.lang.Number)
//  .warehouse(java.lang.String)
//  .when(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
database java.lang.String The database in which to create the task.
name java.lang.String Specifies the identifier for the task;
schema java.lang.String The schema in which to create the task.
sqlStatement java.lang.String Any single SQL statement, or a call to a stored procedure, executed when the task runs.
after java.util.List<java.lang.String> Specifies one or more predecessor tasks for the current task.
allowOverlappingExecution java.lang.Boolean OR com.hashicorp.cdktf.IResolvable By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap.
comment java.lang.String Specifies a comment for the task.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the task should be started (enabled) after creation or should remain suspended (default).
errorIntegration java.lang.String Specifies the name of the notification integration used for error notifications.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#id Task#id}.
schedule java.lang.String The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflict with after).
sessionParameters java.util.Map<java.lang.String, java.lang.String> Specifies session parameters to set for the session when the task runs. A task supports all session parameters.
suspendTaskAfterNumFailures java.lang.Number Specifies the number of consecutive failed task runs after which the current task is suspended automatically.
userTaskManagedInitialWarehouseSize java.lang.String Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size.
userTaskTimeoutMs java.lang.Number Specifies the time limit on a single run of the task before it times out (in milliseconds).
warehouse java.lang.String The warehouse the task will use.
when java.lang.String Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
databaseRequired
  • Type: java.lang.String

The database in which to create the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#database Task#database}

nameRequired
  • Type: java.lang.String

Specifies the identifier for the task;

must be unique for the database and schema in which the task is created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#name Task#name}

schemaRequired
  • Type: java.lang.String

The schema in which to create the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#schema Task#schema}

sqlStatementRequired
  • Type: java.lang.String

Any single SQL statement, or a call to a stored procedure, executed when the task runs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#sql_statement Task#sql_statement}

afterOptional
  • Type: java.util.List<java.lang.String>

Specifies one or more predecessor tasks for the current task.

Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#after Task#after}

allowOverlappingExecutionOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#allow_overlapping_execution Task#allow_overlapping_execution}

commentOptional
  • Type: java.lang.String

Specifies a comment for the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#comment Task#comment}

enabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Specifies if the task should be started (enabled) after creation or should remain suspended (default).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#enabled Task#enabled}

errorIntegrationOptional
  • Type: java.lang.String

Specifies the name of the notification integration used for error notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#error_integration Task#error_integration}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#id Task#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.

scheduleOptional
  • Type: java.lang.String

The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflict with after).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#schedule Task#schedule}

sessionParametersOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Specifies session parameters to set for the session when the task runs. A task supports all session parameters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#session_parameters Task#session_parameters}

suspendTaskAfterNumFailuresOptional
  • Type: java.lang.Number

Specifies the number of consecutive failed task runs after which the current task is suspended automatically.

The default is 0 (no automatic suspension).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#suspend_task_after_num_failures Task#suspend_task_after_num_failures}

userTaskManagedInitialWarehouseSizeOptional
  • Type: java.lang.String

Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size.

Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. (Conflicts with warehouse)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#user_task_managed_initial_warehouse_size Task#user_task_managed_initial_warehouse_size}

userTaskTimeoutMsOptional
  • Type: java.lang.Number

Specifies the time limit on a single run of the task before it times out (in milliseconds).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#user_task_timeout_ms Task#user_task_timeout_ms}

warehouseOptional
  • Type: java.lang.String

The warehouse the task will use.

Omit this parameter to use Snowflake-managed compute resources for runs of this task. (Conflicts with user_task_managed_initial_warehouse_size)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#warehouse Task#warehouse}

whenOptional
  • Type: java.lang.String

Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#when Task#when}

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetAfter No description.
resetAllowOverlappingExecution No description.
resetComment No description.
resetEnabled No description.
resetErrorIntegration No description.
resetId No description.
resetSchedule No description.
resetSessionParameters No description.
resetSuspendTaskAfterNumFailures No description.
resetUserTaskManagedInitialWarehouseSize No description.
resetUserTaskTimeoutMs No description.
resetWarehouse No description.
resetWhen No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

resetAfter 
public void resetAfter()
resetAllowOverlappingExecution 
public void resetAllowOverlappingExecution()
resetComment 
public void resetComment()
resetEnabled 
public void resetEnabled()
resetErrorIntegration 
public void resetErrorIntegration()
resetId 
public void resetId()
resetSchedule 
public void resetSchedule()
resetSessionParameters 
public void resetSessionParameters()
resetSuspendTaskAfterNumFailures 
public void resetSuspendTaskAfterNumFailures()
resetUserTaskManagedInitialWarehouseSize 
public void resetUserTaskManagedInitialWarehouseSize()
resetUserTaskTimeoutMs 
public void resetUserTaskTimeoutMs()
resetWarehouse 
public void resetWarehouse()
resetWhen 
public void resetWhen()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Task resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.snowflake.task.Task;

Task.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.snowflake.task.Task;

Task.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.snowflake.task.Task;

Task.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.snowflake.task.Task;

Task.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Task.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing Task that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
afterInput java.util.List<java.lang.String> No description.
allowOverlappingExecutionInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
commentInput java.lang.String No description.
databaseInput java.lang.String No description.
enabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
errorIntegrationInput java.lang.String No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
scheduleInput java.lang.String No description.
schemaInput java.lang.String No description.
sessionParametersInput java.util.Map<java.lang.String, java.lang.String> No description.
sqlStatementInput java.lang.String No description.
suspendTaskAfterNumFailuresInput java.lang.Number No description.
userTaskManagedInitialWarehouseSizeInput java.lang.String No description.
userTaskTimeoutMsInput java.lang.Number No description.
warehouseInput java.lang.String No description.
whenInput java.lang.String No description.
after java.util.List<java.lang.String> No description.
allowOverlappingExecution java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
comment java.lang.String No description.
database java.lang.String No description.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
errorIntegration java.lang.String No description.
id java.lang.String No description.
name java.lang.String No description.
schedule java.lang.String No description.
schema java.lang.String No description.
sessionParameters java.util.Map<java.lang.String, java.lang.String> No description.
sqlStatement java.lang.String No description.
suspendTaskAfterNumFailures java.lang.Number No description.
userTaskManagedInitialWarehouseSize java.lang.String No description.
userTaskTimeoutMs java.lang.Number No description.
warehouse java.lang.String No description.
when java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
afterInputOptional 
public java.util.List<java.lang.String> getAfterInput();
  • Type: java.util.List<java.lang.String>
allowOverlappingExecutionInputOptional 
public java.lang.Object getAllowOverlappingExecutionInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
commentInputOptional 
public java.lang.String getCommentInput();
  • Type: java.lang.String
databaseInputOptional 
public java.lang.String getDatabaseInput();
  • Type: java.lang.String
enabledInputOptional 
public java.lang.Object getEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
errorIntegrationInputOptional 
public java.lang.String getErrorIntegrationInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
scheduleInputOptional 
public java.lang.String getScheduleInput();
  • Type: java.lang.String
schemaInputOptional 
public java.lang.String getSchemaInput();
  • Type: java.lang.String
sessionParametersInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getSessionParametersInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
sqlStatementInputOptional 
public java.lang.String getSqlStatementInput();
  • Type: java.lang.String
suspendTaskAfterNumFailuresInputOptional 
public java.lang.Number getSuspendTaskAfterNumFailuresInput();
  • Type: java.lang.Number
userTaskManagedInitialWarehouseSizeInputOptional 
public java.lang.String getUserTaskManagedInitialWarehouseSizeInput();
  • Type: java.lang.String
userTaskTimeoutMsInputOptional 
public java.lang.Number getUserTaskTimeoutMsInput();
  • Type: java.lang.Number
warehouseInputOptional 
public java.lang.String getWarehouseInput();
  • Type: java.lang.String
whenInputOptional 
public java.lang.String getWhenInput();
  • Type: java.lang.String
afterRequired 
public java.util.List<java.lang.String> getAfter();
  • Type: java.util.List<java.lang.String>
allowOverlappingExecutionRequired 
public java.lang.Object getAllowOverlappingExecution();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
commentRequired 
public java.lang.String getComment();
  • Type: java.lang.String
databaseRequired 
public java.lang.String getDatabase();
  • Type: java.lang.String
enabledRequired 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
errorIntegrationRequired 
public java.lang.String getErrorIntegration();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
scheduleRequired 
public java.lang.String getSchedule();
  • Type: java.lang.String
schemaRequired 
public java.lang.String getSchema();
  • Type: java.lang.String
sessionParametersRequired 
public java.util.Map<java.lang.String, java.lang.String> getSessionParameters();
  • Type: java.util.Map<java.lang.String, java.lang.String>
sqlStatementRequired 
public java.lang.String getSqlStatement();
  • Type: java.lang.String
suspendTaskAfterNumFailuresRequired 
public java.lang.Number getSuspendTaskAfterNumFailures();
  • Type: java.lang.Number
userTaskManagedInitialWarehouseSizeRequired 
public java.lang.String getUserTaskManagedInitialWarehouseSize();
  • Type: java.lang.String
userTaskTimeoutMsRequired 
public java.lang.Number getUserTaskTimeoutMs();
  • Type: java.lang.Number
warehouseRequired 
public java.lang.String getWarehouse();
  • Type: java.lang.String
whenRequired 
public java.lang.String getWhen();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

TaskConfig

Initializer 

import com.hashicorp.cdktf.providers.snowflake.task.TaskConfig;

TaskConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .database(java.lang.String)
    .name(java.lang.String)
    .schema(java.lang.String)
    .sqlStatement(java.lang.String)
//  .after(java.util.List<java.lang.String>)
//  .allowOverlappingExecution(java.lang.Boolean)
//  .allowOverlappingExecution(IResolvable)
//  .comment(java.lang.String)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .errorIntegration(java.lang.String)
//  .id(java.lang.String)
//  .schedule(java.lang.String)
//  .sessionParameters(java.util.Map<java.lang.String, java.lang.String>)
//  .suspendTaskAfterNumFailures(java.lang.Number)
//  .userTaskManagedInitialWarehouseSize(java.lang.String)
//  .userTaskTimeoutMs(java.lang.Number)
//  .warehouse(java.lang.String)
//  .when(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
database java.lang.String The database in which to create the task.
name java.lang.String Specifies the identifier for the task;
schema java.lang.String The schema in which to create the task.
sqlStatement java.lang.String Any single SQL statement, or a call to a stored procedure, executed when the task runs.
after java.util.List<java.lang.String> Specifies one or more predecessor tasks for the current task.
allowOverlappingExecution java.lang.Boolean OR com.hashicorp.cdktf.IResolvable By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap.
comment java.lang.String Specifies a comment for the task.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Specifies if the task should be started (enabled) after creation or should remain suspended (default).
errorIntegration java.lang.String Specifies the name of the notification integration used for error notifications.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#id Task#id}.
schedule java.lang.String The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflict with after).
sessionParameters java.util.Map<java.lang.String, java.lang.String> Specifies session parameters to set for the session when the task runs. A task supports all session parameters.
suspendTaskAfterNumFailures java.lang.Number Specifies the number of consecutive failed task runs after which the current task is suspended automatically.
userTaskManagedInitialWarehouseSize java.lang.String Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size.
userTaskTimeoutMs java.lang.Number Specifies the time limit on a single run of the task before it times out (in milliseconds).
warehouse java.lang.String The warehouse the task will use.
when java.lang.String Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
databaseRequired 
public java.lang.String getDatabase();
  • Type: java.lang.String

The database in which to create the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#database Task#database}

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Specifies the identifier for the task;

must be unique for the database and schema in which the task is created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#name Task#name}

schemaRequired 
public java.lang.String getSchema();
  • Type: java.lang.String

The schema in which to create the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#schema Task#schema}

sqlStatementRequired 
public java.lang.String getSqlStatement();
  • Type: java.lang.String

Any single SQL statement, or a call to a stored procedure, executed when the task runs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#sql_statement Task#sql_statement}

afterOptional 
public java.util.List<java.lang.String> getAfter();
  • Type: java.util.List<java.lang.String>

Specifies one or more predecessor tasks for the current task.

Use this option to create a DAG of tasks or add this task to an existing DAG. A DAG is a series of tasks that starts with a scheduled root task and is linked together by dependencies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#after Task#after}

allowOverlappingExecutionOptional 
public java.lang.Object getAllowOverlappingExecution();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

By default, Snowflake ensures that only one instance of a particular DAG is allowed to run at a time, setting the parameter value to TRUE permits DAG runs to overlap.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#allow_overlapping_execution Task#allow_overlapping_execution}

commentOptional 
public java.lang.String getComment();
  • Type: java.lang.String

Specifies a comment for the task.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#comment Task#comment}

enabledOptional 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Specifies if the task should be started (enabled) after creation or should remain suspended (default).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#enabled Task#enabled}

errorIntegrationOptional 
public java.lang.String getErrorIntegration();
  • Type: java.lang.String

Specifies the name of the notification integration used for error notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#error_integration Task#error_integration}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#id Task#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.

scheduleOptional 
public java.lang.String getSchedule();
  • Type: java.lang.String

The schedule for periodically running the task. This can be a cron or interval in minutes. (Conflict with after).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#schedule Task#schedule}

sessionParametersOptional 
public java.util.Map<java.lang.String, java.lang.String> getSessionParameters();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Specifies session parameters to set for the session when the task runs. A task supports all session parameters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#session_parameters Task#session_parameters}

suspendTaskAfterNumFailuresOptional 
public java.lang.Number getSuspendTaskAfterNumFailures();
  • Type: java.lang.Number

Specifies the number of consecutive failed task runs after which the current task is suspended automatically.

The default is 0 (no automatic suspension).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#suspend_task_after_num_failures Task#suspend_task_after_num_failures}

userTaskManagedInitialWarehouseSizeOptional 
public java.lang.String getUserTaskManagedInitialWarehouseSize();
  • Type: java.lang.String

Specifies the size of the compute resources to provision for the first run of the task, before a task history is available for Snowflake to determine an ideal size.

Once a task has successfully completed a few runs, Snowflake ignores this parameter setting. (Conflicts with warehouse)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#user_task_managed_initial_warehouse_size Task#user_task_managed_initial_warehouse_size}

userTaskTimeoutMsOptional 
public java.lang.Number getUserTaskTimeoutMs();
  • Type: java.lang.Number

Specifies the time limit on a single run of the task before it times out (in milliseconds).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#user_task_timeout_ms Task#user_task_timeout_ms}

warehouseOptional 
public java.lang.String getWarehouse();
  • Type: java.lang.String

The warehouse the task will use.

Omit this parameter to use Snowflake-managed compute resources for runs of this task. (Conflicts with user_task_managed_initial_warehouse_size)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#warehouse Task#warehouse}

whenOptional 
public java.lang.String getWhen();
  • Type: java.lang.String

Specifies a Boolean SQL expression; multiple conditions joined with AND/OR are supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/task#when Task#when}