AthenaStartQueryExecutionJsonPathProps Struct
Properties for starting a Query Execution using JSONPath.
| Source | aws-stepfunctions-tasks/lib/athena/start-query-execution.ts |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
declare const assign: any;
declare const key: kms.Key;
declare const resultSelector: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const athenaStartQueryExecutionJsonPathProps: stepfunctions_tasks.AthenaStartQueryExecutionJsonPathProps = {
queryString: 'queryString',
// the properties below are optional
assign: {
assignKey: assign,
},
clientRequestToken: 'clientRequestToken',
comment: 'comment',
credentials: {
role: taskRole,
},
executionParameters: ['executionParameters'],
heartbeat: cdk.Duration.minutes(30),
heartbeatTimeout: timeout,
inputPath: 'inputPath',
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
outputPath: 'outputPath',
queryExecutionContext: {
catalogName: 'catalogName',
databaseName: 'databaseName',
},
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultConfiguration: {
encryptionConfiguration: {
encryptionOption: stepfunctions_tasks.EncryptionOption.S3_MANAGED,
// the properties below are optional
encryptionKey: key,
},
outputLocation: {
bucketName: 'bucketName',
objectKey: 'objectKey',
// the properties below are optional
objectVersion: 'objectVersion',
},
},
resultPath: 'resultPath',
resultReuseConfigurationMaxAge: cdk.Duration.minutes(30),
resultSelector: {
resultSelectorKey: resultSelector,
},
stateName: 'stateName',
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
workGroup: 'workGroup',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_kms as kms
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
# assign: Any
# key: kms.Key
# result_selector: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
athena_start_query_execution_json_path_props = stepfunctions_tasks.AthenaStartQueryExecutionJsonPathProps(
query_string="queryString",
# the properties below are optional
assign={
"assign_key": assign
},
client_request_token="clientRequestToken",
comment="comment",
credentials=stepfunctions.Credentials(
role=task_role
),
execution_parameters=["executionParameters"],
heartbeat=cdk.Duration.minutes(30),
heartbeat_timeout=timeout,
input_path="inputPath",
integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
output_path="outputPath",
query_execution_context=stepfunctions_tasks.QueryExecutionContext(
catalog_name="catalogName",
database_name="databaseName"
),
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_configuration=stepfunctions_tasks.ResultConfiguration(
encryption_configuration=stepfunctions_tasks.EncryptionConfiguration(
encryption_option=stepfunctions_tasks.EncryptionOption.S3_MANAGED,
# the properties below are optional
encryption_key=key
),
output_location=cdk.aws_s3.Location(
bucket_name="bucketName",
object_key="objectKey",
# the properties below are optional
object_version="objectVersion"
)
),
result_path="resultPath",
result_reuse_configuration_max_age=cdk.Duration.minutes(30),
result_selector={
"result_selector_key": result_selector
},
state_name="stateName",
task_timeout=timeout,
timeout=cdk.Duration.minutes(30),
work_group="workGroup"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.kms.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
Object assign;
Key key;
Object resultSelector;
TaskRole taskRole;
Timeout timeout;
AthenaStartQueryExecutionJsonPathProps athenaStartQueryExecutionJsonPathProps = AthenaStartQueryExecutionJsonPathProps.builder()
.queryString("queryString")
// the properties below are optional
.assign(Map.of(
"assignKey", assign))
.clientRequestToken("clientRequestToken")
.comment("comment")
.credentials(Credentials.builder()
.role(taskRole)
.build())
.executionParameters(List.of("executionParameters"))
.heartbeat(Duration.minutes(30))
.heartbeatTimeout(timeout)
.inputPath("inputPath")
.integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
.outputPath("outputPath")
.queryExecutionContext(QueryExecutionContext.builder()
.catalogName("catalogName")
.databaseName("databaseName")
.build())
.queryLanguage(QueryLanguage.JSON_PATH)
.resultConfiguration(ResultConfiguration.builder()
.encryptionConfiguration(EncryptionConfiguration.builder()
.encryptionOption(EncryptionOption.S3_MANAGED)
// the properties below are optional
.encryptionKey(key)
.build())
.outputLocation(Location.builder()
.bucketName("bucketName")
.objectKey("objectKey")
// the properties below are optional
.objectVersion("objectVersion")
.build())
.build())
.resultPath("resultPath")
.resultReuseConfigurationMaxAge(Duration.minutes(30))
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.stateName("stateName")
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.workGroup("workGroup")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.KMS;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
Key key;
var resultSelector;
TaskRole taskRole;
Timeout timeout;
var athenaStartQueryExecutionJsonPathProps = new AthenaStartQueryExecutionJsonPathProps {
QueryString = "queryString",
// the properties below are optional
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
ClientRequestToken = "clientRequestToken",
Comment = "comment",
Credentials = new Credentials {
Role = taskRole
},
ExecutionParameters = new [] { "executionParameters" },
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
OutputPath = "outputPath",
QueryExecutionContext = new QueryExecutionContext {
CatalogName = "catalogName",
DatabaseName = "databaseName"
},
QueryLanguage = QueryLanguage.JSON_PATH,
ResultConfiguration = new ResultConfiguration {
EncryptionConfiguration = new EncryptionConfiguration {
EncryptionOption = EncryptionOption.S3_MANAGED,
// the properties below are optional
EncryptionKey = key
},
OutputLocation = new Location {
BucketName = "bucketName",
ObjectKey = "objectKey",
// the properties below are optional
ObjectVersion = "objectVersion"
}
},
ResultPath = "resultPath",
ResultReuseConfigurationMaxAge = Duration.Minutes(30),
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30),
WorkGroup = "workGroup"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var assign interface{}
var key Key
var resultSelector interface{}
var taskRole TaskRole
var timeout Timeout
athenaStartQueryExecutionJsonPathProps := &AthenaStartQueryExecutionJsonPathProps{
QueryString: jsii.String("queryString"),
// the properties below are optional
Assign: map[string]interface{}{
"assignKey": assign,
},
ClientRequestToken: jsii.String("clientRequestToken"),
Comment: jsii.String("comment"),
Credentials: &Credentials{
Role: taskRole,
},
ExecutionParameters: []*string{
jsii.String("executionParameters"),
},
Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
HeartbeatTimeout: timeout,
InputPath: jsii.String("inputPath"),
IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
OutputPath: jsii.String("outputPath"),
QueryExecutionContext: &QueryExecutionContext{
CatalogName: jsii.String("catalogName"),
DatabaseName: jsii.String("databaseName"),
},
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultConfiguration: &ResultConfiguration{
EncryptionConfiguration: &EncryptionConfiguration{
EncryptionOption: awscdk.Aws_stepfunctions_tasks.EncryptionOption_S3_MANAGED,
// the properties below are optional
EncryptionKey: key,
},
OutputLocation: &Location{
BucketName: jsii.String("bucketName"),
ObjectKey: jsii.String("objectKey"),
// the properties below are optional
ObjectVersion: jsii.String("objectVersion"),
},
},
ResultPath: jsii.String("resultPath"),
ResultReuseConfigurationMaxAge: cdk.Duration_*Minutes(jsii.Number(30)),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
StateName: jsii.String("stateName"),
TaskTimeout: timeout,
Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
WorkGroup: jsii.String("workGroup"),
}
Properties
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{} #Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
clientRequestTokenoptionalstringclient_request_tokenoptionalstrclientRequestTokenoptionalStringClientRequestTokenoptionalstringClientRequestTokenoptional*string #Default: No client request token
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #Default: No comment
credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials #Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
executionParametersoptionalstring[]execution_parametersoptionaltyping.List[str]executionParametersoptionalList<String>ExecutionParametersoptionalstring[]ExecutionParametersoptional*[]*string #Default: No parameters
The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern #Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryExecutionContextoptionalQueryExecutionContextquery_execution_contextoptionalQueryExecutionContextqueryExecutionContextoptionalQueryExecutionContextQueryExecutionContextoptionalQueryExecutionContextQueryExecutionContextoptionalQueryExecutionContext #Default: No query execution context
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = JSONPath #If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
resultConfigurationoptionalResultConfigurationresult_configurationoptionalResultConfigurationresultConfigurationoptionalResultConfigurationResultConfigurationoptionalResultConfigurationResultConfigurationoptionalResultConfiguration #Default: No result configuration
resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultReuseConfigurationMaxAgeoptionalDurationresult_reuse_configuration_max_ageoptionalDurationresultReuseConfigurationMaxAgeoptionalDurationResultReuseConfigurationMaxAgeoptionalDurationResultReuseConfigurationMaxAgeoptionalDuration #Default: Query results are not reused
resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{} = None #You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #Default: The construct ID will be used as state name
taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration = None deprecated #workGroupoptionalstringwork_groupoptionalstrworkGroupoptionalStringWorkGroupoptionalstringWorkGroupoptional*string #Default: No work group