interface AthenaStartQueryExecutionProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.Tasks.AthenaStartQueryExecutionProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#AthenaStartQueryExecutionProps |
Java | software.amazon.awscdk.services.stepfunctions.tasks.AthenaStartQueryExecutionProps |
Python | aws_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: 'query-results-bucket',
objectKey: 'folder',
},
},
executionParameters: ['param1', 'param2'],
});
Properties
Name | Type | Description |
---|---|---|
query | string | Query that will be started. |
client | string | Unique string string to ensure idempotence. |
comment? | string | An optional description for this state. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
execution | string[] | A list of values for the parameters in a query. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
query | Query | Database within which query executes. |
result | Result | Configuration on how and where to save query. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
work | string | Configuration on how and where to save query. |
queryString
Type:
string
Query that will be started.
clientRequestToken?
Type:
string
(optional, default: No client request token)
Unique string string to ensure idempotence.
comment?
Type:
string
(optional, default: No comment)
An optional description for 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: The entire task input (JSON path '$'))
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:
Integration
(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: The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path '$'))
JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryExecutionContext?
Type:
Query
(optional, default: No query execution context)
Database within which query executes.
resultConfiguration?
Type:
Result
(optional, default: No result configuration)
Configuration on how and where to save query.
resultPath?
Type:
string
(optional, default: Replaces the entire input with the result (JSON path '$'))
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.
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.
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.