EmrCreateClusterProps Struct
Properties for calling an AWS service's API action from your state machine across regions.
Example
new tasks.EmrCreateCluster(this, 'PrioritizedAllocation', {
instances: {
instanceFleets: [{
instanceFleetType: tasks.EmrCreateCluster.InstanceRoleType.CORE,
instanceTypeConfigs: [{
instanceType: 'm5.large',
priority: 0, // Highest priority
}, {
instanceType: 'm5.xlarge',
priority: 1, // Lower priority
}],
launchSpecifications: {
onDemandSpecification: {
allocationStrategy: tasks.EmrCreateCluster.OnDemandAllocationStrategy.PRIORITIZED,
},
},
targetOnDemandCapacity: 2,
}],
},
name: 'PrioritizedCluster',
integrationPattern: sfn.IntegrationPattern.RUN_JOB,
});
Properties
additionalInfooptionalstringadditional_infooptionalstradditionalInfooptionalStringAdditionalInfooptionalstringAdditionalInfooptional*string= None#applicationsoptionalEmrCreateCluster.ApplicationConfigProperty[]applicationsoptionaltyping.List[ApplicationConfigProperty]applicationsoptionalList<ApplicationConfigProperty>ApplicationsoptionalApplicationConfigProperty[]Applicationsoptional*[]ApplicationConfigProperty#Default: EMR selected default
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.
autoScalingRoleoptionalIRoleauto_scaling_roleoptionalIRoleautoScalingRoleoptionalIRoleAutoScalingRoleoptionalIRoleAutoScalingRoleoptionalIRole#Default: A role will be created.
autoTerminationPolicyIdleTimeoutoptionalDurationauto_termination_policy_idle_timeoutoptionalDurationautoTerminationPolicyIdleTimeoutoptionalDurationAutoTerminationPolicyIdleTimeoutoptionalDurationAutoTerminationPolicyIdleTimeoutoptionalDuration#Default: No timeout
You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).
bootstrapActionsoptionalEmrCreateCluster.BootstrapActionConfigProperty[]bootstrap_actionsoptionaltyping.List[BootstrapActionConfigProperty]bootstrapActionsoptionalList<BootstrapActionConfigProperty>BootstrapActionsoptionalBootstrapActionConfigProperty[]BootstrapActionsoptional*[]BootstrapActionConfigProperty= None#clusterRoleoptionalIRolecluster_roleoptionalIRoleclusterRoleoptionalIRoleClusterRoleoptionalIRoleClusterRoleoptionalIRole#Default: * A Role will be created
An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role.
This attribute has been renamed from jobFlowRole to clusterRole to align with other ERM/StepFunction integration parameters.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#Default: No comment
configurationsoptionalEmrCreateCluster.ConfigurationProperty[]configurationsoptionaltyping.List[ConfigurationProperty]configurationsoptionalList<ConfigurationProperty>ConfigurationsoptionalConfigurationProperty[]Configurationsoptional*[]ConfigurationProperty= None#credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#Default: None (Task is executed using the State Machine's execution role)
This enables cross-account resource invocations.
customAmiIdoptionalstringcustom_ami_idoptionalstrcustomAmiIdoptionalStringCustomAmiIdoptionalstringCustomAmiIdoptional*string= None#ebsRootVolumeIopsoptionalnumberebs_root_volume_iopsoptionalint | floatebsRootVolumeIopsoptionalNumberEbsRootVolumeIopsoptionaldoubleEbsRootVolumeIopsoptional*float64#Default: EMR selected default
Requires EMR release label 6.15.0 or above. Must be in range [3000, 16000].
ebsRootVolumeSizeoptionalSizeebs_root_volume_sizeoptionalSizeebsRootVolumeSizeoptionalSizeEbsRootVolumeSizeoptionalSizeEbsRootVolumeSizeoptionalSize#Default: EMR selected default
ebsRootVolumeThroughputoptionalnumberebs_root_volume_throughputoptionalint | floatebsRootVolumeThroughputoptionalNumberEbsRootVolumeThroughputoptionaldoubleEbsRootVolumeThroughputoptional*float64#Default: EMR selected default
Requires EMR release label 6.15.0 or above. Must be in range [125, 1000].
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#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 {}.
instancesEmrCreateCluster.InstancesConfigPropertyinstancesInstancesConfigPropertyinstancesInstancesConfigPropertyInstancesInstancesConfigPropertyInstancesInstancesConfigPropertyrequired#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.
kerberosAttributesoptionalEmrCreateCluster.KerberosAttributesPropertykerberos_attributesoptionalKerberosAttributesPropertykerberosAttributesoptionalKerberosAttributesPropertyKerberosAttributesoptionalKerberosAttributesPropertyKerberosAttributesoptionalKerberosAttributesProperty= None#logUrioptionalstringlog_urioptionalstrlogUrioptionalStringLogUrioptionalstringLogUrioptional*string= None#managedScalingPolicyoptionalEmrCreateCluster.ManagedScalingPolicyPropertymanaged_scaling_policyoptionalManagedScalingPolicyPropertymanagedScalingPolicyoptionalManagedScalingPolicyPropertyManagedScalingPolicyoptionalManagedScalingPolicyPropertyManagedScalingPolicyoptionalManagedScalingPolicyProperty= None#outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#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#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
releaseLabeloptionalstringrelease_labeloptionalstrreleaseLabeloptionalStringReleaseLabeloptionalstringReleaseLabeloptional*string#Default: EMR selected default
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.
scaleDownBehavioroptionalEmrCreateCluster.EmrClusterScaleDownBehaviorscale_down_behavioroptionalEmrClusterScaleDownBehaviorscaleDownBehavioroptionalEmrClusterScaleDownBehaviorScaleDownBehavioroptionalEmrClusterScaleDownBehaviorScaleDownBehavioroptionalEmrClusterScaleDownBehavior#Default: EMR selected default
securityConfigurationoptionalstringsecurity_configurationoptionalstrsecurityConfigurationoptionalStringSecurityConfigurationoptionalstringSecurityConfigurationoptional*string= None#serviceRoleoptionalIRoleservice_roleoptionalIRoleserviceRoleoptionalIRoleServiceRoleoptionalIRoleServiceRoleoptionalIRole#Default: A role will be created that Amazon EMR service can assume.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#Default: The construct ID will be used as state name
stepConcurrencyLeveloptionalnumberstep_concurrency_leveloptionalint | floatstepConcurrencyLeveloptionalNumberStepConcurrencyLeveloptionaldoubleStepConcurrencyLeveloptional*float64#Default: 1 - no step concurrency allowed
Requires EMR release label 5.28.0 or above. Must be in range [1, 256].
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= Nonedeprecated#visibleToAllUsersoptionalbooleanvisible_to_all_usersoptionalboolvisibleToAllUsersoptionalBooleanVisibleToAllUsersoptionalboolVisibleToAllUsersoptional*bool= true#