Struct aws_sdk_ec2::operation::request_spot_instances::RequestSpotInstancesInput

#[non_exhaustive]
pub struct RequestSpotInstancesInput {

    pub availability_zone_group: Option<String>,
    pub block_duration_minutes: Option<i32>,
    pub client_token: Option<String>,
    pub dry_run: Option<bool>,
    pub instance_count: Option<i32>,
    pub launch_group: Option<String>,
    pub launch_specification: Option<RequestSpotLaunchSpecification>,
    pub spot_price: Option<String>,
    pub type: Option<SpotInstanceType>,
    pub valid_from: Option<DateTime>,
    pub valid_until: Option<DateTime>,
    pub tag_specifications: Option<Vec<TagSpecification>>,
    pub instance_interruption_behavior: Option<InstanceInterruptionBehavior>,
}

Contains the parameters for RequestSpotInstances.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

availability_zone_group: Option<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.

block_duration_minutes: Option<i32>

Deprecated.

client_token: Option<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.

dry_run: Option<bool>

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.

instance_count: Option<i32>

The maximum number of Spot Instances to launch.

Default: 1

launch_group: Option<String>

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

Default: Instances are launched and terminated individually

launch_specification: Option<RequestSpotLaunchSpecification>

The launch specification.

spot_price: Option<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.

type: Option<SpotInstanceType>

The Spot Instance request type.

Default: one-time

valid_from: Option<DateTime>

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.

valid_until: Option<DateTime>

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.

tag_specifications: Option<Vec<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.

instance_interruption_behavior: Option<InstanceInterruptionBehavior>

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

Implementations

impl RequestSpotInstancesInput

pub fn availability_zone_group(&self) -> Option<&str>

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.

pub fn block_duration_minutes(&self) -> Option<i32>

Deprecated.

pub fn client_token(&self) -> Option<&str>

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.

pub fn dry_run(&self) -> Option<bool>

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.

pub fn instance_count(&self) -> Option<i32>

The maximum number of Spot Instances to launch.

Default: 1

pub fn launch_group(&self) -> Option<&str>

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

Default: Instances are launched and terminated individually

pub fn launch_specification(&self) -> Option<&RequestSpotLaunchSpecification>

The launch specification.

pub fn spot_price(&self) -> Option<&str>

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.

pub fn type(&self) -> Option<&SpotInstanceType>

The Spot Instance request type.

Default: one-time

pub fn valid_from(&self) -> Option<&DateTime>

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.

pub fn valid_until(&self) -> Option<&DateTime>

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.

pub fn tag_specifications(&self) -> Option<&[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.

pub fn instance_interruption_behavior( &self ) -> Option<&InstanceInterruptionBehavior>

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

impl RequestSpotInstancesInput

pub fn builder() -> RequestSpotInstancesInputBuilder

Creates a new builder-style object to manufacture RequestSpotInstancesInput.

Trait Implementations

impl Clone for RequestSpotInstancesInput

fn clone(&self) -> RequestSpotInstancesInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestSpotInstancesInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<RequestSpotInstancesInput> for RequestSpotInstancesInput

fn eq(&self, other: &RequestSpotInstancesInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RequestSpotInstancesInput