ec2_request_spot_instances {aws.ecx}

Request Spot Instances

Description

Request Spot Instances

Usage

ec2_request_spot_instances(
  AvailabilityZoneGroup = NULL,
  BlockDurationMinutes = NULL,
  ClientToken = NULL,
  DryRun = NULL,
  InstanceCount = NULL,
  LaunchGroup = NULL,
  LaunchSpecification = NULL,
  SpotPrice = NULL,
  Type = NULL,
  ValidFrom = NULL,
  ValidUntil = NULL,
  TagSpecification = NULL,
  InstanceInterruptionBehavior = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

AvailabilityZoneGroup

Character. The user-specified name for a logical grouping of requests.[optional]

BlockDurationMinutes

Integer. The required duration for the Spot Instances (also known as Spot blocks), in minutes.[optional]

ClientToken

Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

InstanceCount

Integer. The maximum number of Spot Instances to launch. Default: 1 [optional]

LaunchGroup

Character. The instance launch group.[optional]

LaunchSpecification

Object. The launch specification.[optional]

SpotPrice

Character. The maximum price per hour that you are willing to pay for a Spot Instance.[optional]

Type

Character. The Spot Instance request type. Default: one-time [optional]

ValidFrom

Character. The start date of the request.[optional]

ValidUntil

Character. The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).[optional]

TagSpecification

List. The key-value pair for tagging the Spot Instance request on creation.[optional]

InstanceInterruptionBehavior

Character. The behavior when a Spot Instance is interrupted. The default is terminate.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

AvailabilityZoneGroup

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

BlockDurationMinutes

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, 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.

You can\'t specify an Availability Zone group or a launch group if you specify a duration.

New accounts or accounts with no previous billing history with AWS are not eligible for Spot Instances with a defined duration (also known as Spot blocks).

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

InstanceCount

The maximum number of Spot Instances to launch.

Default: 1

LaunchGroup

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

LaunchSpecification

The launch specification.

SpotPrice

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

Type

The Spot Instance request type.

Default: one-time

ValidFrom

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

ValidUntil

The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).

• For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.

• For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.

TagSpecification

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.

InstanceInterruptionBehavior

The behavior when a Spot Instance is interrupted. The default is terminate.