ec2_create_fleet {aws.ecx}

Create Fleet

Description

Create Fleet

Usage

ec2_create_fleet(
  LaunchTemplateConfigs,
  TargetCapacitySpecification,
  DryRun = NULL,
  ClientToken = NULL,
  SpotOptions = NULL,
  OnDemandOptions = NULL,
  ExcessCapacityTerminationPolicy = NULL,
  TerminateInstancesWithExpiration = NULL,
  Type = NULL,
  ValidFrom = NULL,
  ValidUntil = NULL,
  ReplaceUnhealthyInstances = NULL,
  TagSpecification = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

LaunchTemplateConfigs

List. The configuration for the EC2 Fleet.

TargetCapacitySpecification

Object. The number of units to request.

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

ClientToken

Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional]

SpotOptions

Object. Describes the configuration of Spot Instances in an EC2 Fleet.[optional]

OnDemandOptions

Object. Describes the configuration of On-Demand Instances in an EC2 Fleet.[optional]

ExcessCapacityTerminationPolicy

Character. Indicates whether running instances should be terminated if the total target capacity of the EC2...[optional]

TerminateInstancesWithExpiration

Logical. Indicates whether running instances should be terminated when the EC2 Fleet expires.[optional]

Type

Character. The type of request.[optional]

ValidFrom

Character. The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ)....[optional]

ValidUntil

Character. The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ)....[optional]

ReplaceUnhealthyInstances

Logical. Indicates whether EC2 Fleet should replace unhealthy Spot Instances.[optional]

TagSpecification

List. The key-value pair for tagging the EC2 Fleet request on creation.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

LaunchTemplateConfigs

The configuration for the EC2 Fleet.

TargetCapacitySpecification

The number of units to request.

DryRun

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

SpotOptions

Describes the configuration of Spot Instances in an EC2 Fleet.

OnDemandOptions

Describes the configuration of On-Demand Instances in an EC2 Fleet.

ExcessCapacityTerminationPolicy

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

TerminateInstancesWithExpiration

Indicates whether running instances should be terminated when the EC2 Fleet expires.

Type

The type of request. The default value is maintain.

• maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.

• request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.

• instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.

For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.

ValidFrom

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

ValidUntil

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

ReplaceUnhealthyInstances

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.

TagSpecification

The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging your resources.