You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EMR::Types::RunJobFlowInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RunJobFlowInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "XmlStringMaxLen256", # required
  log_uri: "XmlString",
  log_encryption_kms_key_id: "XmlString",
  additional_info: "XmlString",
  ami_version: "XmlStringMaxLen256",
  release_label: "XmlStringMaxLen256",
  instances: { # required
    master_instance_type: "InstanceType",
    slave_instance_type: "InstanceType",
    instance_count: 1,
    instance_groups: [
      {
        name: "XmlStringMaxLen256",
        market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
        instance_role: "MASTER", # required, accepts MASTER, CORE, TASK
        bid_price: "XmlStringMaxLen256",
        instance_type: "InstanceType", # required
        instance_count: 1, # required
        configurations: [
          {
            classification: "String",
            configurations: {
              # recursive ConfigurationList
            },
            properties: {
              "String" => "String",
            },
          },
        ],
        ebs_configuration: {
          ebs_block_device_configs: [
            {
              volume_specification: { # required
                volume_type: "String", # required
                iops: 1,
                size_in_gb: 1, # required
              },
              volumes_per_instance: 1,
            },
          ],
          ebs_optimized: false,
        },
        auto_scaling_policy: {
          constraints: { # required
            min_capacity: 1, # required
            max_capacity: 1, # required
          },
          rules: [ # required
            {
              name: "String", # required
              description: "String",
              action: { # required
                market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
                simple_scaling_policy_configuration: { # required
                  adjustment_type: "CHANGE_IN_CAPACITY", # accepts CHANGE_IN_CAPACITY, PERCENT_CHANGE_IN_CAPACITY, EXACT_CAPACITY
                  scaling_adjustment: 1, # required
                  cool_down: 1,
                },
              },
              trigger: { # required
                cloud_watch_alarm_definition: { # required
                  comparison_operator: "GREATER_THAN_OR_EQUAL", # required, accepts GREATER_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN, LESS_THAN_OR_EQUAL
                  evaluation_periods: 1,
                  metric_name: "String", # required
                  namespace: "String",
                  period: 1, # required
                  statistic: "SAMPLE_COUNT", # accepts SAMPLE_COUNT, AVERAGE, SUM, MINIMUM, MAXIMUM
                  threshold: 1.0, # required
                  unit: "NONE", # accepts NONE, SECONDS, MICRO_SECONDS, MILLI_SECONDS, BYTES, KILO_BYTES, MEGA_BYTES, GIGA_BYTES, TERA_BYTES, BITS, KILO_BITS, MEGA_BITS, GIGA_BITS, TERA_BITS, PERCENT, COUNT, BYTES_PER_SECOND, KILO_BYTES_PER_SECOND, MEGA_BYTES_PER_SECOND, GIGA_BYTES_PER_SECOND, TERA_BYTES_PER_SECOND, BITS_PER_SECOND, KILO_BITS_PER_SECOND, MEGA_BITS_PER_SECOND, GIGA_BITS_PER_SECOND, TERA_BITS_PER_SECOND, COUNT_PER_SECOND
                  dimensions: [
                    {
                      key: "String",
                      value: "String",
                    },
                  ],
                },
              },
            },
          ],
        },
      },
    ],
    instance_fleets: [
      {
        name: "XmlStringMaxLen256",
        instance_fleet_type: "MASTER", # required, accepts MASTER, CORE, TASK
        target_on_demand_capacity: 1,
        target_spot_capacity: 1,
        instance_type_configs: [
          {
            instance_type: "InstanceType", # required
            weighted_capacity: 1,
            bid_price: "XmlStringMaxLen256",
            bid_price_as_percentage_of_on_demand_price: 1.0,
            ebs_configuration: {
              ebs_block_device_configs: [
                {
                  volume_specification: { # required
                    volume_type: "String", # required
                    iops: 1,
                    size_in_gb: 1, # required
                  },
                  volumes_per_instance: 1,
                },
              ],
              ebs_optimized: false,
            },
            configurations: [
              {
                classification: "String",
                configurations: {
                  # recursive ConfigurationList
                },
                properties: {
                  "String" => "String",
                },
              },
            ],
          },
        ],
        launch_specifications: {
          spot_specification: {
            timeout_duration_minutes: 1, # required
            timeout_action: "SWITCH_TO_ON_DEMAND", # required, accepts SWITCH_TO_ON_DEMAND, TERMINATE_CLUSTER
            block_duration_minutes: 1,
            allocation_strategy: "capacity-optimized", # accepts capacity-optimized
          },
          on_demand_specification: {
            allocation_strategy: "lowest-price", # required, accepts lowest-price
          },
        },
      },
    ],
    ec2_key_name: "XmlStringMaxLen256",
    placement: {
      availability_zone: "XmlString",
      availability_zones: ["XmlStringMaxLen256"],
    },
    keep_job_flow_alive_when_no_steps: false,
    termination_protected: false,
    hadoop_version: "XmlStringMaxLen256",
    ec2_subnet_id: "XmlStringMaxLen256",
    ec2_subnet_ids: ["XmlStringMaxLen256"],
    emr_managed_master_security_group: "XmlStringMaxLen256",
    emr_managed_slave_security_group: "XmlStringMaxLen256",
    service_access_security_group: "XmlStringMaxLen256",
    additional_master_security_groups: ["XmlStringMaxLen256"],
    additional_slave_security_groups: ["XmlStringMaxLen256"],
  },
  steps: [
    {
      name: "XmlStringMaxLen256", # required
      action_on_failure: "TERMINATE_JOB_FLOW", # accepts TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
      hadoop_jar_step: { # required
        properties: [
          {
            key: "XmlString",
            value: "XmlString",
          },
        ],
        jar: "XmlString", # required
        main_class: "XmlString",
        args: ["XmlString"],
      },
    },
  ],
  bootstrap_actions: [
    {
      name: "XmlStringMaxLen256", # required
      script_bootstrap_action: { # required
        path: "XmlString", # required
        args: ["XmlString"],
      },
    },
  ],
  supported_products: ["XmlStringMaxLen256"],
  new_supported_products: [
    {
      name: "XmlStringMaxLen256",
      args: ["XmlString"],
    },
  ],
  applications: [
    {
      name: "String",
      version: "String",
      args: ["String"],
      additional_info: {
        "String" => "String",
      },
    },
  ],
  configurations: [
    {
      classification: "String",
      configurations: {
        # recursive ConfigurationList
      },
      properties: {
        "String" => "String",
      },
    },
  ],
  visible_to_all_users: false,
  job_flow_role: "XmlString",
  service_role: "XmlString",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  security_configuration: "XmlString",
  auto_scaling_role: "XmlString",
  scale_down_behavior: "TERMINATE_AT_INSTANCE_HOUR", # accepts TERMINATE_AT_INSTANCE_HOUR, TERMINATE_AT_TASK_COMPLETION
  custom_ami_id: "XmlStringMaxLen256",
  ebs_root_volume_size: 1,
  repo_upgrade_on_boot: "SECURITY", # accepts SECURITY, NONE
  kerberos_attributes: {
    realm: "XmlStringMaxLen256", # required
    kdc_admin_password: "XmlStringMaxLen256", # required
    cross_realm_trust_principal_password: "XmlStringMaxLen256",
    ad_domain_join_user: "XmlStringMaxLen256",
    ad_domain_join_password: "XmlStringMaxLen256",
  },
  step_concurrency_level: 1,
  managed_scaling_policy: {
    compute_limits: {
      unit_type: "InstanceFleetUnits", # required, accepts InstanceFleetUnits, Instances, VCPU
      minimum_capacity_units: 1, # required
      maximum_capacity_units: 1, # required
      maximum_on_demand_capacity_units: 1,
      maximum_core_capacity_units: 1,
    },
  },
  placement_group_configs: [
    {
      instance_role: "MASTER", # required, accepts MASTER, CORE, TASK
      placement_strategy: "SPREAD", # accepts SPREAD, PARTITION, CLUSTER, NONE
    },
  ],
}

Input to the RunJobFlow operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_info ⇒ String

A JSON string for selecting additional features.

Returns:

  • (String) —

    A JSON string for selecting additional features.

#ami_version ⇒ String

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Returns:

  • (String) —

    Applies only to Amazon EMR AMI versions 3.x and 2.x.

#applications ⇒ Array<Types::Application>

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide.

Returns:

#auto_scaling_role ⇒ String

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

Returns:

  • (String) —

    An IAM role for automatic scaling policies.

#bootstrap_actions ⇒ Array<Types::BootstrapActionConfig>

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

Returns:

#configurations ⇒ Array<Types::Configuration>

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

Returns:

#custom_ami_id ⇒ String

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.

Returns:

  • (String) —

    Available only in Amazon EMR version 5.7.0 and later.

#ebs_root_volume_size ⇒ Integer

The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

Returns:

  • (Integer) —

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

#instances ⇒ Types::JobFlowInstancesConfig

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

Returns:

#job_flow_role ⇒ String

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

Returns:

  • (String) —

    Also called instance profile and EC2 role.

#kerberos_attributes ⇒ Types::KerberosAttributes

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

Returns:

  • (Types::KerberosAttributes) —

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

#log_encryption_kms_key_id ⇒ String

The AWS KMS customer master key (CMK) used for encrypting log files. If a value is not provided, the logs will remain encrypted by AES-256. This attribute is only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Returns:

  • (String) —

    The AWS KMS customer master key (CMK) used for encrypting log files.

#log_uri ⇒ String

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

Returns:

  • (String) —

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

#managed_scaling_policy ⇒ Types::ManagedScalingPolicy

The specified managed scaling policy for an Amazon EMR cluster.

Returns:

#name ⇒ String

The name of the job flow.

Returns:

  • (String) —

    The name of the job flow.

#new_supported_products ⇒ Array<Types::SupportedProductConfig>

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported values are:

  • \"mapr-m3\" - launch the cluster using MapR M3 Edition.

  • \"mapr-m5\" - launch the cluster using MapR M5 Edition.

  • \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively.

  • \"mapr-m7\" - launch the cluster using MapR M7 Edition.

  • \"hunk\" - launch the cluster with the Hunk Big Data Analtics Platform.

  • \"hue\"- launch the cluster with Hue installed.

  • \"spark\" - launch the cluster with Apache Spark installed.

  • \"ganglia\" - launch the cluster with the Ganglia Monitoring System installed.

Returns:

#placement_group_configs ⇒ Array<Types::PlacementGroupConfig>

The specified placement group configuration for an Amazon EMR cluster.

Returns:

#release_label ⇒ String

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

Returns:

  • (String) —

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

#repo_upgrade_on_boot ⇒ String

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

Possible values:

  • SECURITY
  • NONE

Returns:

  • (String) —

    Applies only when CustomAmiID is used.

#scale_down_behavior ⇒ String

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

Possible values:

  • TERMINATE_AT_INSTANCE_HOUR
  • TERMINATE_AT_TASK_COMPLETION

Returns:

  • (String) —

    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

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

Returns:

  • (String) —

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

#service_role ⇒ String

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

Returns:

  • (String) —

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

#step_concurrency_level ⇒ Integer

Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum value is 256.

Returns:

  • (Integer) —

    Specifies the number of steps that can be executed concurrently.

#steps ⇒ Array<Types::StepConfig>

A list of steps to run.

Returns:

#supported_products ⇒ Array<String>

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:

  • \"mapr-m3\" - launch the job flow using MapR M3 Edition.

  • \"mapr-m5\" - launch the job flow using MapR M5 Edition.

Returns:

  • (Array<String>) —

    For Amazon EMR releases 3.x and 2.x.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

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

#visible_to_all_users ⇒ Boolean

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. This is the default. A value of false indicates that only the IAM user who created the cluster can perform actions.

Returns:

  • (Boolean) —

    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.