ec2_create_capacity_reservation {aws.ecx} | R Documentation |
Create Capacity Reservation
Description
Create Capacity Reservation
Usage
ec2_create_capacity_reservation(
InstanceType,
InstancePlatform,
InstanceCount,
ClientToken = NULL,
AvailabilityZone = NULL,
AvailabilityZoneId = NULL,
Tenancy = NULL,
EbsOptimized = NULL,
EphemeralStorage = NULL,
EndDate = NULL,
EndDateType = NULL,
InstanceMatchCriteria = NULL,
TagSpecifications = NULL,
DryRun = 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
InstanceType |
Character. The instance type for which to reserve capacity. |
InstancePlatform |
Character. The type of operating system for which to reserve capacity. |
InstanceCount |
Integer. The number of instances for which to reserve capacity. |
ClientToken |
Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional] |
AvailabilityZone |
Character. The Availability Zone in which to create the Capacity Reservation.[optional] |
AvailabilityZoneId |
Character. The ID of the Availability Zone in which to create the Capacity Reservation.[optional] |
Tenancy |
Character. Indicates the tenancy of the Capacity Reservation.[optional] |
EbsOptimized |
Logical. Indicates whether the Capacity Reservation supports EBS-optimized instances.[optional] |
EphemeralStorage |
Logical. Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.[optional] |
EndDate |
Character. The date and time at which the Capacity Reservation expires.[optional] |
EndDateType |
Character. Indicates the way in which the Capacity Reservation ends.[optional] |
InstanceMatchCriteria |
Character. Indicates the type of instance launches that the Capacity Reservation accepts.[optional] |
TagSpecifications |
List. The tags to apply to the Capacity Reservation during launch.[optional] |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
simplify |
Logical. Whether to simplify the result and handle |
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 |
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
InstanceType
The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
InstancePlatform
The type of operating system for which to reserve capacity.
InstanceCount
The number of instances for which to reserve capacity.
ClientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
AvailabilityZone
The Availability Zone in which to create the Capacity Reservation.
AvailabilityZoneId
The ID of the Availability Zone in which to create the Capacity Reservation.
Tenancy
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
-
default
- The Capacity Reservation is created on hardware that is shared with other AWS accounts. -
dedicated
- The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
EbsOptimized
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn\'t available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
EphemeralStorage
Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
EndDate
The date and time at which the Capacity Reservation expires. When a
Capacity Reservation expires, the reserved capacity is released and you
can no longer launch instances into it. The Capacity Reservation\'s
state changes to expired
when it reaches its end date and time.
You must provide an EndDate
value if EndDateType
is limited
. Omit
EndDate
if EndDateType
is unlimited
.
If the EndDateType
is limited
, the Capacity Reservation is cancelled
within an hour from the specified time. For example, if you specify
5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end
between 13:30:55 and 14:30:55 on 5/31/2019.
EndDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
-
unlimited
- The Capacity Reservation remains active until you explicitly cancel it. Do not provide anEndDate
if theEndDateType
isunlimited
. -
limited
- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDate
value if theEndDateType
value islimited
.
InstanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
-
open
- The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. -
targeted
- The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
TagSpecifications
The tags to apply to the Capacity Reservation during launch.
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
.