/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::EC2::RequestSpotInstances

NAME

Paws::EC2::RequestSpotInstances - Arguments for method RequestSpotInstances on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method RequestSpotInstances on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method RequestSpotInstances.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RequestSpotInstances.

SYNOPSIS

my $ec2 = Paws->service('EC2');
# To create a one-time Spot Instance request
# This example creates a one-time Spot Instance request for five instances in
# the specified Availability Zone. If your account supports EC2-VPC only, Amazon
# EC2 launches the instances in the default subnet of the specified Availability
# Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances
# in EC2-Classic in the specified Availability Zone.
my $RequestSpotInstancesResult = $ec2->RequestSpotInstances(
  'InstanceCount'       => 5,
  'LaunchSpecification' => {
    'IamInstanceProfile' => {
      'Arn' => 'arn:aws:iam::123456789012:instance-profile/my-iam-role'
    },
    'ImageId'      => 'ami-1a2b3c4d',
    'InstanceType' => 'm3.medium',
    'KeyName'      => 'my-key-pair',
    'Placement'    => {
      'AvailabilityZone' => 'us-west-2a'
    },
    'SecurityGroupIds' => ['sg-1a2b3c4d']
  },
  'SpotPrice' => 0.03,
  'Type'      => 'one-time'
);

# To create a one-time Spot Instance request # This example command creates a one-time Spot Instance request for five # instances in the specified subnet. Amazon EC2 launches the instances in the # specified subnet. If the VPC is a nondefault VPC, the instances do not receive # a public IP address by default. my $RequestSpotInstancesResult = $ec2->RequestSpotInstances( 'InstanceCount' => 5, 'LaunchSpecification' => { 'IamInstanceProfile' => { 'Arn' => 'arn:aws:iam::123456789012:instance-profile/my-iam-role' }, 'ImageId' => 'ami-1a2b3c4d', 'InstanceType' => 'm3.medium', 'SecurityGroupIds' => ['sg-1a2b3c4d'], 'SubnetId' => 'subnet-1a2b3c4d' }, 'SpotPrice' => 0.050, 'Type' => 'one-time' );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/RequestSpotInstances

ATTRIBUTES

AvailabilityZoneGroup => 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.

BlockDurationMinutes => Int

Deprecated.

ClientToken => Str

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) in the Amazon EC2 User Guide for Linux Instances.

DryRun => 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.

InstanceCount => Int

The maximum number of Spot Instances to launch.

Default: 1

InstanceInterruptionBehavior => Str

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

Valid values are: "hibernate", "stop", "terminate"

LaunchGroup => Str

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

Default: Instances are launched and terminated individually

LaunchSpecification => Paws::EC2::RequestSpotLaunchSpecification

The launch specification.

SpotPrice => Str

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

TagSpecifications => ArrayRef[Paws::EC2::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 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).

Type => Str

The Spot Instance request type.

Default: one-time

Valid values are: "one-time", "persistent"

ValidFrom => Str

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.

ValidUntil => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method RequestSpotInstances in Paws::EC2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues