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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

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: ["SecurityGroupId"],
    security_groups: ["String"],
    addressing_type: "String",
    block_device_mappings: [
      {
        device_name: "String",
        virtual_name: "String",
        ebs: {
          delete_on_termination: false,
          iops: 1,
          snapshot_id: "SnapshotId",
          volume_size: 1,
          volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
          kms_key_id: "String",
          throughput: 1,
          outpost_arn: "String",
          encrypted: false,
        },
        no_device: "String",
      },
    ],
    ebs_optimized: false,
    iam_instance_profile: {
      arn: "String",
      name: "String",
    },
    image_id: "ImageId",
    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, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.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.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r6g.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6gd.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, 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, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.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.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6gd.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.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.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, mac1.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge
    kernel_id: "KernelId",
    key_name: "KeyPairName",
    monitoring: {
      enabled: false, # required
    },
    network_interfaces: [
      {
        associate_public_ip_address: false,
        delete_on_termination: false,
        description: "String",
        device_index: 1,
        groups: ["SecurityGroupId"],
        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",
        associate_carrier_ip_address: false,
        interface_type: "String",
        network_card_index: 1,
        ipv_4_prefixes: [
          {
            ipv_4_prefix: "String",
          },
        ],
        ipv_4_prefix_count: 1,
        ipv_6_prefixes: [
          {
            ipv_6_prefix: "String",
          },
        ],
        ipv_6_prefix_count: 1,
      },
    ],
    placement: {
      availability_zone: "String",
      group_name: "PlacementGroupName",
      tenancy: "default", # accepts default, dedicated, host
    },
    ramdisk_id: "RamdiskId",
    subnet_id: "SubnetId",
    user_data: "String",
  },
  spot_price: "String",
  type: "one-time", # accepts one-time, persistent
  valid_from: Time.now,
  valid_until: Time.now,
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
}

Contains the parameters for RequestSpotInstances.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone_groupString

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)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_minutesInteger

Deprecated.

Returns:

  • (Integer)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_tokenString

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.

Returns:

  • (String)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_runBoolean

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)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_countInteger

The maximum number of Spot Instances to launch.

Default: 1

Returns:

  • (Integer)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_behaviorString

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

Returns:

  • (String)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_groupString

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

Default: Instances are launched and terminated individually

Returns:

  • (String)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_specificationTypes::RequestSpotLaunchSpecification

The launch specification.



48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_priceString

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

Returns:

  • (String)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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

Returns:



48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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

#typeString

The Spot Instance request type.

Default: one-time

Returns:

  • (String)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_fromTime

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)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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_untilTime

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.

Returns:

  • (Time)


48269
48270
48271
48272
48273
48274
48275
48276
48277
48278
48279
48280
48281
48282
48283
48284
48285
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 48269

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