AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic MapReduce AddInstanceFleet API operation.

Syntax

Add-EMRInstanceFleet
-ClusterId <String>
-OnDemandSpecification_AllocationStrategy <OnDemandProvisioningAllocationStrategy>
-SpotSpecification_AllocationStrategy <SpotProvisioningAllocationStrategy>
-SpotSpecification_BlockDurationMinute <Int32>
-CapacityReservationOptions_CapacityReservationPreference <OnDemandCapacityReservationPreference>
-CapacityReservationOptions_CapacityReservationResourceGroupArn <String>
-InstanceFleet_InstanceFleetType <InstanceFleetType>
-InstanceFleet_InstanceTypeConfig <InstanceTypeConfig[]>
-InstanceFleet_Name <String>
-InstanceFleet_TargetOnDemandCapacity <Int32>
-InstanceFleet_TargetSpotCapacity <Int32>
-SpotSpecification_TimeoutAction <SpotProvisioningTimeoutAction>
-SpotSpecification_TimeoutDurationMinute <Int32>
-OnDemandResizeSpecification_TimeoutDurationMinute <Int32>
-SpotResizeSpecification_TimeoutDurationMinute <Int32>
-CapacityReservationOptions_UsageStrategy <OnDemandCapacityReservationUsageStrategy>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticMapReduceConfig>

Description

Adds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.

Parameters

-CapacityReservationOptions_CapacityReservationPreference <OnDemandCapacityReservationPreference>
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_OnDemandSpecification_CapacityReservationOptions_CapacityReservationPreference
-CapacityReservationOptions_CapacityReservationResourceGroupArn <String>
The ARN of the Capacity Reservation resource group in which to run the instance.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_OnDemandSpecification_CapacityReservationOptions_CapacityReservationResourceGroupArn
-CapacityReservationOptions_UsageStrategy <OnDemandCapacityReservationUsageStrategy>
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price).If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_OnDemandSpecification_CapacityReservationOptions_UsageStrategy
-ClientConfig <AmazonElasticMapReduceConfig>
Amazon.PowerShell.Cmdlets.EMR.AmazonElasticMapReduceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterId <String>
The unique identifier of the cluster.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceFleet_InstanceFleetType <InstanceFleetType>
The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceFleet_InstanceTypeConfig <InstanceTypeConfig[]>
The instance type configurations that define the EC2 instances in the instance fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_InstanceTypeConfigs
-InstanceFleet_Name <String>
The friendly name of the instance fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceFleet_TargetOnDemandCapacity <Int32>
The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.If not specified or set to 0, only Spot Instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceFleet_TargetSpotCapacity <Int32>
The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot Instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OnDemandResizeSpecification_TimeoutDurationMinute <Int32>
On-Demand resize timeout in minutes. If On-Demand Instances are not provisioned within this time, the resize workflow stops. The minimum value is 5 minutes, and the maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_ResizeSpecifications_OnDemandResizeSpecification_TimeoutDurationMinutes
-OnDemandSpecification_AllocationStrategy <OnDemandProvisioningAllocationStrategy>
Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price (the default), which launches the lowest price first.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_OnDemandSpecification_AllocationStrategy
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ClusterId parameter. The -PassThru parameter is deprecated, use -Select '^ClusterId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticMapReduce.Model.AddInstanceFleetResponse). Specifying the name of a property of type Amazon.ElasticMapReduce.Model.AddInstanceFleetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SpotResizeSpecification_TimeoutDurationMinute <Int32>
Spot resize timeout in minutes. If Spot Instances are not provisioned within this time, the resize workflow will stop provisioning of Spot instances. Minimum value is 5 minutes and maximum value is 10,080 minutes (7 days). The timeout applies to all resize workflows on the Instance Fleet. The resize could be triggered by Amazon EMR Managed Scaling or by the customer (via Amazon EMR Console, Amazon EMR CLI modify-instance-fleet or Amazon EMR SDK ModifyInstanceFleet API) or by Amazon EMR due to Amazon EC2 Spot Reclamation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_ResizeSpecifications_SpotResizeSpecification_TimeoutDurationMinutes
-SpotSpecification_AllocationStrategy <SpotProvisioningAllocationStrategy>
Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_SpotSpecification_AllocationStrategy
-SpotSpecification_BlockDurationMinute <Int32>
The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates. Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_SpotSpecification_BlockDurationMinutes
-SpotSpecification_TimeoutAction <SpotProvisioningTimeoutAction>
The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_SpotSpecification_TimeoutAction
-SpotSpecification_TimeoutDurationMinute <Int32>
The Spot provisioning timeout period in minutes. If Spot Instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_LaunchSpecifications_SpotSpecification_TimeoutDurationMinutes

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ElasticMapReduce.Model.AddInstanceFleetResponse
This cmdlet returns an Amazon.ElasticMapReduce.Model.AddInstanceFleetResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z