Class EksCallProps

Properties for calling a EKS endpoint with EksCall.

Inheritance
System.Object
EksCallProps
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class EksCallProps : Object, IEksCallProps, ITaskStateBaseProps
Syntax (vb)
Public Class EksCallProps
    Inherits Object
    Implements IEksCallProps, ITaskStateBaseProps
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.EKS;


var myEksCluster = new Cluster(this, "my sample cluster", new ClusterProps {
    Version = KubernetesVersion.V1_18,
    ClusterName = "myEksCluster"
});

new EksCall(this, "Call a EKS Endpoint", new EksCallProps {
    Cluster = myEksCluster,
    HttpMethod = HttpMethods.GET,
    HttpPath = "/api/v1/namespaces/default/pods"
});

Synopsis

Constructors

EksCallProps()

Properties

Cluster

The EKS cluster.
Comment

An optional description for this state.
Heartbeat

Timeout for the heartbeat.
HttpMethod

HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.
HttpPath

HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.
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.
QueryParameters

Query Parameters part of HTTP request.
RequestBody

Request body part of HTTP request.
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.

Constructors

EksCallProps()

public EksCallProps()

Properties

Cluster

The EKS cluster.

public ICluster Cluster { get; set; }
Property Value

ICluster

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

Duration

Remarks

Default: - None

HttpMethod

HTTP method ("GET", "POST", "PUT", ...) part of HTTP request.

public HttpMethods HttpMethod { get; set; }
Property Value

HttpMethods

HttpPath

HTTP path of the Kubernetes REST API operation For example: /api/v1/namespaces/default/pods.

public string HttpPath { get; set; }
Property Value

System.String

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 '$')

QueryParameters

Query Parameters part of HTTP request.

public IDictionary<string, string[]> QueryParameters { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String[]>

Remarks

Default: - no query parameters

RequestBody

Request body part of HTTP request.

public TaskInput RequestBody { get; set; }
Property Value

TaskInput

Remarks

Default: - No request body

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

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

Timeout

Timeout for the state machine.

public Duration Timeout { get; set; }
Property Value

Duration

Remarks

Default: - None

Implements