CapacityReservation

ec2.services.k8s.aws/v1alpha1

TypeLink
GoDocec2-controller/apis/v1alpha1#CapacityReservation

Metadata

PropertyValue
ScopeNamespaced
KindCapacityReservation
ListKindCapacityReservationList
Pluralcapacityreservations
Singularcapacityreservation

Describes a Capacity Reservation.

Spec

additionalInfo: string
availabilityZone: string
availabilityZoneID: string
commitmentDuration: integer
deliveryPreference: string
ebsOptimized: boolean
endDate: string
endDateType: string
ephemeralStorage: boolean
instanceCount: integer
instanceMatchCriteria: string
instancePlatform: string
instanceType: string
outpostARN: string
placementGroupARN: string
startDate: string
tags:
- key: string
  value: string
tenancy: string
FieldDescription
additionalInfo
Optional		string
Reserved for future use.
availabilityZone
Optional		string
The Availability Zone in which to create the Capacity Reservation.
availabilityZoneID
Optional		string
The ID of the Availability Zone in which to create the Capacity Reservation.
commitmentDuration
Optional		integer
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 active state in your account
after it has been delivered.

For more information, see Commitment duration (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-concepts.html#cr-commitment-duration).
deliveryPreference
Optional		string
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 incremental.
ebsOptimized
Optional		boolean
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
Optional		string
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.

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
Optional		string
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.
ephemeralStorage
Optional		boolean
Deprecated.
instanceCount
Required		integer
The number of instances for which to reserve capacity.

You can request future-dated Capacity Reservations for an instance count
with a minimum of 100 VPUs. For example, if you request a future-dated Capacity
Reservation for m5.xlarge instances, you must request at least 25 instances
(25 * m5.xlarge = 100 vCPUs).

Valid range: 1 - 1000
instanceMatchCriteria
Optional		string
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.

If you are requesting a future-dated Capacity Reservation, you must specify
targeted.

Default: open
instancePlatform
Required		string
The type of operating system for which to reserve capacity.
instanceType
Required		string
The instance type for which to reserve capacity.

You can request future-dated Capacity Reservations for instance types in
the C, M, R, I, and T instance families only.

For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
in the Amazon EC2 User Guide.
outpostARN
Optional		string
Not supported for future-dated Capacity Reservations.

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity
Reservation.
placementGroupARN
Optional		string
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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html)
in the Amazon EC2 User Guide.
startDate
Optional		string
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 (YYYY-MM-DDThh:mm:ss.sssZ).

You can request a future-dated Capacity Reservation between 5 and 120 days
in advance.
tags
Optional		array
The tags. The value parameter is required, but if you don’t want the tag
to have a value, specify the parameter with no value, and we set the value
to an empty string.
tags.[]
Required		object
Describes a tag.
tags.[].value
Optional		string
tenancy
Optional		string
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.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
availableInstanceCount: integer
capacityAllocations:
- allocationType: string
  count: integer
capacityReservationFleetID: string
capacityReservationID: string
commitmentInfo: 
  commitmentEndDate: string
  committedInstanceCount: integer
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createDate: string
ownerID: string
reservationType: string
state: string
totalInstanceCount: integer
unusedReservationBillingOwnerID: string
FieldDescription
ackResourceMetadata
Optional		object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ackResourceMetadata.arn
Optional		string
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an “adopted” resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR’s Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required		string
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
ackResourceMetadata.region
Required		string
Region is the AWS region in which the resource exists or will exist.
availableInstanceCount
Optional		integer
The remaining capacity. Indicates the number of instances that can be launched
in the Capacity Reservation.
capacityAllocations
Optional		array
Information about instance capacity usage.
capacityAllocations.[]
Required		object
Information about instance capacity usage for a Capacity Reservation.
capacityAllocations.[].count
Optional		integer
capacityReservationFleetID
Optional		string
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.
capacityReservationID
Optional		string
The ID of the Capacity Reservation.
commitmentInfo
Optional		object
Information about your commitment for a future-dated Capacity Reservation.
commitmentInfo.commitmentEndDate
Optional		string
commitmentInfo.committedInstanceCount
Optional		integer
conditions
Optional		array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
conditions.[]
Required		object
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message
Optional		string
A human readable message indicating details about the transition.
conditions.[].reason
Optional		string
The reason for the condition’s last transition.
conditions.[].status
Optional		string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional		string
Type is the type of the Condition
createDate
Optional		string
The date and time at which the Capacity Reservation was created.
ownerID
Optional		string
The ID of the Amazon Web Services account that owns the Capacity Reservation.
reservationType
Optional		string
The type of Capacity Reservation.
state
Optional		string
The current state of the Capacity Reservation. A Capacity Reservation can
be in one of the following states:

* active - The capacity is available for use.

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

* cancelled - The Capacity Reservation was canceled. 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 can
fail due to request parameters that are not valid, capacity constraints,
or instance limit constraints. You can view a failed request for 60 minutes.

* scheduled - (Future-dated Capacity Reservations only) The future-dated
Capacity Reservation request was approved and the Capacity Reservation
is scheduled for delivery on the requested start date.

* assessing - (Future-dated Capacity Reservations only) Amazon EC2 is
assessing your request for a future-dated Capacity Reservation.

* delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered
a delay in provisioning the requested future-dated Capacity Reservation.
Amazon EC2 is unable to deliver the requested capacity by the requested
start date and time.

* unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can’t
support the future-dated Capacity Reservation request due to capacity
constraints. You can view unsupported requests for 30 days. The Capacity
Reservation will not be delivered.
totalInstanceCount
Optional		integer
The total number of instances for which the Capacity Reservation reserves
capacity.
unusedReservationBillingOwnerID
Optional		string
The ID of the Amazon Web Services account to which billing of the unused
capacity of the Capacity Reservation is assigned.