EmrCreateClusterProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
EmrCreateClusterProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, instances, name, additional_info=None, applications=None, auto_scaling_role=None, bootstrap_actions=None, cluster_role=None, configurations=None, custom_ami_id=None, ebs_root_volume_size=None, kerberos_attributes=None, log_uri=None, release_label=None, scale_down_behavior=None, security_configuration=None, service_role=None, tags=None, visible_to_all_users=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
(experimental) Properties for EmrCreateCluster.
See the RunJobFlow API for complete documentation on input parameters
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_path (
Optional
[str
]) – 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 {}. Default: - The entire task input (JSON path ‘$’)integration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: IntegrationPattern.REQUEST_RESPONSEoutput_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. 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 ‘$’)result_path (
Optional
[str
]) – 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. Default: - Replaces the entire input with the result (JSON path ‘$’)timeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Noneinstances (
InstancesConfigProperty
) – (experimental) A specification of the number and type of Amazon EC2 instances.name (
str
) – (experimental) The Name of the Cluster.additional_info (
Optional
[str
]) – (experimental) A JSON string for selecting additional features. Default: - Noneapplications (
Optional
[List
[ApplicationConfigProperty
]]) – (experimental) A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. Default: - EMR selected defaultauto_scaling_role (
Optional
[IRole
]) – (experimental) An IAM role for automatic scaling policies. Default: - A role will be created.bootstrap_actions (
Optional
[List
[BootstrapActionConfigProperty
]]) – (experimental) A list of bootstrap actions to run before Hadoop starts on the cluster nodes. Default: - Nonecluster_role (
Optional
[IRole
]) – (experimental) Also called instance profile and EC2 role. 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. Default: - - A Role will be createdconfigurations (
Optional
[List
[ConfigurationProperty
]]) – (experimental) The list of configurations supplied for the EMR cluster you are creating. Default: - Nonecustom_ami_id (
Optional
[str
]) – (experimental) The ID of a custom Amazon EBS-backed Linux AMI. Default: - Noneebs_root_volume_size (
Optional
[Size
]) – (experimental) The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Default: - EMR selected defaultkerberos_attributes (
Optional
[KerberosAttributesProperty
]) – (experimental) Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. Default: - Nonelog_uri (
Optional
[str
]) – (experimental) The location in Amazon S3 to write the log files of the job flow. Default: - Nonerelease_label (
Optional
[str
]) – (experimental) The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Default: - EMR selected defaultscale_down_behavior (
Optional
[EmrClusterScaleDownBehavior
]) – (experimental) Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. Default: - EMR selected defaultsecurity_configuration (
Optional
[str
]) – (experimental) The name of a security configuration to apply to the cluster. Default: - Noneservice_role (
Optional
[IRole
]) – (experimental) The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. Default: - A role will be created that Amazon EMR service can assume.tags (
Optional
[Mapping
[str
,str
]]) – (experimental) A list of tags to associate with a cluster and propagate to Amazon EC2 instances. Default: - Nonevisible_to_all_users (
Optional
[bool
]) – (experimental) A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions. Default: true
- See
https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html
- Stability
experimental
Attributes
-
additional_info
¶ (experimental) A JSON string for selecting additional features.
- Default
None
- Stability
experimental
- Return type
Optional
[str
]
-
applications
¶ (experimental) A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.
- Default
EMR selected default
- Stability
experimental
- Return type
Optional
[List
[ApplicationConfigProperty
]]
-
auto_scaling_role
¶ (experimental) An IAM role for automatic scaling policies.
- Default
A role will be created.
- Stability
experimental
- Return type
Optional
[IRole
]
-
bootstrap_actions
¶ (experimental) A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
- Default
None
- Stability
experimental
- Return type
Optional
[List
[BootstrapActionConfigProperty
]]
-
cluster_role
¶ (experimental) Also called instance profile and EC2 role.
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.
- Default
A Role will be created
- Stability
experimental
- Return type
Optional
[IRole
]
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
configurations
¶ (experimental) The list of configurations supplied for the EMR cluster you are creating.
- Default
None
- Stability
experimental
- Return type
Optional
[List
[ConfigurationProperty
]]
-
custom_ami_id
¶ (experimental) The ID of a custom Amazon EBS-backed Linux AMI.
- Default
None
- Stability
experimental
- Return type
Optional
[str
]
-
ebs_root_volume_size
¶ (experimental) The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.
- Default
EMR selected default
- Stability
experimental
- Return type
Optional
[Size
]
-
input_path
¶ 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 {}.
- Default
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
instances
¶ (experimental) A specification of the number and type of Amazon EC2 instances.
- Stability
experimental
- Return type
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
- Return type
Optional
[IntegrationPattern
]
-
kerberos_attributes
¶ (experimental) Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.
- Default
None
- Stability
experimental
- Return type
Optional
[KerberosAttributesProperty
]
-
log_uri
¶ (experimental) The location in Amazon S3 to write the log files of the job flow.
- Default
None
- Stability
experimental
- Return type
Optional
[str
]
-
name
¶ (experimental) The Name of the Cluster.
- Stability
experimental
- Return type
str
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
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 ‘$’)
- Return type
Optional
[str
]
-
release_label
¶ (experimental) The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.
- Default
EMR selected default
- Stability
experimental
- Return type
Optional
[str
]
-
result_path
¶ 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.
- Default
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
scale_down_behavior
¶ (experimental) Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.
- Default
EMR selected default
- Stability
experimental
- Return type
Optional
[EmrClusterScaleDownBehavior
]
-
security_configuration
¶ (experimental) The name of a security configuration to apply to the cluster.
- Default
None
- Stability
experimental
- Return type
Optional
[str
]
-
service_role
¶ (experimental) The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
- Default
A role will be created that Amazon EMR service can assume.
- Stability
experimental
- Return type
Optional
[IRole
]
(experimental) A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
- Default
None
- Stability
experimental
- Return type
Optional
[Mapping
[str
,str
]]
-
visible_to_all_users
¶ (experimental) A value of true indicates that all IAM users in the AWS account can perform cluster actions if they have the proper IAM policy permissions.
- Default
true
- Stability
experimental
- Return type
Optional
[bool
]