EmrContainersStartJobRunJsonPathProps Struct
Properties for calling EMR Containers StartJobRun using JSONPath.
| Source | aws-stepfunctions-tasks/lib/emrcontainers/start-job-run.ts |
|---|---|
| Type last changed |
Example
// 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_iam as iam } from 'aws-cdk-lib';
import { aws_logs as logs } from 'aws-cdk-lib';
import { aws_s3 as s3 } 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 applicationConfiguration_: stepfunctions_tasks.ApplicationConfiguration;
declare const assign: any;
declare const bucket: s3.Bucket;
declare const classification: stepfunctions_tasks.Classification;
declare const logGroup: logs.LogGroup;
declare const releaseLabel: stepfunctions_tasks.ReleaseLabel;
declare const resultSelector: any;
declare const role: iam.Role;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
declare const virtualClusterInput: stepfunctions_tasks.VirtualClusterInput;
const emrContainersStartJobRunJsonPathProps: stepfunctions_tasks.EmrContainersStartJobRunJsonPathProps = {
jobDriver: {
sparkSubmitJobDriver: {
entryPoint: taskInput,
// the properties below are optional
entryPointArguments: taskInput,
sparkSubmitParameters: 'sparkSubmitParameters',
},
},
releaseLabel: releaseLabel,
virtualCluster: virtualClusterInput,
// the properties below are optional
applicationConfig: [{
classification: classification,
// the properties below are optional
nestedConfig: [applicationConfiguration_],
properties: {
propertiesKey: 'properties',
},
}],
assign: {
assignKey: assign,
},
comment: 'comment',
credentials: {
role: taskRole,
},
executionRole: role,
heartbeat: cdk.Duration.minutes(30),
heartbeatTimeout: timeout,
inputPath: 'inputPath',
integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
jobName: 'jobName',
monitoring: {
logBucket: bucket,
logging: false,
logGroup: logGroup,
logStreamNamePrefix: 'logStreamNamePrefix',
persistentAppUI: false,
},
outputPath: 'outputPath',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
stateName: 'stateName',
tags: {
tagsKey: 'tags',
},
taskTimeout: timeout,
timeout: cdk.Duration.minutes(30),
};
# 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_iam as iam
from aws_cdk import aws_logs as logs
from aws_cdk import aws_s3 as s3
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
# application_configuration_: stepfunctions_tasks.ApplicationConfiguration
# assign: Any
# bucket: s3.Bucket
# classification: stepfunctions_tasks.Classification
# log_group: logs.LogGroup
# release_label: stepfunctions_tasks.ReleaseLabel
# result_selector: Any
# role: iam.Role
# task_input: stepfunctions.TaskInput
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout
# virtual_cluster_input: stepfunctions_tasks.VirtualClusterInput
emr_containers_start_job_run_json_path_props = stepfunctions_tasks.EmrContainersStartJobRunJsonPathProps(
job_driver=stepfunctions_tasks.JobDriver(
spark_submit_job_driver=stepfunctions_tasks.SparkSubmitJobDriver(
entry_point=task_input,
# the properties below are optional
entry_point_arguments=task_input,
spark_submit_parameters="sparkSubmitParameters"
)
),
release_label=release_label,
virtual_cluster=virtual_cluster_input,
# the properties below are optional
application_config=[stepfunctions_tasks.ApplicationConfiguration(
classification=classification,
# the properties below are optional
nested_config=[application_configuration_],
properties={
"properties_key": "properties"
}
)],
assign={
"assign_key": assign
},
comment="comment",
credentials=stepfunctions.Credentials(
role=task_role
),
execution_role=role,
heartbeat=cdk.Duration.minutes(30),
heartbeat_timeout=timeout,
input_path="inputPath",
integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
job_name="jobName",
monitoring=stepfunctions_tasks.Monitoring(
log_bucket=bucket,
logging=False,
log_group=log_group,
log_stream_name_prefix="logStreamNamePrefix",
persistent_app_ui=False
),
output_path="outputPath",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
state_name="stateName",
tags={
"tags_key": "tags"
},
task_timeout=timeout,
timeout=cdk.Duration.minutes(30)
)
// 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.iam.*;
import software.amazon.awscdk.services.logs.*;
import software.amazon.awscdk.services.s3.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
ApplicationConfiguration applicationConfiguration_;
Object assign;
Bucket bucket;
Classification classification;
LogGroup logGroup;
ReleaseLabel releaseLabel;
Object resultSelector;
Role role;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
VirtualClusterInput virtualClusterInput;
EmrContainersStartJobRunJsonPathProps emrContainersStartJobRunJsonPathProps = EmrContainersStartJobRunJsonPathProps.builder()
.jobDriver(JobDriver.builder()
.sparkSubmitJobDriver(SparkSubmitJobDriver.builder()
.entryPoint(taskInput)
// the properties below are optional
.entryPointArguments(taskInput)
.sparkSubmitParameters("sparkSubmitParameters")
.build())
.build())
.releaseLabel(releaseLabel)
.virtualCluster(virtualClusterInput)
// the properties below are optional
.applicationConfig(List.of(ApplicationConfiguration.builder()
.classification(classification)
// the properties below are optional
.nestedConfig(List.of(applicationConfiguration_))
.properties(Map.of(
"propertiesKey", "properties"))
.build()))
.assign(Map.of(
"assignKey", assign))
.comment("comment")
.credentials(Credentials.builder()
.role(taskRole)
.build())
.executionRole(role)
.heartbeat(Duration.minutes(30))
.heartbeatTimeout(timeout)
.inputPath("inputPath")
.integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
.jobName("jobName")
.monitoring(Monitoring.builder()
.logBucket(bucket)
.logging(false)
.logGroup(logGroup)
.logStreamNamePrefix("logStreamNamePrefix")
.persistentAppUI(false)
.build())
.outputPath("outputPath")
.queryLanguage(QueryLanguage.JSON_PATH)
.resultPath("resultPath")
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.stateName("stateName")
.tags(Map.of(
"tagsKey", "tags"))
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.build();
// 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.IAM;
using Amazon.CDK.AWS.Logs;
using Amazon.CDK.AWS.S3;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
ApplicationConfiguration applicationConfiguration_;
var assign;
Bucket bucket;
Classification classification;
LogGroup logGroup;
ReleaseLabel releaseLabel;
var resultSelector;
Role role;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
VirtualClusterInput virtualClusterInput;
var emrContainersStartJobRunJsonPathProps = new EmrContainersStartJobRunJsonPathProps {
JobDriver = new JobDriver {
SparkSubmitJobDriver = new SparkSubmitJobDriver {
EntryPoint = taskInput,
// the properties below are optional
EntryPointArguments = taskInput,
SparkSubmitParameters = "sparkSubmitParameters"
}
},
ReleaseLabel = releaseLabel,
VirtualCluster = virtualClusterInput,
// the properties below are optional
ApplicationConfig = new [] { new ApplicationConfiguration {
Classification = classification,
// the properties below are optional
NestedConfig = new [] { applicationConfiguration_ },
Properties = new Dictionary<string, string> {
{ "propertiesKey", "properties" }
}
} },
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
Credentials = new Credentials {
Role = taskRole
},
ExecutionRole = role,
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
JobName = "jobName",
Monitoring = new Monitoring {
LogBucket = bucket,
Logging = false,
LogGroup = logGroup,
LogStreamNamePrefix = "logStreamNamePrefix",
PersistentAppUI = false
},
OutputPath = "outputPath",
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
StateName = "stateName",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TaskTimeout = timeout,
Timeout = Duration.Minutes(30)
};
// 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"
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 applicationConfiguration_ ApplicationConfiguration
var assign interface{}
var bucket Bucket
var classification Classification
var logGroup LogGroup
var releaseLabel ReleaseLabel
var resultSelector interface{}
var role Role
var taskInput TaskInput
var taskRole TaskRole
var timeout Timeout
var virtualClusterInput VirtualClusterInput
emrContainersStartJobRunJsonPathProps := &EmrContainersStartJobRunJsonPathProps{
JobDriver: &JobDriver{
SparkSubmitJobDriver: &SparkSubmitJobDriver{
EntryPoint: taskInput,
// the properties below are optional
EntryPointArguments: taskInput,
SparkSubmitParameters: jsii.String("sparkSubmitParameters"),
},
},
ReleaseLabel: releaseLabel,
VirtualCluster: virtualClusterInput,
// the properties below are optional
ApplicationConfig: []ApplicationConfiguration{
&ApplicationConfiguration{
Classification: classification,
// the properties below are optional
NestedConfig: []ApplicationConfiguration{
applicationConfiguration_,
},
Properties: map[string]*string{
"propertiesKey": jsii.String("properties"),
},
},
},
Assign: map[string]interface{}{
"assignKey": assign,
},
Comment: jsii.String("comment"),
Credentials: &Credentials{
Role: taskRole,
},
ExecutionRole: role,
Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
HeartbeatTimeout: timeout,
InputPath: jsii.String("inputPath"),
IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
JobName: jsii.String("jobName"),
Monitoring: &Monitoring{
LogBucket: bucket,
Logging: jsii.Boolean(false),
LogGroup: logGroup,
LogStreamNamePrefix: jsii.String("logStreamNamePrefix"),
PersistentAppUI: jsii.Boolean(false),
},
OutputPath: jsii.String("outputPath"),
QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultPath: jsii.String("resultPath"),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
StateName: jsii.String("stateName"),
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
TaskTimeout: timeout,
Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}
Properties
applicationConfigoptionalApplicationConfiguration[]application_configoptionaltyping.List[ApplicationConfiguration]applicationConfigoptionalList<ApplicationConfiguration>ApplicationConfigoptionalApplicationConfiguration[]ApplicationConfigoptional*[]ApplicationConfiguration #Default: No application config
Maximum of 100 items
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{} #Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #Default: No comment
credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials #Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole #Default: Automatically generated only when the provided virtualClusterId is not an encoded JSON path
If virtualClusterId is from a JSON input path, an execution role must be provided. If an execution role is provided, follow the documentation to update the role trust policy.
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern #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.
jobDriverJobDriverjob_driverJobDriverjobDriverJobDriverJobDriverJobDriverJobDriverJobDriver required #jobNameoptionalstringjob_nameoptionalstrjobNameoptionalStringJobNameoptionalstringJobNameoptional*string #Default: No job run name
monitoringoptionalMonitoringmonitoringoptionalMonitoringmonitoringoptionalMonitoringMonitoringoptionalMonitoringMonitoringoptionalMonitoring #Default: logging enabled and resources automatically generated if monitoring.logging is set to true
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = JSONPath #If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
releaseLabelReleaseLabelrelease_labelReleaseLabelreleaseLabelReleaseLabelReleaseLabelReleaseLabelReleaseLabelReleaseLabel required #resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string = $ #May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{} = None #You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #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 = None #taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout = None #[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration = None deprecated #virtualClusterVirtualClusterInputvirtual_clusterVirtualClusterInputvirtualClusterVirtualClusterInputVirtualClusterVirtualClusterInputVirtualClusterVirtualClusterInput required #