Class: Aws::EC2::Types::SpotInstanceRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::SpotInstanceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Describes a Spot Instance request.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actual_block_hourly_price ⇒ String

  Deprecated.

• #availability_zone_group ⇒ String

  The Availability Zone group.

• #block_duration_minutes ⇒ Integer

  Deprecated.

• #create_time ⇒ Time

  The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

• #fault ⇒ Types::SpotInstanceStateFault

  The fault codes for the Spot Instance request, if any.

• #instance_id ⇒ String

  The instance ID, if an instance has been launched to fulfill the Spot Instance request.

• #instance_interruption_behavior ⇒ String

  The behavior when a Spot Instance is interrupted.

• #launch_group ⇒ String

  The instance launch group.

• #launch_specification ⇒ Types::LaunchSpecification

  Additional information for launching instances.

• #launched_availability_zone ⇒ String

  The Availability Zone in which the request is launched.

• #product_description ⇒ String

  The product description associated with the Spot Instance.

• #spot_instance_request_id ⇒ String

  The ID of the Spot Instance request.

• #spot_price ⇒ String

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

• #state ⇒ String

  The state of the Spot Instance request.

• #status ⇒ Types::SpotInstanceStatus

  The status code and status message describing the Spot Instance request.

• #tags ⇒ Array<Types::Tag>

  Any tags assigned to the resource.

• #type ⇒ String

  The Spot Instance request type.

• #valid_from ⇒ Time

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

• #valid_until ⇒ Time

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

Instance Attribute Details

#actual_block_hourly_price ⇒ String

Deprecated.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_group ⇒ String

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#block_duration_minutes ⇒ Integer

Deprecated.

Returns:

• (Integer)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z).

Returns:

• (Time)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#fault ⇒ Types::SpotInstanceStateFault

The fault codes for the Spot Instance request, if any.

Returns:

• (Types::SpotInstanceStateFault)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#instance_interruption_behavior ⇒ String

The behavior when a Spot Instance is interrupted.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :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.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#launch_specification ⇒ Types::LaunchSpecification

Additional information for launching instances.

Returns:

• (Types::LaunchSpecification)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#launched_availability_zone ⇒ String

The Availability Zone in which the request is launched.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#product_description ⇒ String

The product description associated with the Spot Instance.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#spot_instance_request_id ⇒ String

The ID of the Spot Instance request.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :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 66611

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the Spot Instance request. Spot request status information helps track your Spot Instance requests. For more information, see [Spot request status] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::SpotInstanceStatus

The status code and status message describing the Spot Instance request.

Returns:

• (Types::SpotInstanceStatus)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the resource.

Returns:

• (Array<Types::Tag>)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The Spot Instance request type.

Returns:

• (String)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#valid_from ⇒ Time

The start date of the request, in UTC format (for example, YYYY-MM-*DD*T*HH*:MM:*SS*Z). The request becomes active at this date and time.

Returns:

• (Time)

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

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :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 66611

class SpotInstanceRequest < Struct.new(
  :actual_block_hourly_price,
  :availability_zone_group,
  :block_duration_minutes,
  :create_time,
  :fault,
  :instance_id,
  :launch_group,
  :launch_specification,
  :launched_availability_zone,
  :product_description,
  :spot_instance_request_id,
  :spot_price,
  :state,
  :status,
  :tags,
  :type,
  :valid_from,
  :valid_until,
  :instance_interruption_behavior)
  SENSITIVE = []
  include Aws::Structure
end