Class: Aws::EC2::Types::RequestSpotInstancesRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::RequestSpotInstancesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Contains the parameters for RequestSpotInstances.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #availability_zone_group ⇒ String

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

• #block_duration_minutes ⇒ Integer

  Deprecated.

• #client_token ⇒ String

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

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #instance_count ⇒ Integer

  The maximum number of Spot Instances to launch.

• #instance_interruption_behavior ⇒ String

  The behavior when a Spot Instance is interrupted.

• #launch_group ⇒ String

  The instance launch group.

• #launch_specification ⇒ Types::RequestSpotLaunchSpecification

  The launch specification.

• #spot_price ⇒ String

  The maximum price per unit hour that you are willing to pay for a Spot Instance.

• #tag_specifications ⇒ Array<Types::TagSpecification>

  The key-value pair for tagging the Spot Instance request on creation.

• #type ⇒ String

  The Spot Instance request type.

• #valid_from ⇒ Time

  The start date of the request.

• #valid_until ⇒ Time

  The end date of the request, in UTC format (YYYY-MM-*DD*T*HH*:MM:*SS*Z).

Instance Attribute Details

#availability_zone_group ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#block_duration_minutes ⇒ Integer

Deprecated.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency in Amazon EC2 API requests] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#instance_count ⇒ Integer

The maximum number of Spot Instances to launch.

Default: 1

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#instance_interruption_behavior ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#launch_group ⇒ String

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

Default: Instances are launched and terminated individually

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#launch_specification ⇒ Types::RequestSpotLaunchSpecification

The launch specification.

Returns:

• (Types::RequestSpotLaunchSpecification)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#spot_price ⇒ String

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Array<Types::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].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html

Returns:

• (Array<Types::TagSpecification>)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The Spot Instance request type.

Default: ‘one-time`

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#valid_from ⇒ Time

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.

Returns:

• (Time)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#valid_until ⇒ Time

The end date of the request, in UTC format (YYYY-MM-*DD*T*HH*:MM:*SS*Z).

• 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.

Returns:

• (Time)

# File 'lib/aws-sdk-ec2/types.rb', line 57663

class RequestSpotInstancesRequest < Struct.new(
  :availability_zone_group,
  :block_duration_minutes,
  :client_token,
  :dry_run,
  :instance_count,
  :launch_group,
  :launch_specification,
  :spot_price,
  :type,
  :valid_from,
  :valid_until,
  :tag_specifications,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end