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.

Describes a Capacity Reservation.

Inheritance Hierarchy

System.Object
  Amazon.EC2.Model.CapacityReservation

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

Syntax

C#
public class CapacityReservation

The CapacityReservation type exposes the following members

Constructors

NameDescription
Public Method CapacityReservation()

Properties

NameTypeDescription
Public Property AvailabilityZone System.String

Gets and sets the property AvailabilityZone.

The Availability Zone in which the capacity is reserved.

Public Property AvailabilityZoneId System.String

Gets and sets the property AvailabilityZoneId.

The Availability Zone ID of the Capacity Reservation.

Public Property AvailableInstanceCount System.Int32

Gets and sets the property AvailableInstanceCount.

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

Public Property CapacityReservationArn System.String

Gets and sets the property CapacityReservationArn.

The Amazon Resource Name (ARN) of the Capacity Reservation.

Public Property CapacityReservationFleetId System.String

Gets and sets the property CapacityReservationFleetId.

The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

Public Property CapacityReservationId System.String

Gets and sets the property CapacityReservationId.

The ID of the Capacity Reservation.

Public Property CreateDate System.DateTime

Gets and sets the property CreateDate.

The date and time at which the Capacity Reservation was created.

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.

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.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

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 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 accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into 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.

Public Property InstancePlatform Amazon.EC2.CapacityReservationInstancePlatform

Gets and sets the property InstancePlatform.

The type of operating system for which the Capacity Reservation reserves capacity.

Public Property InstanceType System.String

Gets and sets the property InstanceType.

The type of instance for which the Capacity Reservation reserves capacity.

Public Property OutpostArn System.String

Gets and sets the property OutpostArn.

The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.

Public Property OwnerId System.String

Gets and sets the property OwnerId.

The ID of the Amazon Web Services account that owns the Capacity Reservation.

Public Property StartDate System.DateTime

Gets and sets the property StartDate.

The date and time at which the Capacity Reservation was started.

Public Property State Amazon.EC2.CapacityReservationState

Gets and sets the property State.

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

Public Property Tags System.Collections.Generic.List<Amazon.EC2.Model.Tag>

Gets and sets the property Tags.

Any tags assigned to the Capacity Reservation.

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.

Public Property TotalInstanceCount System.Int32

Gets and sets the property TotalInstanceCount.

The total number of instances for which the Capacity Reservation reserves capacity.

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