Class AthenaStartQueryExecutionProps
Properties for starting a Query Execution.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class AthenaStartQueryExecutionProps : Object, IAthenaStartQueryExecutionProps, ITaskStateBaseProps
Syntax (vb)
Public Class AthenaStartQueryExecutionProps
Inherits Object
Implements IAthenaStartQueryExecutionProps, ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
var startQueryExecutionJob = new AthenaStartQueryExecution(this, "Athena Start Query", new AthenaStartQueryExecutionProps {
QueryString = JsonPath.Format("select contacts where year={};", JsonPath.StringAt("$.year")),
QueryExecutionContext = new QueryExecutionContext {
DatabaseName = "interactions"
},
ResultConfiguration = new ResultConfiguration {
EncryptionConfiguration = new EncryptionConfiguration {
EncryptionOption = EncryptionOption.S3_MANAGED
},
OutputLocation = new Location {
BucketName = "mybucket",
ObjectKey = "myprefix"
}
},
IntegrationPattern = IntegrationPattern.RUN_JOB
});
Synopsis
Constructors
AthenaStartQueryExecutionProps() |
Properties
ClientRequestToken | Unique string string to ensure idempotence. |
Comment | An optional description for this state. |
Heartbeat | Timeout for the heartbeat. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
QueryExecutionContext | Database within which query executes. |
QueryString | Query that will be started. |
ResultConfiguration | Configuration on how and where to save query. |
ResultPath | JSONPath expression to indicate where to inject the state's output. |
ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
Timeout | Timeout for the state machine. |
WorkGroup | Configuration on how and where to save query. |
Constructors
AthenaStartQueryExecutionProps()
public AthenaStartQueryExecutionProps()
Properties
ClientRequestToken
Unique string string to ensure idempotence.
public string ClientRequestToken { get; set; }
Property Value
System.String
Remarks
Default: - No client request token
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
Heartbeat
Timeout for the heartbeat.
public Duration Heartbeat { get; set; }
Property Value
Remarks
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
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
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-to-resource.html#connect-wait-token
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next state.
public string OutputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
QueryExecutionContext
Database within which query executes.
public IQueryExecutionContext QueryExecutionContext { get; set; }
Property Value
Remarks
Default: - No query execution context
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
Remarks
Default: - No result configuration
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
Timeout
Timeout for the state machine.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - None
WorkGroup
Configuration on how and where to save query.
public string WorkGroup { get; set; }
Property Value
System.String
Remarks
Default: - No work group