Class: AWSCDK::StepFunctionsTasks::EMRCreateClusterJsonataProps

Inherits:
AWSCDK::StepFunctions::TaskStateJsonataBaseProps
  • Object
show all
Defined in:
step_functions_tasks/emr_create_cluster_jsonata_props.rb

Overview

Properties for calling an AWS service's API action using JSONata from your state machine across regions.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil, instances:, name:, additional_info: nil, applications: nil, auto_scaling_role: nil, auto_termination_policy_idle_timeout: nil, bootstrap_actions: nil, cluster_role: nil, configurations: nil, custom_ami_id: nil, ebs_root_volume_iops: nil, ebs_root_volume_size: nil, ebs_root_volume_throughput: nil, kerberos_attributes: nil, log_uri: nil, managed_scaling_policy: nil, release_label: nil, scale_down_behavior: nil, security_configuration: nil, service_role: nil, step_concurrency_level: nil, tags: nil, visible_to_all_users: nil) ⇒ EMRCreateClusterJsonataProps

Returns a new instance of EMRCreateClusterJsonataProps.

Parameters:

  • comment (String, nil) (defaults to: nil) —

    A comment describing this state.

  • query_language (AWSCDK::StepFunctions::QueryLanguage, nil) (defaults to: nil) —

    The name of the query language used by the state.

  • state_name (String, nil) (defaults to: nil) —

    Optional name for this state.

  • credentials (AWSCDK::StepFunctions::Credentials, nil) (defaults to: nil) —

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

  • heartbeat (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • heartbeat_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the heartbeat.

  • integration_pattern (AWSCDK::StepFunctions::IntegrationPattern, nil) (defaults to: nil) —

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

  • task_timeout (AWSCDK::StepFunctions::Timeout, nil) (defaults to: nil) —

    Timeout for the task.

  • timeout (AWSCDK::Duration, nil) (defaults to: nil) —

    Timeout for the task.

  • assign (Hash{String => Object}, nil) (defaults to: nil) —

    Workflow variables to store in this step.

  • outputs (Object, nil) (defaults to: nil) —

    Used to specify and transform output from the state.

  • instances (AWSCDK::StepFunctionsTasks::EMRCreateCluster::InstancesConfigProperty) —

    A specification of the number and type of Amazon EC2 instances.

  • name (String) —

    The Name of the Cluster.

  • additional_info (String, nil) (defaults to: nil) —

    A JSON string for selecting additional features.

  • applications (Array<AWSCDK::StepFunctionsTasks::EMRCreateCluster::ApplicationConfigProperty>, nil) (defaults to: nil) —

    A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.

  • auto_scaling_role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    An IAM role for automatic scaling policies.

  • auto_termination_policy_idle_timeout (AWSCDK::Duration, nil) (defaults to: nil) —

    The amount of idle time after which the cluster automatically terminates.

  • bootstrap_actions (Array<AWSCDK::StepFunctionsTasks::EMRCreateCluster::BootstrapActionConfigProperty>, nil) (defaults to: nil) —

    A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

  • cluster_role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    Also called instance profile and EC2 role.

  • configurations (Array<AWSCDK::StepFunctionsTasks::EMRCreateCluster::ConfigurationProperty>, nil) (defaults to: nil) —

    The list of configurations supplied for the EMR cluster you are creating.

  • custom_ami_id (String, nil) (defaults to: nil) —

    The ID of a custom Amazon EBS-backed Linux AMI.

  • ebs_root_volume_iops (Numeric, nil) (defaults to: nil) —

    The IOPS of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

  • ebs_root_volume_size (AWSCDK::Size, nil) (defaults to: nil) —

    The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

  • ebs_root_volume_throughput (Numeric, nil) (defaults to: nil) —

    The throughput, in MiB/s, of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

  • kerberos_attributes (AWSCDK::StepFunctionsTasks::EMRCreateCluster::KerberosAttributesProperty, nil) (defaults to: nil) —

    Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

  • log_uri (String, nil) (defaults to: nil) —

    The location in Amazon S3 to write the log files of the job flow.

  • managed_scaling_policy (AWSCDK::StepFunctionsTasks::EMRCreateCluster::ManagedScalingPolicyProperty, nil) (defaults to: nil) —

    The specified managed scaling policy for an Amazon EMR cluster.

  • release_label (String, nil) (defaults to: nil) —

    The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.

  • scale_down_behavior (AWSCDK::StepFunctionsTasks::EMRCreateCluster::EMRClusterScaleDownBehavior, nil) (defaults to: nil) —

    Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

  • security_configuration (String, nil) (defaults to: nil) —

    The name of a security configuration to apply to the cluster.

  • service_role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

  • step_concurrency_level (Numeric, nil) (defaults to: nil) —

    Specifies the step concurrency level to allow multiple steps to run in parallel.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

  • visible_to_all_users (Boolean, nil) (defaults to: nil) —

    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.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 41

def initialize(comment: nil, query_language: nil, state_name: nil, credentials: nil, heartbeat: nil, heartbeat_timeout: nil, integration_pattern: nil, task_timeout: nil, timeout: nil, assign: nil, outputs: nil, instances:, name:, additional_info: nil, applications: nil, auto_scaling_role: nil, auto_termination_policy_idle_timeout: nil, bootstrap_actions: nil, cluster_role: nil, configurations: nil, custom_ami_id: nil, ebs_root_volume_iops: nil, ebs_root_volume_size: nil, ebs_root_volume_throughput: nil, kerberos_attributes: nil, log_uri: nil, managed_scaling_policy: nil, release_label: nil, scale_down_behavior: nil, security_configuration: nil, service_role: nil, step_concurrency_level: nil, tags: nil, visible_to_all_users: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @query_language = query_language
  Jsii::Type.check_type(@query_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5RdWVyeUxhbmd1YWdlIn0=")), "queryLanguage") unless @query_language.nil?
  @state_name = state_name
  Jsii::Type.check_type(@state_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateName") unless @state_name.nil?
  @credentials = credentials.is_a?(Hash) ? ::AWSCDK::StepFunctions::Credentials.new(**credentials.transform_keys(&:to_sym)) : credentials
  Jsii::Type.check_type(@credentials, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DcmVkZW50aWFscyJ9")), "credentials") unless @credentials.nil?
  @heartbeat = heartbeat
  Jsii::Type.check_type(@heartbeat, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "heartbeat") unless @heartbeat.nil?
  @heartbeat_timeout = heartbeat_timeout
  Jsii::Type.check_type(@heartbeat_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "heartbeatTimeout") unless @heartbeat_timeout.nil?
  @integration_pattern = integration_pattern
  Jsii::Type.check_type(@integration_pattern, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JbnRlZ3JhdGlvblBhdHRlcm4ifQ==")), "integrationPattern") unless @integration_pattern.nil?
  @task_timeout = task_timeout
  Jsii::Type.check_type(@task_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UaW1lb3V0In0=")), "taskTimeout") unless @task_timeout.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "timeout") unless @timeout.nil?
  @assign = assign
  Jsii::Type.check_type(@assign, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "assign") unless @assign.nil?
  @outputs = outputs
  Jsii::Type.check_type(@outputs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "outputs") unless @outputs.nil?
  @instances = instances.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::EMRCreateCluster::InstancesConfigProperty.new(**instances.transform_keys(&:to_sym)) : instances
  Jsii::Type.check_type(@instances, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5FbXJDcmVhdGVDbHVzdGVyLkluc3RhbmNlc0NvbmZpZ1Byb3BlcnR5In0=")), "instances")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @additional_info = additional_info
  Jsii::Type.check_type(@additional_info, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "additionalInfo") unless @additional_info.nil?
  @applications = applications.is_a?(Array) ? applications.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::EMRCreateCluster::ApplicationConfigProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : applications
  Jsii::Type.check_type(@applications, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkVtckNyZWF0ZUNsdXN0ZXIuQXBwbGljYXRpb25Db25maWdQcm9wZXJ0eSJ9LCJraW5kIjoiYXJyYXkifX0=")), "applications") unless @applications.nil?
  @auto_scaling_role = auto_scaling_role
  Jsii::Type.check_type(@auto_scaling_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "autoScalingRole") unless @auto_scaling_role.nil?
  @auto_termination_policy_idle_timeout = auto_termination_policy_idle_timeout
  Jsii::Type.check_type(@auto_termination_policy_idle_timeout, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "autoTerminationPolicyIdleTimeout") unless @auto_termination_policy_idle_timeout.nil?
  @bootstrap_actions = bootstrap_actions.is_a?(Array) ? bootstrap_actions.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::EMRCreateCluster::BootstrapActionConfigProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : bootstrap_actions
  Jsii::Type.check_type(@bootstrap_actions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkVtckNyZWF0ZUNsdXN0ZXIuQm9vdHN0cmFwQWN0aW9uQ29uZmlnUHJvcGVydHkifSwia2luZCI6ImFycmF5In19")), "bootstrapActions") unless @bootstrap_actions.nil?
  @cluster_role = cluster_role
  Jsii::Type.check_type(@cluster_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "clusterRole") unless @cluster_role.nil?
  @configurations = configurations.is_a?(Array) ? configurations.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::EMRCreateCluster::ConfigurationProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : configurations
  Jsii::Type.check_type(@configurations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkVtckNyZWF0ZUNsdXN0ZXIuQ29uZmlndXJhdGlvblByb3BlcnR5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "configurations") unless @configurations.nil?
  @custom_ami_id = custom_ami_id
  Jsii::Type.check_type(@custom_ami_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customAmiId") unless @custom_ami_id.nil?
  @ebs_root_volume_iops = ebs_root_volume_iops
  Jsii::Type.check_type(@ebs_root_volume_iops, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ebsRootVolumeIops") unless @ebs_root_volume_iops.nil?
  @ebs_root_volume_size = ebs_root_volume_size
  Jsii::Type.check_type(@ebs_root_volume_size, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TaXplIn0=")), "ebsRootVolumeSize") unless @ebs_root_volume_size.nil?
  @ebs_root_volume_throughput = ebs_root_volume_throughput
  Jsii::Type.check_type(@ebs_root_volume_throughput, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ebsRootVolumeThroughput") unless @ebs_root_volume_throughput.nil?
  @kerberos_attributes = kerberos_attributes.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::EMRCreateCluster::KerberosAttributesProperty.new(**kerberos_attributes.transform_keys(&:to_sym)) : kerberos_attributes
  Jsii::Type.check_type(@kerberos_attributes, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5FbXJDcmVhdGVDbHVzdGVyLktlcmJlcm9zQXR0cmlidXRlc1Byb3BlcnR5In0=")), "kerberosAttributes") unless @kerberos_attributes.nil?
  @log_uri = log_uri
  Jsii::Type.check_type(@log_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logUri") unless @log_uri.nil?
  @managed_scaling_policy = managed_scaling_policy.is_a?(Hash) ? ::AWSCDK::StepFunctionsTasks::EMRCreateCluster::ManagedScalingPolicyProperty.new(**managed_scaling_policy.transform_keys(&:to_sym)) : managed_scaling_policy
  Jsii::Type.check_type(@managed_scaling_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5FbXJDcmVhdGVDbHVzdGVyLk1hbmFnZWRTY2FsaW5nUG9saWN5UHJvcGVydHkifQ==")), "managedScalingPolicy") unless @managed_scaling_policy.nil?
  @release_label = release_label
  Jsii::Type.check_type(@release_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "releaseLabel") unless @release_label.nil?
  @scale_down_behavior = scale_down_behavior
  Jsii::Type.check_type(@scale_down_behavior, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5FbXJDcmVhdGVDbHVzdGVyLkVtckNsdXN0ZXJTY2FsZURvd25CZWhhdmlvciJ9")), "scaleDownBehavior") unless @scale_down_behavior.nil?
  @security_configuration = security_configuration
  Jsii::Type.check_type(@security_configuration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "securityConfiguration") unless @security_configuration.nil?
  @service_role = service_role
  Jsii::Type.check_type(@service_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "serviceRole") unless @service_role.nil?
  @step_concurrency_level = step_concurrency_level
  Jsii::Type.check_type(@step_concurrency_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "stepConcurrencyLevel") unless @step_concurrency_level.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @visible_to_all_users = visible_to_all_users
  Jsii::Type.check_type(@visible_to_all_users, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "visibleToAllUsers") unless @visible_to_all_users.nil?
end

Instance Attribute Details

#additional_info ⇒ String? (readonly)

Note:

Default: - None

A JSON string for selecting additional features.

Returns:

  • (String, nil) 


208
209
210
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 208

def additional_info
  @additional_info
end

#applications ⇒ Array<AWSCDK::StepFunctionsTasks::EMRCreateCluster::ApplicationConfigProperty>? (readonly)

Note:

Default: - EMR selected default

A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster.

Returns:



213
214
215
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 213

def applications
  @applications
end

#assign ⇒ Hash{String => Object}? (readonly)

Note:

Default: - Not assign variables

Workflow variables to store in this step.

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

Returns:

  • (Hash{String => Object}, nil)

See Also:



183
184
185
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 183

def assign
  @assign
end

#auto_scaling_role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - A role will be created.

An IAM role for automatic scaling policies.

Returns:



218
219
220
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 218

def auto_scaling_role
  @auto_scaling_role
end

#auto_termination_policy_idle_timeout ⇒ AWSCDK::Duration? (readonly)

Note:

Default: - No timeout

The amount of idle time after which the cluster automatically terminates.

You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).

Returns:



225
226
227
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 225

def auto_termination_policy_idle_timeout
  @auto_termination_policy_idle_timeout
end

#bootstrap_actions ⇒ Array<AWSCDK::StepFunctionsTasks::EMRCreateCluster::BootstrapActionConfigProperty>? (readonly)

Note:

Default: - None

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

Returns:



230
231
232
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 230

def bootstrap_actions
  @bootstrap_actions
end

#cluster_role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - * A Role will be created

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.

Returns:



239
240
241
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 239

def cluster_role
  @cluster_role
end

#comment ⇒ String? (readonly)

Note:

Default: No comment

A comment describing this state.

Returns:

  • (String, nil) 


116
117
118
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 116

def comment
  @comment
end

#configurations ⇒ Array<AWSCDK::StepFunctionsTasks::EMRCreateCluster::ConfigurationProperty>? (readonly)

Note:

Default: - None

The list of configurations supplied for the EMR cluster you are creating.

Returns:



244
245
246
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 244

def configurations
  @configurations
end

#credentials ⇒ AWSCDK::StepFunctions::Credentials? (readonly)

Note:

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

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

This enables cross-account resource invocations.

Returns:

See Also:



137
138
139
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 137

def credentials
  @credentials
end

#custom_ami_id ⇒ String? (readonly)

Note:

Default: - None

The ID of a custom Amazon EBS-backed Linux AMI.

Returns:

  • (String, nil) 


249
250
251
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 249

def custom_ami_id
  @custom_ami_id
end

#ebs_root_volume_iops ⇒ Numeric? (readonly)

Note:

Default: - EMR selected default

The IOPS of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

Requires EMR release label 6.15.0 or above. Must be in range [3000, 16000].

Returns:

  • (Numeric, nil)

See Also:



258
259
260
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 258

def ebs_root_volume_iops
  @ebs_root_volume_iops
end

#ebs_root_volume_size ⇒ AWSCDK::Size? (readonly)

Note:

Default: - EMR selected default

The size of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

Returns:



263
264
265
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 263

def ebs_root_volume_size
  @ebs_root_volume_size
end

#ebs_root_volume_throughput ⇒ Numeric? (readonly)

Note:

Default: - EMR selected default

The throughput, in MiB/s, of the EBS root device volume of the Linux AMI that is used for each EC2 instance.

Requires EMR release label 6.15.0 or above. Must be in range [125, 1000].

Returns:

  • (Numeric, nil)

See Also:



272
273
274
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 272

def ebs_root_volume_throughput
  @ebs_root_volume_throughput
end

#heartbeat ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use heartbeatTimeout

Note:

Default: - None

Timeout for the heartbeat.

Returns:



143
144
145
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 143

def heartbeat
  @heartbeat
end

#heartbeat_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the heartbeat.

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

Returns:



151
152
153
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 151

def heartbeat_timeout
  @heartbeat_timeout
end

#instances ⇒ AWSCDK::StepFunctionsTasks::EMRCreateCluster::InstancesConfigProperty (readonly)

A specification of the number and type of Amazon EC2 instances.

Returns:



199
200
201
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 199

def instances
  @instances
end

#integration_pattern ⇒ AWSCDK::StepFunctions::IntegrationPattern? (readonly)

Note:

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

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

You can control these AWS services using service integration patterns.

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

Returns:

See Also:



161
162
163
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 161

def integration_pattern
  @integration_pattern
end

#kerberos_attributes ⇒ AWSCDK::StepFunctionsTasks::EMRCreateCluster::KerberosAttributesProperty? (readonly)

Note:

Default: - None

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration.

Returns:



277
278
279
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 277

def kerberos_attributes
  @kerberos_attributes
end

#log_uri ⇒ String? (readonly)

Note:

Default: - None

The location in Amazon S3 to write the log files of the job flow.

Returns:

  • (String, nil) 


282
283
284
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 282

def log_uri
  @log_uri
end

#managed_scaling_policy ⇒ AWSCDK::StepFunctionsTasks::EMRCreateCluster::ManagedScalingPolicyProperty? (readonly)

Note:

Default: - None

The specified managed scaling policy for an Amazon EMR cluster.

Returns:



287
288
289
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 287

def managed_scaling_policy
  @managed_scaling_policy
end

#name ⇒ String (readonly)

The Name of the Cluster.

Returns:

  • (String) 


203
204
205
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 203

def name
  @name
end

#outputs ⇒ Object? (readonly)

Note:

Default: - $states.result or $states.errorOutput

Used to specify and transform output from the state.

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.

Returns:

  • (Object, nil)

See Also:



195
196
197
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 195

def outputs
  @outputs
end

#query_language ⇒ AWSCDK::StepFunctions::QueryLanguage? (readonly)

Note:

Default: - JSONPath

The name of the query language used by the state.

If the state does not contain a query_language field, then it will use the query language specified in the top-level query_language field.

Returns:



124
125
126
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 124

def query_language
  @query_language
end

#release_label ⇒ String? (readonly)

Note:

Default: - EMR selected default

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster.

Returns:

  • (String, nil) 


292
293
294
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 292

def release_label
  @release_label
end

#scale_down_behavior ⇒ AWSCDK::StepFunctionsTasks::EMRCreateCluster::EMRClusterScaleDownBehavior? (readonly)

Note:

Default: - EMR selected default

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized.

Returns:



297
298
299
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 297

def scale_down_behavior
  @scale_down_behavior
end

#security_configuration ⇒ String? (readonly)

Note:

Default: - None

The name of a security configuration to apply to the cluster.

Returns:

  • (String, nil) 


302
303
304
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 302

def security_configuration
  @security_configuration
end

#service_role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - A role will be created that Amazon EMR service can assume.

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

Returns:



307
308
309
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 307

def service_role
  @service_role
end

#state_name ⇒ String? (readonly)

Note:

Default: - The construct ID will be used as state name

Optional name for this state.

Returns:

  • (String, nil) 


129
130
131
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 129

def state_name
  @state_name
end

#step_concurrency_level ⇒ Numeric? (readonly)

Note:

Default: 1 - no step concurrency allowed

Specifies the step concurrency level to allow multiple steps to run in parallel.

Requires EMR release label 5.28.0 or above. Must be in range [1, 256].

Returns:

  • (Numeric, nil) 


315
316
317
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 315

def step_concurrency_level
  @step_concurrency_level
end

#tags ⇒ Hash{String => String}? (readonly)

Note:

Default: - None

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

Returns:

  • (Hash{String => String}, nil) 


320
321
322
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 320

def tags
  @tags
end

#task_timeout ⇒ AWSCDK::StepFunctions::Timeout? (readonly)

Note:

Default: - None

Timeout for the task.

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

Returns:



169
170
171
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 169

def task_timeout
  @task_timeout
end

#timeout ⇒ AWSCDK::Duration? (readonly)

Deprecated.

use taskTimeout

Note:

Default: - None

Timeout for the task.

Returns:



175
176
177
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 175

def timeout
  @timeout
end

#visible_to_all_users ⇒ Boolean? (readonly)

Note:

Default: true

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.

Returns:

  • (Boolean, nil) 


325
326
327
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 325

def visible_to_all_users
  @visible_to_all_users
end

Class Method Details

.jsii_properties ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 327

def self.jsii_properties
  {
    :comment => "comment",
    :query_language => "queryLanguage",
    :state_name => "stateName",
    :credentials => "credentials",
    :heartbeat => "heartbeat",
    :heartbeat_timeout => "heartbeatTimeout",
    :integration_pattern => "integrationPattern",
    :task_timeout => "taskTimeout",
    :timeout => "timeout",
    :assign => "assign",
    :outputs => "outputs",
    :instances => "instances",
    :name => "name",
    :additional_info => "additionalInfo",
    :applications => "applications",
    :auto_scaling_role => "autoScalingRole",
    :auto_termination_policy_idle_timeout => "autoTerminationPolicyIdleTimeout",
    :bootstrap_actions => "bootstrapActions",
    :cluster_role => "clusterRole",
    :configurations => "configurations",
    :custom_ami_id => "customAmiId",
    :ebs_root_volume_iops => "ebsRootVolumeIops",
    :ebs_root_volume_size => "ebsRootVolumeSize",
    :ebs_root_volume_throughput => "ebsRootVolumeThroughput",
    :kerberos_attributes => "kerberosAttributes",
    :log_uri => "logUri",
    :managed_scaling_policy => "managedScalingPolicy",
    :release_label => "releaseLabel",
    :scale_down_behavior => "scaleDownBehavior",
    :security_configuration => "securityConfiguration",
    :service_role => "serviceRole",
    :step_concurrency_level => "stepConcurrencyLevel",
    :tags => "tags",
    :visible_to_all_users => "visibleToAllUsers",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'step_functions_tasks/emr_create_cluster_jsonata_props.rb', line 366

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "comment" => @comment,
    "queryLanguage" => @query_language,
    "stateName" => @state_name,
    "credentials" => @credentials,
    "heartbeat" => @heartbeat,
    "heartbeatTimeout" => @heartbeat_timeout,
    "integrationPattern" => @integration_pattern,
    "taskTimeout" => @task_timeout,
    "timeout" => @timeout,
    "assign" => @assign,
    "outputs" => @outputs,
    "instances" => @instances,
    "name" => @name,
    "additionalInfo" => @additional_info,
    "applications" => @applications,
    "autoScalingRole" => @auto_scaling_role,
    "autoTerminationPolicyIdleTimeout" => @auto_termination_policy_idle_timeout,
    "bootstrapActions" => @bootstrap_actions,
    "clusterRole" => @cluster_role,
    "configurations" => @configurations,
    "customAmiId" => @custom_ami_id,
    "ebsRootVolumeIops" => @ebs_root_volume_iops,
    "ebsRootVolumeSize" => @ebs_root_volume_size,
    "ebsRootVolumeThroughput" => @ebs_root_volume_throughput,
    "kerberosAttributes" => @kerberos_attributes,
    "logUri" => @log_uri,
    "managedScalingPolicy" => @managed_scaling_policy,
    "releaseLabel" => @release_label,
    "scaleDownBehavior" => @scale_down_behavior,
    "securityConfiguration" => @security_configuration,
    "serviceRole" => @service_role,
    "stepConcurrencyLevel" => @step_concurrency_level,
    "tags" => @tags,
    "visibleToAllUsers" => @visible_to_all_users,
  })
  result.compact
end