AthenaStartQueryExecutionJsonPathProps

class aws_cdk.aws_stepfunctions_tasks.AthenaStartQueryExecutionJsonPathProps(*, comment=None, query_language=None, state_name=None, credentials=None, heartbeat=None, heartbeat_timeout=None, integration_pattern=None, task_timeout=None, timeout=None, assign=None, input_path=None, output_path=None, result_path=None, result_selector=None, query_string, client_request_token=None, execution_parameters=None, query_execution_context=None, result_configuration=None, result_reuse_configuration_max_age=None, work_group=None)

Bases: TaskStateJsonPathBaseProps

Properties for starting a Query Execution using JSONPath.

Parameters:

  • comment (Optional[str]) – A comment describing this state. Default: No comment

  • query_language (Optional[QueryLanguage]) – 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. Default: - JSONPath

  • state_name (Optional[str]) – Optional name for this state. Default: - The construct ID will be used as state name

  • credentials (Union[Credentials, Dict[str, Any], None]) – Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations. Default: - None (Task is executed using the State Machine’s execution role)

  • heartbeat (Optional[Duration]) – (deprecated) Timeout for the heartbeat. Default: - None

  • heartbeat_timeout (Optional[Timeout]) – Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - None

  • integration_pattern (Optional[IntegrationPattern]) – 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. Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

  • task_timeout (Optional[Timeout]) – Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - None

  • timeout (Optional[Duration]) – (deprecated) Timeout for the task. Default: - None

  • assign (Optional[Mapping[str, Any]]) – Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps. Default: - Not assign variables

  • input_path (Optional[str]) – 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 {}. Default: $

  • output_path (Optional[str]) – 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 {}. Default: $

  • result_path (Optional[str]) – 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. Default: $

  • result_selector (Optional[Mapping[str, Any]]) – 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. Default: - None

  • query_string (str) – Query that will be started.

  • client_request_token (Optional[str]) – Unique string string to ensure idempotence. Default: - No client request token

  • execution_parameters (Optional[Sequence[str]]) – 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. Default: - No parameters

  • query_execution_context (Union[QueryExecutionContext, Dict[str, Any], None]) – Database within which query executes. Default: - No query execution context

  • result_configuration (Union[ResultConfiguration, Dict[str, Any], None]) – Configuration on how and where to save query. Default: - No result configuration

  • result_reuse_configuration_max_age (Optional[Duration]) – Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse. Default: - Query results are not reused

  • work_group (Optional[str]) – Configuration on how and where to save query. Default: - No work group

ExampleMetadata:

fixture=_generated

Example:

# 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"
)

Attributes

assign

Workflow variables to store in this step.

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

Default:

  • Not assign variables

See:

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

client_request_token

Unique string string to ensure idempotence.

Default:

  • No client request token

comment

A comment describing this state.

Default:

No comment

credentials

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

This enables cross-account resource invocations.

Default:

  • None (Task is executed using the State Machine’s execution role)

See:

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

execution_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.

Default:

  • No parameters

heartbeat

(deprecated) Timeout for the heartbeat.

Default:

  • None

Deprecated:

use heartbeatTimeout

Stability:

deprecated

heartbeat_timeout

Timeout for the heartbeat.

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

Default:

  • None

input_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 {}.

Default:

$

integration_pattern

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.

Default:

  • IntegrationPattern.REQUEST_RESPONSE for most tasks.

IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

See:

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

output_path

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 {}.

Default:

$

query_execution_context

Database within which query executes.

Default:

  • No query execution context

query_language

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.

Default:

  • JSONPath

query_string

Query that will be started.

result_configuration

Configuration on how and where to save query.

Default:

  • No result configuration

result_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.

Default:

$

result_reuse_configuration_max_age

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

Default:

  • Query results are not reused

result_selector

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.

Default:

  • None

See:

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

state_name

Optional name for this state.

Default:

  • The construct ID will be used as state name

task_timeout

Timeout for the task.

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

Default:

  • None

timeout

(deprecated) Timeout for the task.

Default:

  • None

Deprecated:

use taskTimeout

Stability:

deprecated

work_group

Configuration on how and where to save query.

Default:

  • No work group