Skip to content
v2.277.0

EmrModifyInstanceGroupByNameJsonPathProps Struct ​

Properties for EmrModifyInstanceGroupByName using JSONPath.

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 configurationProperty_: stepfunctions_tasks.EmrCreateCluster.ConfigurationProperty;
declare const resultSelector: any;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const emrModifyInstanceGroupByNameJsonPathProps: stepfunctions_tasks.EmrModifyInstanceGroupByNameJsonPathProps = {
  clusterId: 'clusterId',
  instanceGroup: {
    configurations: [{
      classification: 'classification',
      configurations: [configurationProperty_],
      properties: {
        propertiesKey: 'properties',
      },
    }],
    eC2InstanceIdsToTerminate: ['eC2InstanceIdsToTerminate'],
    instanceCount: 123,
    shrinkPolicy: {
      decommissionTimeout: cdk.Duration.minutes(30),
      instanceResizePolicy: {
        instancesToProtect: ['instancesToProtect'],
        instancesToTerminate: ['instancesToTerminate'],
        instanceTerminationTimeout: cdk.Duration.minutes(30),
      },
    },
  },
  instanceGroupName: 'instanceGroupName',

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};
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
# configuration_property_: stepfunctions_tasks.EmrCreateCluster.ConfigurationProperty
# result_selector: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

emr_modify_instance_group_by_name_json_path_props = stepfunctions_tasks.EmrModifyInstanceGroupByNameJsonPathProps(
    cluster_id="clusterId",
    instance_group=stepfunctions_tasks.EmrModifyInstanceGroupByName.InstanceGroupModifyConfigProperty(
        configurations=[stepfunctions_tasks.EmrCreateCluster.ConfigurationProperty(
            classification="classification",
            configurations=[configuration_property_],
            properties={
                "properties_key": "properties"
            }
        )],
        e_c2_instance_ids_to_terminate=["eC2InstanceIdsToTerminate"],
        instance_count=123,
        shrink_policy=stepfunctions_tasks.EmrModifyInstanceGroupByName.ShrinkPolicyProperty(
            decommission_timeout=cdk.Duration.minutes(30),
            instance_resize_policy=stepfunctions_tasks.EmrModifyInstanceGroupByName.InstanceResizePolicyProperty(
                instances_to_protect=["instancesToProtect"],
                instances_to_terminate=["instancesToTerminate"],
                instance_termination_timeout=cdk.Duration.minutes(30)
            )
        )
    ),
    instance_group_name="instanceGroupName",

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    input_path="inputPath",
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    output_path="outputPath",
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)
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;
ConfigurationProperty configurationProperty_;
Object resultSelector;
TaskRole taskRole;
Timeout timeout;

EmrModifyInstanceGroupByNameJsonPathProps emrModifyInstanceGroupByNameJsonPathProps = EmrModifyInstanceGroupByNameJsonPathProps.builder()
        .clusterId("clusterId")
        .instanceGroup(InstanceGroupModifyConfigProperty.builder()
                .configurations(List.of(ConfigurationProperty.builder()
                        .classification("classification")
                        .configurations(List.of(configurationProperty_))
                        .properties(Map.of(
                                "propertiesKey", "properties"))
                        .build()))
                .eC2InstanceIdsToTerminate(List.of("eC2InstanceIdsToTerminate"))
                .instanceCount(123)
                .shrinkPolicy(ShrinkPolicyProperty.builder()
                        .decommissionTimeout(Duration.minutes(30))
                        .instanceResizePolicy(InstanceResizePolicyProperty.builder()
                                .instancesToProtect(List.of("instancesToProtect"))
                                .instancesToTerminate(List.of("instancesToTerminate"))
                                .instanceTerminationTimeout(Duration.minutes(30))
                                .build())
                        .build())
                .build())
        .instanceGroupName("instanceGroupName")

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .inputPath("inputPath")
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .outputPath("outputPath")
        .queryLanguage(QueryLanguage.JSON_PATH)
        .resultPath("resultPath")
        .resultSelector(Map.of(
                "resultSelectorKey", resultSelector))
        .stateName("stateName")
        .taskTimeout(timeout)
        .timeout(Duration.minutes(30))
        .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;
ConfigurationProperty configurationProperty_;
var resultSelector;
TaskRole taskRole;
Timeout timeout;

var emrModifyInstanceGroupByNameJsonPathProps = new EmrModifyInstanceGroupByNameJsonPathProps {
    ClusterId = "clusterId",
    InstanceGroup = new InstanceGroupModifyConfigProperty {
        Configurations = new [] { new ConfigurationProperty {
            Classification = "classification",
            Configurations = new [] { configurationProperty_ },
            Properties = new Dictionary<string, string> {
                { "propertiesKey", "properties" }
            }
        } },
        EC2InstanceIdsToTerminate = new [] { "eC2InstanceIdsToTerminate" },
        InstanceCount = 123,
        ShrinkPolicy = new ShrinkPolicyProperty {
            DecommissionTimeout = Duration.Minutes(30),
            InstanceResizePolicy = new InstanceResizePolicyProperty {
                InstancesToProtect = new [] { "instancesToProtect" },
                InstancesToTerminate = new [] { "instancesToTerminate" },
                InstanceTerminationTimeout = Duration.Minutes(30)
            }
        }
    },
    InstanceGroupName = "instanceGroupName",

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    Credentials = new Credentials {
        Role = taskRole
    },
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    InputPath = "inputPath",
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    OutputPath = "outputPath",
    QueryLanguage = QueryLanguage.JSON_PATH,
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30)
};
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 configurationProperty_ ConfigurationProperty
var resultSelector interface{}
var taskRole TaskRole
var timeout Timeout

emrModifyInstanceGroupByNameJsonPathProps := &EmrModifyInstanceGroupByNameJsonPathProps{
	ClusterId: jsii.String("clusterId"),
	InstanceGroup: &InstanceGroupModifyConfigProperty{
		Configurations: []ConfigurationProperty{
			&ConfigurationProperty{
				Classification: jsii.String("classification"),
				Configurations: []ConfigurationProperty{
					configurationProperty_,
				},
				Properties: map[string]*string{
					"propertiesKey": jsii.String("properties"),
				},
			},
		},
		EC2InstanceIdsToTerminate: []*string{
			jsii.String("eC2InstanceIdsToTerminate"),
		},
		InstanceCount: jsii.Number(123),
		ShrinkPolicy: &ShrinkPolicyProperty{
			DecommissionTimeout: cdk.Duration_Minutes(jsii.Number(30)),
			InstanceResizePolicy: &InstanceResizePolicyProperty{
				InstancesToProtect: []*string{
					jsii.String("instancesToProtect"),
				},
				InstancesToTerminate: []*string{
					jsii.String("instancesToTerminate"),
				},
				InstanceTerminationTimeout: cdk.Duration_*Minutes(jsii.Number(30)),
			},
		},
	},
	InstanceGroupName: jsii.String("instanceGroupName"),

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	Heartbeat: cdk.Duration_*Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	InputPath: jsii.String("inputPath"),
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	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"),
	TaskTimeout: timeout,
	Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}

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.

clusterIdstringcluster_idstrclusterIdStringClusterIdstringClusterId*string required #
The ClusterId to update.
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.

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

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string = $ #
JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

The JSON that you want to provide to your ModifyInstanceGroup call as input.

This uses the same syntax as the ModifyInstanceGroups API.

instanceGroupNamestringinstance_group_namestrinstanceGroupNameStringInstanceGroupNamestringInstanceGroupName*string required #
The InstanceGroupName to update.
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.

outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string = $ #
JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

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.

resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string = $ #
JSONPath expression to indicate where to inject the state's output.

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 #
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #
Optional name for this state.

Default: The construct ID will be used as state name

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`