AWS SDK Version 3 for .NET
API Reference

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. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see 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 to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.CreateCapacityReservationRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateCapacityReservationRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateCapacityReservationRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

The Availability Zone in which to create the Capacity Reservation.

Public Property AvailabilityZoneId System.String

Gets and sets the property AvailabilityZoneId.

The ID of the Availability Zone in which to create the Capacity Reservation.

Public Property 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.

Public Property EbsOptimized 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.

Public Property EndDate 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 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.

Public Property 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:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

  • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

Public Property EphemeralStorage System.Boolean

Gets and sets the property EphemeralStorage.

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

Public Property InstanceCount System.Int32

Gets and sets the property InstanceCount.

The number of instances for which to reserve capacity.

Valid range: 1 - 1000

Public Property InstanceMatchCriteria Amazon.EC2.InstanceMatchCriteria

Gets and sets the property 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

Public Property InstancePlatform Amazon.EC2.CapacityReservationInstancePlatform

Gets and sets the property InstancePlatform.

The type of operating system for which to reserve capacity.

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

Public Property OutpostArn System.String

Gets and sets the property OutpostArn.

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

Public Property 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.

Public Property 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:

  • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5