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 ModifyInstanceFleet API operation.

Syntax

Edit-EMRInstanceFleet
-ClusterId <String>
-OnDemandResizeSpecification_AllocationStrategy <OnDemandProvisioningAllocationStrategy>
-SpotResizeSpecification_AllocationStrategy <SpotProvisioningAllocationStrategy>
-CapacityReservationOptions_CapacityReservationPreference <OnDemandCapacityReservationPreference>
-CapacityReservationOptions_CapacityReservationResourceGroupArn <String>
-InstanceFleet_Context <String>
-InstanceFleet_InstanceFleetId <String>
-InstanceFleet_InstanceTypeConfig <InstanceTypeConfig[]>
-InstanceFleet_TargetOnDemandCapacity <Int32>
-InstanceFleet_TargetSpotCapacity <Int32>
-OnDemandResizeSpecification_TimeoutDurationMinute <Int32>
-SpotResizeSpecification_TimeoutDurationMinute <Int32>
-CapacityReservationOptions_UsageStrategy <OnDemandCapacityReservationUsageStrategy>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonElasticMapReduceConfig>

Description

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically. The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.

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_ResizeSpecifications_OnDemandResizeSpecification_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_ResizeSpecifications_OnDemandResizeSpecification_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_ResizeSpecifications_OnDemandResizeSpecification_CapacityReservationOptions_UsageStrategy
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)
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_Context <String>
Reserved.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceFleet_InstanceFleetId <String>
A unique identifier for the instance fleet.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceFleet_InstanceTypeConfig <InstanceTypeConfig[]>
An array of InstanceTypeConfig objects that specify how Amazon EMR provisions Amazon EC2 instances when it fulfills On-Demand and Spot capacities. For more information, see InstanceTypeConfig.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_InstanceTypeConfigs
-InstanceFleet_TargetOnDemandCapacity <Int32>
The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceFleet_TargetSpotCapacity <Int32>
The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OnDemandResizeSpecification_AllocationStrategy <OnDemandProvisioningAllocationStrategy>
Specifies the allocation strategy to use to launch On-Demand instances during a resize. The default is lowest-price.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_ResizeSpecifications_OnDemandResizeSpecification_AllocationStrategy
-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
-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 cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElasticMapReduce.Model.ModifyInstanceFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SpotResizeSpecification_AllocationStrategy <SpotProvisioningAllocationStrategy>
Specifies the allocation strategy to use to launch Spot instances during a resize. If you run Amazon EMR releases 6.9.0 or higher, the default is price-capacity-optimized. If you run Amazon EMR releases 6.8.0 or lower, the default is capacity-optimized.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInstanceFleet_ResizeSpecifications_SpotResizeSpecification_AllocationStrategy
-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

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

This cmdlet does not generate any output.The service response (type Amazon.ElasticMapReduce.Model.ModifyInstanceFleetResponse) be returned by specifying '-Select *'.

Supported Version

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