AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateCapacityReservation operation. Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration.
You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a Capacity Reservation for immediate use or you can request a Capacity Reservation for a future date.
For more information, see Reserve compute capacity with On-Demand Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if:
Amazon EC2 does not have sufficient capacity. In this case, try again at a later time, try in a different Availability Zone, or request a smaller Capacity Reservation. If your workload is flexible across instance types and sizes, try with different instance attributes.
The requested quantity exceeds your On-Demand Instance quota. In this case, increase your On-Demand Instance quota for the requested instance type and try again. For more information, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
public class CreateCapacityReservationRequest : AmazonEC2Request IAmazonWebServiceRequest
The CreateCapacityReservationRequest type exposes the following members
Name | Description | |
---|---|---|
![]() |
CreateCapacityReservationRequest() |
Name | Type | Description | |
---|---|---|---|
![]() |
AvailabilityZone | System.String |
Gets and sets the property AvailabilityZone. The Availability Zone in which to create the Capacity Reservation. |
![]() |
AvailabilityZoneId | System.String |
Gets and sets the property AvailabilityZoneId. The ID of the Availability Zone in which to create the Capacity Reservation. |
![]() |
ClientToken | System.String |
Gets and sets the property ClientToken. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. |
![]() |
CommitmentDuration | System.Nullable<System.Int64> |
Gets and sets the property CommitmentDuration.
Required for future-dated Capacity Reservations only. To create a Capacity Reservation
for immediate use, omit this parameter.
Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.
The commitment duration is a minimum duration for which you commit to having the future-dated
Capacity Reservation in the For more information, see Commitment duration. |
![]() |
DeliveryPreference | Amazon.EC2.CapacityReservationDeliveryPreference |
Gets and sets the property DeliveryPreference.
Required for future-dated Capacity Reservations only. To create a Capacity Reservation
for immediate use, omit this parameter.
Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.
The only supported value is |
![]() |
DryRun | System.Nullable<System.Boolean> |
Gets and sets the property 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 |
![]() |
EbsOptimized | System.Nullable<System.Boolean> |
Gets and sets the property 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. |
![]() |
EndDate | System.Nullable<System.DateTime> |
Gets and sets the property 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
You must provide an
If the If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration. |
![]() |
EndDateType | Amazon.EC2.EndDateType |
Gets and sets the property EndDateType. Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
|
![]() |
EphemeralStorage | System.Nullable<System.Boolean> |
Gets and sets the property EphemeralStorage. Deprecated. |
![]() |
InstanceCount | System.Nullable<System.Int32> |
Gets and sets the property InstanceCount. The number of instances for which to reserve capacity.
You can request future-dated Capacity Reservations for an instance count with a minimum
of 64 vCPUs. For example, if you request a future-dated Capacity Reservation for Valid range: 1 - 1000 |
![]() |
InstanceMatchCriteria | Amazon.EC2.InstanceMatchCriteria |
Gets and sets the property InstanceMatchCriteria. Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
If you are requesting a future-dated Capacity Reservation, you must specify
Default: |
![]() |
InstancePlatform | Amazon.EC2.CapacityReservationInstancePlatform |
Gets and sets the property InstancePlatform. The type of operating system for which to reserve capacity. |
![]() |
InstanceType | System.String |
Gets and sets the property InstanceType. The instance type for which to reserve capacity. You can request future-dated Capacity Reservations for instance types in the C, M, R, I, T, and G instance families only. For more information, see Instance types in the Amazon EC2 User Guide. |
![]() |
OutpostArn | System.String |
Gets and sets the property OutpostArn.
Not supported for future-dated Capacity Reservations.
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation. |
![]() |
PlacementGroupArn | System.String |
Gets and sets the property PlacementGroupArn.
Not supported for future-dated Capacity Reservations.
The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide. |
![]() |
StartDate | System.Nullable<System.DateTime> |
Gets and sets the property StartDate.
Required for future-dated Capacity Reservations only. To create a Capacity Reservation
for immediate use, omit this parameter.
The date and time at which the future-dated Capacity Reservation should become available
for use, in the ISO8601 format in the UTC time zone ( You can request a future-dated Capacity Reservation between 5 and 120 days in advance. |
![]() |
TagSpecifications | System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification> |
Gets and sets the property TagSpecifications. The tags to apply to the Capacity Reservation during launch. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. |
![]() |
Tenancy | Amazon.EC2.CapacityReservationTenancy |
Gets and sets the property Tenancy. Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
|
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer