Class: Aws::EC2::Types::RequestSpotInstancesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::RequestSpotInstancesRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ec2/types.rb
Overview
When making an API call, you may pass RequestSpotInstancesRequest data as a hash:
{
availability_zone_group: "String",
block_duration_minutes: 1,
client_token: "String",
dry_run: false,
instance_count: 1,
launch_group: "String",
launch_specification: {
security_group_ids: ["String"],
security_groups: ["String"],
addressing_type: "String",
block_device_mappings: [
{
device_name: "String",
virtual_name: "String",
ebs: {
delete_on_termination: false,
iops: 1,
snapshot_id: "String",
volume_size: 1,
volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
encrypted: false,
kms_key_id: "String",
},
no_device: "String",
},
],
ebs_optimized: false,
iam_instance_profile: {
arn: "String",
name: "String",
},
image_id: "String",
instance_type: "t1.micro", # accepts t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.12xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.12xlarge, r5a.24xlarge, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.12xlarge, r5d.24xlarge, r5d.metal, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.18xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.18xlarge, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.12xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.12xlarge, m5a.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.12xlarge, m5d.24xlarge, m5d.metal, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge
kernel_id: "String",
key_name: "String",
monitoring: {
enabled: false, # required
},
network_interfaces: [
{
associate_public_ip_address: false,
delete_on_termination: false,
description: "String",
device_index: 1,
groups: ["String"],
ipv_6_address_count: 1,
ipv_6_addresses: [
{
ipv_6_address: "String",
},
],
network_interface_id: "String",
private_ip_address: "String",
private_ip_addresses: [
{
primary: false,
private_ip_address: "String",
},
],
secondary_private_ip_address_count: 1,
subnet_id: "String",
},
],
placement: {
availability_zone: "String",
group_name: "String",
tenancy: "default", # accepts default, dedicated, host
},
ramdisk_id: "String",
subnet_id: "String",
user_data: "String",
},
spot_price: "String",
type: "one-time", # accepts one-time, persistent
valid_from: Time.now,
valid_until: Time.now,
instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
}
Contains the parameters for RequestSpotInstances.
Instance Attribute Summary collapse
-
#availability_zone_group ⇒ String
The user-specified name for a logical grouping of requests.
-
#block_duration_minutes ⇒ Integer
The required duration for the Spot Instances (also known as Spot blocks), in minutes.
-
#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 hour that you are willing to pay for a Spot Instance.
-
#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.
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.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |
#block_duration_minutes ⇒ Integer
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.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) 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 [How to Ensure Idempotency] in the *Amazon EC2 User Guide for Linux Instances*.
[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) 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`.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |
#instance_count ⇒ Integer
The maximum number of Spot Instances to launch.
Default: 1
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |
#instance_interruption_behavior ⇒ String
The behavior when a Spot Instance is interrupted. The default is ‘terminate`.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) 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
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |
#launch_specification ⇒ Types::RequestSpotLaunchSpecification
The launch specification.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |
#spot_price ⇒ String
The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |
#type ⇒ String
The Spot Instance request type.
Default: ‘one-time`
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) 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.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |
#valid_until ⇒ Time
The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.
30273 30274 30275 30276 30277 30278 30279 30280 30281 30282 30283 30284 30285 30286 30287 |
# File 'lib/aws-sdk-ec2/types.rb', line 30273 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, :instance_interruption_behavior) include Aws::Structure end |