2.184.1

interface AthenaStartQueryExecutionProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.AthenaStartQueryExecutionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#AthenaStartQueryExecutionProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.AthenaStartQueryExecutionProps
Pythonaws_cdk.aws_stepfunctions_tasks.AthenaStartQueryExecutionProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » AthenaStartQueryExecutionProps

Properties for starting a Query Execution.

Example

const startQueryExecutionJob = new tasks.AthenaStartQueryExecution(this, 'Start Athena Query', {
  queryString: sfn.JsonPath.stringAt('$.queryString'),
  queryExecutionContext: {
    databaseName: 'mydatabase',
  },
  resultConfiguration: {
    encryptionConfiguration: {
      encryptionOption: tasks.EncryptionOption.S3_MANAGED,
    },
    outputLocation: {
      bucketName: 'amzn-s3-demo-bucket',
      objectKey: 'folder',
    },
  },
  executionParameters: ['param1', 'param2'],
});

Properties

NameTypeDescription
queryStringstringQuery that will be started.
assign?{ [string]: any }Workflow variables to store in this step.
clientRequestToken?stringUnique string string to ensure idempotence.
comment?stringA comment describing this state.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
executionParameters?string[]A list of values for the parameters in a query.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?stringJSONPath expression to select part of the state to be the output to this state.
outputs?anyUsed to specify and transform output from the state.
queryExecutionContext?QueryExecutionContextDatabase within which query executes.
queryLanguage?QueryLanguageThe name of the query language used by the state.
resultConfiguration?ResultConfigurationConfiguration on how and where to save query.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultReuseConfigurationMaxAge?DurationSpecifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
stateName?stringOptional name for this state.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.
workGroup?stringConfiguration on how and where to save query.

queryString

Type: string

Query that will be started.

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

clientRequestToken?

Type: string (optional, default: No client request token)

Unique string string to ensure idempotence.

comment?

Type: string (optional, default: No comment)

A comment describing this state.

credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

executionParameters?

Type: string[] (optional, default: No parameters)

A list of values for the parameters in a query.

The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.

heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

inputPath?

Type: string (optional, default: $)

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

outputPath?

Type: string (optional, default: $)

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

outputs?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

queryExecutionContext?

Type: QueryExecutionContext (optional, default: No query execution context)

Database within which query executes.

queryLanguage?

Type: QueryLanguage (optional, default: JSONPath)

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

resultConfiguration?

Type: ResultConfiguration (optional, default: No result configuration)

Configuration on how and where to save query.

resultPath?

Type: string (optional, default: $)

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

resultReuseConfigurationMaxAge?

Type: Duration (optional, default: Query results are not reused)

Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

resultSelector?

Type: { [string]: any } (optional, default: None)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.

workGroup?

Type: string (optional, default: No work group)

Configuration on how and where to save query.

← PreviousNext →