Skip to content
v2.277.0

EmrContainersCreateVirtualClusterJsonataProps Struct ​

Properties to define a EMR Containers CreateVirtualCluster Task using JSONata on an EKS cluster.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const eksClusterInput: stepfunctions_tasks.EksClusterInput;
declare const outputs: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const emrContainersCreateVirtualClusterJsonataProps: stepfunctions_tasks.EmrContainersCreateVirtualClusterJsonataProps = {
  eksCluster: eksClusterInput,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  eksNamespace: 'eksNamespace',
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputs: outputs,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
  tags: {
    tagsKey: 'tags',
  },
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
  virtualClusterName: 'virtualClusterName',
};
python
# 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_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# assign: Any
# eks_cluster_input: stepfunctions_tasks.EksClusterInput
# outputs: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

emr_containers_create_virtual_cluster_jsonata_props = stepfunctions_tasks.EmrContainersCreateVirtualClusterJsonataProps(
    eks_cluster=eks_cluster_input,

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    eks_namespace="eksNamespace",
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    outputs=outputs,
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    state_name="stateName",
    tags={
        "tags_key": "tags"
    },
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30),
    virtual_cluster_name="virtualClusterName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;

Object assign;
EksClusterInput eksClusterInput;
Object outputs;
TaskRole taskRole;
Timeout timeout;

EmrContainersCreateVirtualClusterJsonataProps emrContainersCreateVirtualClusterJsonataProps = EmrContainersCreateVirtualClusterJsonataProps.builder()
        .eksCluster(eksClusterInput)

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .eksNamespace("eksNamespace")
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .outputs(outputs)
        .queryLanguage(QueryLanguage.JSON_PATH)
        .stateName("stateName")
        .tags(Map.of(
                "tagsKey", "tags"))
        .taskTimeout(timeout)
        .timeout(Duration.minutes(30))
        .virtualClusterName("virtualClusterName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;

var assign;
EksClusterInput eksClusterInput;
var outputs;
TaskRole taskRole;
Timeout timeout;

var emrContainersCreateVirtualClusterJsonataProps = new EmrContainersCreateVirtualClusterJsonataProps {
    EksCluster = eksClusterInput,

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    Credentials = new Credentials {
        Role = taskRole
    },
    EksNamespace = "eksNamespace",
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    Outputs = outputs,
    QueryLanguage = QueryLanguage.JSON_PATH,
    StateName = "stateName",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    },
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30),
    VirtualClusterName = "virtualClusterName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assign interface{}
var eksClusterInput EksClusterInput
var outputs interface{}
var taskRole TaskRole
var timeout Timeout

emrContainersCreateVirtualClusterJsonataProps := &EmrContainersCreateVirtualClusterJsonataProps{
	EksCluster: eksClusterInput,

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	EksNamespace: jsii.String("eksNamespace"),
	Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	Outputs: outputs,
	QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
	StateName: jsii.String("stateName"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
	TaskTimeout: timeout,
	Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
	VirtualClusterName: jsii.String("virtualClusterName"),
}

Properties ​

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{} #
Workflow variables to store in this step.

Default: Not assign variables

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

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #
A comment describing this state.

Default: No comment

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

Default: None (Task is executed using the State Machine's execution role)

This enables cross-account resource invocations.

eksClusterEksClusterInputeks_clusterEksClusterInputeksClusterEksClusterInputEksClusterEksClusterInputEksClusterEksClusterInput required #
EKS Cluster or task input that contains the name of the cluster.
eksNamespaceoptionalstringeks_namespaceoptionalstreksNamespaceoptionalStringEksNamespaceoptionalstringEksNamespaceoptional*string = 'default' #
The namespace of an EKS cluster.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #
use `heartbeatTimeout`
heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout = None #
Timeout for the heartbeat.

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

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

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{} #
Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

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.

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = JSONPath #
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.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #
Optional name for this state.

Default: The construct ID will be used as state name

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string = {} #
The tags assigned to the virtual cluster.
taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout = None #
Timeout for the task.

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

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration = None deprecated #
use `taskTimeout`
virtualClusterNameoptionalstringvirtual_cluster_nameoptionalstrvirtualClusterNameoptionalStringVirtualClusterNameoptionalstringVirtualClusterNameoptional*string #
Name of the virtual cluster that will be created.

Default: the name of the state machine execution that runs this task and state name