aws_ec2_spot_instance_request

account_id

Type: STRING

actual_block_hourly_price

Type: STRING
Provider name: ActualBlockHourlyPrice
Description: Deprecated.

availability_zone_group

Type: STRING
Provider name: AvailabilityZoneGroup
Description: 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.

block_duration_minutes

Type: INT32
Provider name: BlockDurationMinutes
Description: Deprecated.

create_time

Type: TIMESTAMP
Provider name: CreateTime
Description: The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

fault

Type: STRUCT
Provider name: Fault
Description: The fault codes for the Spot Instance request, if any.

• code
  Type: STRING
  Provider name: Code
  Description: The reason code for the Spot Instance state change.
  
• message
  Type: STRING
  Provider name: Message
  Description: The message for the Spot Instance state change.
  

instance_id

Type: STRING
Provider name: InstanceId
Description: The instance ID, if an instance has been launched to fulfill the Spot Instance request.

instance_interruption_behavior

Type: STRING
Provider name: InstanceInterruptionBehavior
Description: The behavior when a Spot Instance is interrupted.

launch_group

Type: STRING
Provider name: LaunchGroup
Description: The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

launch_specification

Type: STRUCT
Provider name: LaunchSpecification
Description: Additional information for launching instances.

• addressing_type
  Type: STRING
  Provider name: AddressingType
  Description: Deprecated.
  
• block_device_mappings
  Type: UNORDERED_LIST_STRUCT
  Provider name: BlockDeviceMappings
  Description: The block device mapping entries.
  
  • device_name
    Type: STRING
    Provider name: DeviceName
    Description: The device name (for example, /dev/sdh or xvdh).
    
  • ebs
    Type: STRUCT
    Provider name: Ebs
    Description: Parameters used to automatically set up EBS volumes when the instance is launched.
    
    • delete_on_termination
      Type: BOOLEAN
      Provider name: DeleteOnTermination
      Description: Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
      
    • encrypted
      Type: BOOLEAN
      Provider name: Encrypted
      Description: Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
      • If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
      • If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
      • If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
      • If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
    • iops
      Type: INT32
      Provider name: Iops
      Description: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type:
      • gp3: 3,000 - 16,000 IOPS
      • io1: 100 - 64,000 IOPS
      • io2: 100 - 256,000 IOPS
      For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.
      
    • kms_key_id
      Type: STRING
      Provider name: KmsKeyId
      Description: Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
      
    • outpost_arn
      Type: STRING
      Provider name: OutpostArn
      Description: The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage.
      
    • snapshot_id
      Type: STRING
      Provider name: SnapshotId
      Description: The ID of the snapshot.
      
    • throughput
      Type: INT32
      Provider name: Throughput
      Description: The throughput that the volume supports, in MiB/s. This parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. Maximum value of 1000.
      
    • volume_size
      Type: INT32
      Provider name: VolumeSize
      Description: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported sizes for each volume type:
      • gp2 and gp3: 1 - 16,384 GiB
      • io1: 4 - 16,384 GiB
      • io2: 4 - 65,536 GiB
      • st1 and sc1: 125 - 16,384 GiB
      • standard: 1 - 1024 GiB
    • volume_type
      Type: STRING
      Provider name: VolumeType
      Description: The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
      
  • no_device
    Type: STRING
    Provider name: NoDevice
    Description: To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
    
  • virtual_name
    Type: STRING
    Provider name: VirtualName
    Description: The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
    
• ebs_optimized
  Type: BOOLEAN
  Provider name: EbsOptimized
  Description: Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
  Default: false
• iam_instance_profile
  Type: STRUCT
  Provider name: IamInstanceProfile
  Description: The IAM instance profile.
  
  • arn
    Type: STRING
    Provider name: Arn
    Description: The Amazon Resource Name (ARN) of the instance profile.
    
  • name
    Type: STRING
    Provider name: Name
    Description: The name of the instance profile.
    
• image_id
  Type: STRING
  Provider name: ImageId
  Description: The ID of the AMI.
  
• instance_type
  Type: STRING
  Provider name: InstanceType
  Description: The instance type. Only one instance type can be specified.
  
• kernel_id
  Type: STRING
  Provider name: KernelId
  Description: The ID of the kernel.
  
• key_name
  Type: STRING
  Provider name: KeyName
  Description: The name of the key pair.
  
• monitoring
  Type: STRUCT
  Provider name: Monitoring
  
  • enabled
    Type: BOOLEAN
    Provider name: Enabled
    Description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
    
• network_interfaces
  Type: UNORDERED_LIST_STRUCT
  Provider name: NetworkInterfaces
  Description: The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
  
  • associate_carrier_ip_address
    Type: BOOLEAN
    Provider name: AssociateCarrierIpAddress
    Description: Indicates whether to assign a carrier IP address to the network interface. You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer Guide.
    
  • associate_public_ip_address
    Type: BOOLEAN
    Provider name: AssociatePublicIpAddress
    Description: Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true. Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
    
  • connection_tracking_specification
    Type: STRUCT
    Provider name: ConnectionTrackingSpecification
    Description: A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
    
    • tcp_established_timeout
      Type: INT32
      Provider name: TcpEstablishedTimeout
      Description: Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
      
    • udp_stream_timeout
      Type: INT32
      Provider name: UdpStreamTimeout
      Description: Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
      
    • udp_timeout
      Type: INT32
      Provider name: UdpTimeout
      Description: Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
      
  • delete_on_termination
    Type: BOOLEAN
    Provider name: DeleteOnTermination
    Description: If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
    
  • description
    Type: STRING
    Provider name: Description
    Description: The description of the network interface. Applies only if creating a network interface when launching an instance.
    
  • device_index
    Type: INT32
    Provider name: DeviceIndex
    Description: The position of the network interface in the attachment order. A primary network interface has a device index of 0. If you specify a network interface when launching an instance, you must specify the device index.
    
  • ena_srd_specification
    Type: STRUCT
    Provider name: EnaSrdSpecification
    Description: Specifies the ENA Express settings for the network interface that’s attached to the instance.
    
    • ena_srd_enabled
      Type: BOOLEAN
      Provider name: EnaSrdEnabled
      Description: Specifies whether ENA Express is enabled for the network interface when you launch an instance from your launch template.
      
    • ena_srd_udp_specification
      Type: STRUCT
      Provider name: EnaSrdUdpSpecification
      Description: Contains ENA Express settings for UDP network traffic in your launch template.
      
      • ena_srd_udp_enabled
        Type: BOOLEAN
        Provider name: EnaSrdUdpEnabled
        Description: Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set EnaSrdEnabled in the EnaSrdSpecificationRequest to true in your launch template.
        
  • groups
    Type: UNORDERED_LIST_STRING
    Provider name: Groups
    Description: The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
    
  • interface_type
    Type: STRING
    Provider name: InterfaceType
    Description: The type of network interface. If you specify efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. Valid values: interface | efa | efa-only
    
  • ipv4_prefix_count
    Type: INT32
    Provider name: Ipv4PrefixCount
    Description: The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
    
  • ipv4_prefixes
    Type: UNORDERED_LIST_STRUCT
    Provider name: Ipv4Prefixes
    Description: The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
    
    • ipv4_prefix
      Type: STRING
      Provider name: Ipv4Prefix
      Description: The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
      
  • ipv6_address_count
    Type: INT32
    Provider name: Ipv6AddressCount
    Description: A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you’ve specified a minimum number of instances to launch.
    
  • ipv6_addresses
    Type: UNORDERED_LIST_STRUCT
    Provider name: Ipv6Addresses
    Description: The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you’ve specified a minimum number of instances to launch.
    
    • ipv6_address
      Type: STRING
      Provider name: Ipv6Address
      Description: The IPv6 address.
      
    • is_primary_ipv6
      Type: BOOLEAN
      Provider name: IsPrimaryIpv6
      Description: Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.
      
  • ipv6_prefix_count
    Type: INT32
    Provider name: Ipv6PrefixCount
    Description: The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
    
  • ipv6_prefixes
    Type: UNORDERED_LIST_STRUCT
    Provider name: Ipv6Prefixes
    Description: The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
    
    • ipv6_prefix
      Type: STRING
      Provider name: Ipv6Prefix
      Description: The IPv6 prefix.
      
  • network_card_index
    Type: INT32
    Provider name: NetworkCardIndex
    Description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
    
  • network_interface_id
    Type: STRING
    Provider name: NetworkInterfaceId
    Description: The ID of the network interface. If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
    
  • primary_ipv6
    Type: BOOLEAN
    Provider name: PrimaryIpv6
    Description: The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
    
  • private_ip_address
    Type: STRING
    Provider name: PrivateIpAddress
    Description: The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you’re launching more than one instance in a RunInstances request.
    
  • private_ip_addresses
    Type: UNORDERED_LIST_STRUCT
    Provider name: PrivateIpAddresses
    Description: The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you’re launching more than one instance in a RunInstances request.
    
    • primary
      Type: BOOLEAN
      Provider name: Primary
      Description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
      
    • private_ip_address
      Type: STRING
      Provider name: PrivateIpAddress
      Description: The private IPv4 address.
      
  • secondary_private_ip_address_count
    Type: INT32
    Provider name: SecondaryPrivateIpAddressCount
    Description: The number of secondary private IPv4 addresses. You can’t specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you’re launching more than one instance in a RunInstances request.
    
  • subnet_id
    Type: STRING
    Provider name: SubnetId
    Description: The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
    
• placement
  Type: STRUCT
  Provider name: Placement
  Description: The placement information for the instance.
  
  • availability_zone
    Type: STRING
    Provider name: AvailabilityZone
    Description: The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, “us-west-2a, us-west-2b”.
    
  • group_name
    Type: STRING
    Provider name: GroupName
    Description: The name of the placement group.
    
  • tenancy
    Type: STRING
    Provider name: Tenancy
    Description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
    
• ramdisk_id
  Type: STRING
  Provider name: RamdiskId
  Description: The ID of the RAM disk.
  
• security_groups
  Type: UNORDERED_LIST_STRUCT
  Provider name: SecurityGroups
  Description: The IDs of the security groups.
  
  • group_id
    Type: STRING
    Provider name: GroupId
    Description: The ID of the security group.
    
  • group_name
    Type: STRING
    Provider name: GroupName
    Description: The name of the security group.
    
• subnet_id
  Type: STRING
  Provider name: SubnetId
  Description: The ID of the subnet in which to launch the instance.
  
• user_data
  Type: STRING
  Provider name: UserData
  Description: The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
  

launched_availability_zone

Type: STRING
Provider name: LaunchedAvailabilityZone
Description: The Availability Zone in which the request is launched.

product_description

Type: STRING
Provider name: ProductDescription
Description: The product description associated with the Spot Instance.

spot_instance_request_arn

Type: STRING

spot_instance_request_id

Type: STRING
Provider name: SpotInstanceRequestId
Description: The ID of the Spot Instance request.

spot_price

Type: STRING
Provider name: SpotPrice
Description: 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.

state

Type: STRING
Provider name: State
Description: 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.

status

Type: STRUCT
Provider name: Status
Description: The status code and status message describing the Spot Instance request.

• code
  Type: STRING
  Provider name: Code
  Description: The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide.
  
• message
  Type: STRING
  Provider name: Message
  Description: The description for the status code.
  
• update_time
  Type: TIMESTAMP
  Provider name: UpdateTime
  Description: The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
  

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: Type
Description: The Spot Instance request type.

valid_from

Type: TIMESTAMP
Provider name: ValidFrom
Description: The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

valid_until

Type: TIMESTAMP
Provider name: ValidUntil
Description: 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.