Class AthenaStartQueryExecution

Start an Athena Query as a Task.

Inheritance
object
State
TaskStateBase
AthenaStartQueryExecution
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AthenaStartQueryExecution : TaskStateBase, IChainable, INextable
Syntax (vb)
Public Class AthenaStartQueryExecution Inherits TaskStateBase Implements IChainable, INextable
Remarks

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

ExampleMetadata: infused

Examples
var startQueryExecutionJob = new AthenaStartQueryExecution(this, "Start Athena Query", new AthenaStartQueryExecutionProps {
                 QueryString = JsonPath.StringAt("$.queryString"),
                 QueryExecutionContext = new QueryExecutionContext {
                     DatabaseName = "mydatabase"
                 },
                 ResultConfiguration = new ResultConfiguration {
                     EncryptionConfiguration = new EncryptionConfiguration {
                         EncryptionOption = EncryptionOption.S3_MANAGED
                     },
                     OutputLocation = new Location {
                         BucketName = "amzn-s3-demo-bucket",
                         ObjectKey = "folder"
                     }
                 },
                 ExecutionParameters = new [] { "param1", "param2" }
             });

Synopsis

Constructors

AthenaStartQueryExecution(Construct, string, IAthenaStartQueryExecutionProps)

Start an Athena Query as a Task.

Properties

TaskMetrics

Start an Athena Query as a Task.
TaskPolicies

Start an Athena Query as a Task.

Methods

JsonPath(Construct, string, IAthenaStartQueryExecutionJsonPathProps)

Start an Athena Query as a Task using JSONPath.
Jsonata(Construct, string, IAthenaStartQueryExecutionJsonataProps)

Start an Athena Query as a Task using JSONata.

Constructors

AthenaStartQueryExecution(Construct, string, IAthenaStartQueryExecutionProps)

Start an Athena Query as a Task.

public AthenaStartQueryExecution(Construct scope, string id, IAthenaStartQueryExecutionProps props)
Parameters
scope Construct
id string

Descriptive identifier for this chainable.

props IAthenaStartQueryExecutionProps
Remarks

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

ExampleMetadata: infused

Properties

TaskMetrics

Start an Athena Query as a Task.

protected override ITaskMetricsConfig? TaskMetrics { get; }
Property Value

ITaskMetricsConfig

Overrides
Remarks

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

ExampleMetadata: infused

TaskPolicies

Start an Athena Query as a Task.

protected override PolicyStatement[]? TaskPolicies { get; }
Property Value

PolicyStatement[]

Overrides
Remarks

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

ExampleMetadata: infused

Methods

JsonPath(Construct, string, IAthenaStartQueryExecutionJsonPathProps)

Start an Athena Query as a Task using JSONPath.

public static AthenaStartQueryExecution JsonPath(Construct scope, string id, IAthenaStartQueryExecutionJsonPathProps props)
Parameters
scope Construct
id string
props IAthenaStartQueryExecutionJsonPathProps
Returns

AthenaStartQueryExecution

Remarks

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

ExampleMetadata: infused

Jsonata(Construct, string, IAthenaStartQueryExecutionJsonataProps)

Start an Athena Query as a Task using JSONata.

public static AthenaStartQueryExecution Jsonata(Construct scope, string id, IAthenaStartQueryExecutionJsonataProps props)
Parameters
scope Construct
id string
props IAthenaStartQueryExecutionJsonataProps
Returns

AthenaStartQueryExecution

Remarks

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

ExampleMetadata: infused

Implements