Class AthenaStartQueryExecutionJsonataProps

Properties for starting a Query Execution using JSONata.

Inheritance
System.Object
AthenaStartQueryExecutionJsonataProps
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AthenaStartQueryExecutionJsonataProps : Object, IAthenaStartQueryExecutionJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptions
Syntax (vb)
Public Class AthenaStartQueryExecutionJsonataProps
    Inherits Object
    Implements IAthenaStartQueryExecutionJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// 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 outputs;
TaskRole taskRole;
Timeout timeout;

var athenaStartQueryExecutionJsonataProps = new AthenaStartQueryExecutionJsonataProps {
    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,
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    Outputs = outputs,
    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"
        }
    },
    ResultReuseConfigurationMaxAge = Duration.Minutes(30),
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30),
    WorkGroup = "workGroup"
};

Synopsis

Constructors

AthenaStartQueryExecutionJsonataProps()

Properties

Assign

Workflow variables to store in this step.
ClientRequestToken

Unique string string to ensure idempotence.
Comment

A comment describing this state.
Credentials

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

A list of values for the parameters in a query.
Heartbeat

(deprecated) Timeout for the heartbeat.
HeartbeatTimeout

Timeout for the heartbeat.
IntegrationPattern

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

Used to specify and transform output from the state.
QueryExecutionContext

Database within which query executes.
QueryLanguage

The name of the query language used by the state.
QueryString

Query that will be started.
ResultConfiguration

Configuration on how and where to save query.
ResultReuseConfigurationMaxAge

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

Optional name for this state.
TaskTimeout

Timeout for the task.
Timeout

(deprecated) Timeout for the task.
WorkGroup

Configuration on how and where to save query.

Constructors

AthenaStartQueryExecutionJsonataProps()

public AthenaStartQueryExecutionJsonataProps()

Properties

Assign

Workflow variables to store in this step.

public IDictionary<string, object> Assign { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

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

ClientRequestToken

Unique string string to ensure idempotence.

public string ClientRequestToken { get; set; }
Property Value

System.String

Remarks

Default: - No client request token

Comment

A comment describing this state.

public string Comment { get; set; }
Property Value

System.String

Remarks

Default: No comment

Credentials

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

public ICredentials Credentials { get; set; }
Property Value

ICredentials

Remarks

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

ExecutionParameters

A list of values for the parameters in a query.

public string[] ExecutionParameters { get; set; }
Property Value

System.String[]

Remarks

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.

public Duration Heartbeat { get; set; }
Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

HeartbeatTimeout

Timeout for the heartbeat.

public Timeout HeartbeatTimeout { get; set; }
Property Value

Timeout

Remarks

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

Default: - None

IntegrationPattern

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

public Nullable<IntegrationPattern> IntegrationPattern { get; set; }
Property Value

System.Nullable<IntegrationPattern>

Remarks

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

Outputs

Used to specify and transform output from the state.

public object Outputs { get; set; }
Property Value

System.Object

Remarks

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.

Default: - $states.result or $states.errorOutput

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

QueryExecutionContext

Database within which query executes.

public IQueryExecutionContext QueryExecutionContext { get; set; }
Property Value

IQueryExecutionContext

Remarks

Default: - No query execution context

QueryLanguage

The name of the query language used by the state.

public Nullable<QueryLanguage> QueryLanguage { get; set; }
Property Value

System.Nullable<QueryLanguage>

Remarks

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

QueryString

Query that will be started.

public string QueryString { get; set; }
Property Value

System.String

ResultConfiguration

Configuration on how and where to save query.

public IResultConfiguration ResultConfiguration { get; set; }
Property Value

IResultConfiguration

Remarks

Default: - No result configuration

ResultReuseConfigurationMaxAge

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

public Duration ResultReuseConfigurationMaxAge { get; set; }
Property Value

Duration

Remarks

Default: - Query results are not reused

StateName

Optional name for this state.

public string StateName { get; set; }
Property Value

System.String

Remarks

Default: - The construct ID will be used as state name

TaskTimeout

Timeout for the task.

public Timeout TaskTimeout { get; set; }
Property Value

Timeout

Remarks

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

public Duration Timeout { get; set; }
Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

WorkGroup

Configuration on how and where to save query.

public string WorkGroup { get; set; }
Property Value

System.String

Remarks

Default: - No work group

Implements