aws_emr_instance_group

account_id

Type: STRING

auto_scaling_policy

Type: STRUCT
Provider name: AutoScalingPolicy
Description: An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

• constraints
  Type: STRUCT
  Provider name: Constraints
  Description: The upper and lower Amazon EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.
  
  • max_capacity
    Type: INT32
    Provider name: MaxCapacity
    Description: The upper boundary of Amazon EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.
    
  • min_capacity
    Type: INT32
    Provider name: MinCapacity
    Description: The lower boundary of Amazon EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.
    
• rules
  Type: UNORDERED_LIST_STRUCT
  Provider name: Rules
  Description: The scale-in and scale-out rules that comprise the automatic scaling policy.
  
  • action
    Type: STRUCT
    Provider name: Action
    Description: The conditions that trigger an automatic scaling activity.
    
    • market
      Type: STRING
      Provider name: Market
      Description: Not available for instance groups. Instance groups use the market type specified for the group.
      
    • simple_scaling_policy_configuration
      Type: STRUCT
      Provider name: SimpleScalingPolicyConfiguration
      Description: The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.
      
      • adjustment_type
        Type: STRING
        Provider name: AdjustmentType
        Description: The way in which Amazon EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the Amazon EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of Amazon EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer.
        
      • cool_down
        Type: INT32
        Provider name: CoolDown
        Description: The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.
        
      • scaling_adjustment
        Type: INT32
        Provider name: ScalingAdjustment
        Description: The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group’s Amazon EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
        
  • description
    Type: STRING
    Provider name: Description
    Description: A friendly, more verbose description of the automatic scaling rule.
    
  • name
    Type: STRING
    Provider name: Name
    Description: The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
    
  • trigger
    Type: STRUCT
    Provider name: Trigger
    Description: The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
    
    • cloud_watch_alarm_definition
      Type: STRUCT
      Provider name: CloudWatchAlarmDefinition
      Description: The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.
      
      • comparison_operator
        Type: STRING
        Provider name: ComparisonOperator
        Description: Determines how the metric specified by MetricName is compared to the value specified by Threshold.
        
      • dimensions
        Type: UNORDERED_LIST_STRUCT
        Provider name: Dimensions
        Description: A CloudWatch metric dimension.
        
        • key
          Type: STRING
          Provider name: Key
          Description: The dimension name.
          
        • value
          Type: STRING
          Provider name: Value
          Description: The dimension value.
          
      • evaluation_periods
        Type: INT32
        Provider name: EvaluationPeriods
        Description: The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
        
      • metric_name
        Type: STRING
        Provider name: MetricName
        Description: The name of the CloudWatch metric that is watched to determine an alarm condition.
        
      • namespace
        Type: STRING
        Provider name: Namespace
        Description: The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
        
      • period
        Type: INT32
        Provider name: Period
        Description: The period, in seconds, over which the statistic is applied. CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300.
        
      • statistic
        Type: STRING
        Provider name: Statistic
        Description: The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
        
      • threshold
        Type: DOUBLE
        Provider name: Threshold
        Description: The value against which the specified statistic is compared.
        
      • unit
        Type: STRING
        Provider name: Unit
        Description: The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
        
• status
  Type: STRUCT
  Provider name: Status
  Description: The status of an automatic scaling policy.
  
  • state
    Type: STRING
    Provider name: State
    Description: Indicates the status of the automatic scaling policy.
    
  • state_change_reason
    Type: STRUCT
    Provider name: StateChangeReason
    Description: The reason for a change in status.
    
    • code
      Type: STRING
      Provider name: Code
      Description: The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.
      
    • message
      Type: STRING
      Provider name: Message
      Description: A friendly, more verbose message that accompanies an automatic scaling policy state change.
      

bid_price

Type: STRING
Provider name: BidPrice
Description: If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

configurations

Type: UNORDERED_LIST_STRUCT
Provider name: Configurations
Description: Amazon EMR releases 4.x or later. The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

• classification
  Type: STRING
  Provider name: Classification
  Description: The classification within a configuration.
  
• properties
  Type: MAP_STRING_STRING
  Provider name: Properties
  Description: A set of properties specified within a configuration classification.
  

configurations_version

Type: INT64
Provider name: ConfigurationsVersion
Description: The version number of the requested configuration specification for this instance group.

custom_ami_id

Type: STRING
Provider name: CustomAmiId
Description: The custom AMI ID to use for the provisioned instance group.

ebs_block_devices

Type: UNORDERED_LIST_STRUCT
Provider name: EbsBlockDevices
Description: The EBS block devices that are mapped to this instance group.

• device
  Type: STRING
  Provider name: Device
  Description: The device name that is exposed to the instance, such as /dev/sdh.
  
• volume_specification
  Type: STRUCT
  Provider name: VolumeSpecification
  Description: EBS volume specifications such as volume type, IOPS, size (GiB) and throughput (MiB/s) that are requested for the EBS volume attached to an Amazon EC2 instance in the cluster.
  
  • iops
    Type: INT32
    Provider name: Iops
    Description: The number of I/O operations per second (IOPS) that the volume supports.
    
  • size_in_gb
    Type: INT32
    Provider name: SizeInGB
    Description: The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
    
  • throughput
    Type: INT32
    Provider name: Throughput
    Description: The throughput, in mebibyte per second (MiB/s). This optional parameter can be a number from 125 - 1000 and is valid only for gp3 volumes.
    
  • volume_type
    Type: STRING
    Provider name: VolumeType
    Description: The volume type. Volume types supported are gp3, gp2, io1, st1, sc1, and standard.
    

ebs_optimized

Type: BOOLEAN
Provider name: EbsOptimized
Description: If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

id

Type: STRING
Provider name: Id
Description: The identifier of the instance group.

instance_group_type

Type: STRING
Provider name: InstanceGroupType
Description: The type of the instance group. Valid values are MASTER, CORE or TASK.

instance_type

Type: STRING
Provider name: InstanceType
Description: The Amazon EC2 instance type for all instances in the instance group.

last_successfully_applied_configurations

Type: UNORDERED_LIST_STRUCT
Provider name: LastSuccessfullyAppliedConfigurations
Description: A list of configurations that were successfully applied for an instance group last time.

• classification
  Type: STRING
  Provider name: Classification
  Description: The classification within a configuration.
  
• properties
  Type: MAP_STRING_STRING
  Provider name: Properties
  Description: A set of properties specified within a configuration classification.
  

last_successfully_applied_configurations_version

Type: INT64
Provider name: LastSuccessfullyAppliedConfigurationsVersion
Description: The version number of a configuration specification that was successfully applied for an instance group last time.

market

Type: STRING
Provider name: Market
Description: The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

name

Type: STRING
Provider name: Name
Description: The name of the instance group.

requested_instance_count

Type: INT32
Provider name: RequestedInstanceCount
Description: The target number of instances for the instance group.

running_instance_count

Type: INT32
Provider name: RunningInstanceCount
Description: The number of instances currently running in this instance group.

shrink_policy

Type: STRUCT
Provider name: ShrinkPolicy
Description: Policy for customizing shrink operations.

• decommission_timeout
  Type: INT32
  Provider name: DecommissionTimeout
  Description: The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.
  
• instance_resize_policy
  Type: STRUCT
  Provider name: InstanceResizePolicy
  Description: Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.
  
  • instance_termination_timeout
    Type: INT32
    Provider name: InstanceTerminationTimeout
    Description: Decommissioning timeout override for the specific list of instances to be terminated.
    
  • instances_to_protect
    Type: UNORDERED_LIST_STRING
    Provider name: InstancesToProtect
    Description: Specific list of instances to be protected when shrinking an instance group.
    
  • instances_to_terminate
    Type: UNORDERED_LIST_STRING
    Provider name: InstancesToTerminate
    Description: Specific list of instances to be terminated when shrinking an instance group.
    

status

Type: STRUCT
Provider name: Status
Description: The current status of the instance group.

• state
  Type: STRING
  Provider name: State
  Description: The current state of the instance group.
  
• state_change_reason
  Type: STRUCT
  Provider name: StateChangeReason
  Description: The status change reason details for the instance group.
  
  • code
    Type: STRING
    Provider name: Code
    Description: The programmable code for the state change reason.
    
  • message
    Type: STRING
    Provider name: Message
    Description: The status change reason description.
    
• timeline
  Type: STRUCT
  Provider name: Timeline
  Description: The timeline of the instance group status over time.
  
  • creation_date_time
    Type: TIMESTAMP
    Provider name: CreationDateTime
    Description: The creation date and time of the instance group.
    
  • end_date_time
    Type: TIMESTAMP
    Provider name: EndDateTime
    Description: The date and time when the instance group terminated.
    
  • ready_date_time
    Type: TIMESTAMP
    Provider name: ReadyDateTime
    Description: The date and time when the instance group became ready to perform tasks.
    

tags

Type: UNORDERED_LIST_STRING