AWSEC2CapacityReservation

Objective-C

@interface AWSEC2CapacityReservation

Swift

class AWSEC2CapacityReservation

Describes a Capacity Reservation.

  • The Availability Zone in which the capacity is reserved.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable availabilityZone;

    Swift

    var availabilityZone: String? { get set }

  • The Availability Zone ID of the Capacity Reservation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable availabilityZoneId;

    Swift

    var availabilityZoneId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable availableInstanceCount;

    Swift

    var availableInstanceCount: NSNumber? { get set }

  • Information about instance capacity usage.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2CapacityAllocation *> *_Nullable capacityAllocations;

    Swift

    var capacityAllocations: [AWSEC2CapacityAllocation]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable capacityReservationArn;

    Swift

    var capacityReservationArn: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable capacityReservationFleetId;

    Swift

    var capacityReservationFleetId: String? { get set }

  • The ID of the Capacity Reservation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable capacityReservationId;

    Swift

    var capacityReservationId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable createDate;

    Swift

    var createDate: Date? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable ebsOptimized;

    Swift

    var ebsOptimized: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endDate;

    Swift

    var endDate: Date? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2EndDateType endDateType;

    Swift

    var endDateType: AWSEC2EndDateType { get set }

  • Deprecated.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable ephemeralStorage;

    Swift

    var ephemeralStorage: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMatchCriteria instanceMatchCriteria;

    Swift

    var instanceMatchCriteria: AWSEC2InstanceMatchCriteria { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2CapacityReservationInstancePlatform instancePlatform;

    Swift

    var instancePlatform: AWSEC2CapacityReservationInstancePlatform { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable instanceType;

    Swift

    var instanceType: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable outpostArn;

    Swift

    var outpostArn: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable ownerId;

    Swift

    var ownerId: String? { get set }

  • The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable placementGroupArn;

    Swift

    var placementGroupArn: String? { get set }

  • The type of Capacity Reservation.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2CapacityReservationType reservationType;

    Swift

    var reservationType: AWSEC2CapacityReservationType { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startDate;

    Swift

    var startDate: Date? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2CapacityReservationState state;

    Swift

    var state: AWSEC2CapacityReservationState { get set }

  • Any tags assigned to the Capacity Reservation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSEC2Tag *> *_Nullable tags;

    Swift

    var tags: [AWSEC2Tag]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2CapacityReservationTenancy tenancy;

    Swift

    var tenancy: AWSEC2CapacityReservationTenancy { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable totalInstanceCount;

    Swift

    var totalInstanceCount: NSNumber? { get set }