Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. CapacityReservation

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.CapacityReservation

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::EC2::CapacityReservation

Create CapacityReservation Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CapacityReservation(name: string, args: CapacityReservationArgs, opts?: CustomResourceOptions);
@overload
def CapacityReservation(resource_name: str,
                        args: CapacityReservationArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def CapacityReservation(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        instance_type: Optional[str] = None,
                        instance_platform: Optional[str] = None,
                        instance_count: Optional[int] = None,
                        end_date_type: Optional[str] = None,
                        instance_match_criteria: Optional[str] = None,
                        ephemeral_storage: Optional[bool] = None,
                        availability_zone_id: Optional[str] = None,
                        end_date: Optional[str] = None,
                        ebs_optimized: Optional[bool] = None,
                        availability_zone: Optional[str] = None,
                        out_post_arn: Optional[str] = None,
                        placement_group_arn: Optional[str] = None,
                        tag_specifications: Optional[Sequence[CapacityReservationTagSpecificationArgs]] = None,
                        tenancy: Optional[str] = None,
                        unused_reservation_billing_owner_id: Optional[str] = None)
func NewCapacityReservation(ctx *Context, name string, args CapacityReservationArgs, opts ...ResourceOption) (*CapacityReservation, error)
public CapacityReservation(string name, CapacityReservationArgs args, CustomResourceOptions? opts = null)
public CapacityReservation(String name, CapacityReservationArgs args)
public CapacityReservation(String name, CapacityReservationArgs args, CustomResourceOptions options)

type: aws-native:ec2:CapacityReservation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CapacityReservationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CapacityReservationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityReservationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityReservationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CapacityReservationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CapacityReservation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CapacityReservation resource accepts the following input properties:

InstanceCount This property is required. int

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

InstancePlatform This property is required. string
The type of operating system for which to reserve capacity.
InstanceType This property is 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 in the Amazon EC2 User Guide .

AvailabilityZone string
The Availability Zone in which to create the Capacity Reservation.
AvailabilityZoneId string
The Availability Zone ID of the Capacity Reservation.
EbsOptimized bool
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 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 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 bool
Deprecated.
InstanceMatchCriteria 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

OutPostArn string

Not supported for future-dated Capacity Reservations.

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

PlacementGroupArn 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 in the Amazon EC2 User Guide .

TagSpecifications List<Pulumi.AwsNative.Ec2.Inputs.CapacityReservationTagSpecification>
The tags to apply to the Capacity Reservation during launch.
Tenancy 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 AWS accounts .
  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
UnusedReservationBillingOwnerId string

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations .

You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see AWS::RAM::ResourceShare .

InstanceCount This property is required. int

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

InstancePlatform This property is required. string
The type of operating system for which to reserve capacity.
InstanceType This property is 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 in the Amazon EC2 User Guide .

AvailabilityZone string
The Availability Zone in which to create the Capacity Reservation.
AvailabilityZoneId string
The Availability Zone ID of the Capacity Reservation.
EbsOptimized bool
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 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 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 bool
Deprecated.
InstanceMatchCriteria 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

OutPostArn string

Not supported for future-dated Capacity Reservations.

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

PlacementGroupArn 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 in the Amazon EC2 User Guide .

TagSpecifications []CapacityReservationTagSpecificationArgs
The tags to apply to the Capacity Reservation during launch.
Tenancy 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 AWS accounts .
  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
UnusedReservationBillingOwnerId string

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations .

You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see AWS::RAM::ResourceShare .

instanceCount This property is 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 vCPUs. 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

instancePlatform This property is required. String
The type of operating system for which to reserve capacity.
instanceType This property is 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 in the Amazon EC2 User Guide .

availabilityZone String
The Availability Zone in which to create the Capacity Reservation.
availabilityZoneId String
The Availability Zone ID of the Capacity Reservation.
ebsOptimized 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 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 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 Boolean
Deprecated.
instanceMatchCriteria 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

outPostArn String

Not supported for future-dated Capacity Reservations.

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

placementGroupArn 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 in the Amazon EC2 User Guide .

tagSpecifications List<CapacityReservationTagSpecification>
The tags to apply to the Capacity Reservation during launch.
tenancy 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 AWS accounts .
  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
unusedReservationBillingOwnerId String

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations .

You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see AWS::RAM::ResourceShare .

instanceCount This property is required. number

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

instancePlatform This property is required. string
The type of operating system for which to reserve capacity.
instanceType This property is 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 in the Amazon EC2 User Guide .

availabilityZone string
The Availability Zone in which to create the Capacity Reservation.
availabilityZoneId string
The Availability Zone ID of the Capacity Reservation.
ebsOptimized 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 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 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 boolean
Deprecated.
instanceMatchCriteria 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

outPostArn string

Not supported for future-dated Capacity Reservations.

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

placementGroupArn 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 in the Amazon EC2 User Guide .

tagSpecifications CapacityReservationTagSpecification[]
The tags to apply to the Capacity Reservation during launch.
tenancy 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 AWS accounts .
  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
unusedReservationBillingOwnerId string

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations .

You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see AWS::RAM::ResourceShare .

instance_count This property is required. int

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

instance_platform This property is required. str
The type of operating system for which to reserve capacity.
instance_type This property is required. str

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 in the Amazon EC2 User Guide .

availability_zone str
The Availability Zone in which to create the Capacity Reservation.
availability_zone_id str
The Availability Zone ID of the Capacity Reservation.
ebs_optimized bool
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.
end_date str

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.

end_date_type str
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 .
ephemeral_storage bool
Deprecated.
instance_match_criteria str

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

out_post_arn str

Not supported for future-dated Capacity Reservations.

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

placement_group_arn str

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 .

tag_specifications Sequence[CapacityReservationTagSpecificationArgs]
The tags to apply to the Capacity Reservation during launch.
tenancy str
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 AWS accounts .
  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
unused_reservation_billing_owner_id str

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations .

You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see AWS::RAM::ResourceShare .

instanceCount This property is required. Number

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

instancePlatform This property is required. String
The type of operating system for which to reserve capacity.
instanceType This property is 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 in the Amazon EC2 User Guide .

availabilityZone String
The Availability Zone in which to create the Capacity Reservation.
availabilityZoneId String
The Availability Zone ID of the Capacity Reservation.
ebsOptimized 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 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 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 Boolean
Deprecated.
instanceMatchCriteria 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

outPostArn String

Not supported for future-dated Capacity Reservations.

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

placementGroupArn 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 in the Amazon EC2 User Guide .

tagSpecifications List<Property Map>
The tags to apply to the Capacity Reservation during launch.
tenancy 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 AWS accounts .
  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
unusedReservationBillingOwnerId String

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations .

You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see AWS::RAM::ResourceShare .

Outputs

All input properties are implicitly available as output properties. Additionally, the CapacityReservation resource produces the following output properties:

AvailableInstanceCount int
Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
AwsId string
The ID of the Capacity Reservation.
Id string
The provider-assigned unique ID for this managed resource.
TotalInstanceCount int
Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
AvailableInstanceCount int
Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
AwsId string
The ID of the Capacity Reservation.
Id string
The provider-assigned unique ID for this managed resource.
TotalInstanceCount int
Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
availableInstanceCount Integer
Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
awsId String
The ID of the Capacity Reservation.
id String
The provider-assigned unique ID for this managed resource.
totalInstanceCount Integer
Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
availableInstanceCount number
Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
awsId string
The ID of the Capacity Reservation.
id string
The provider-assigned unique ID for this managed resource.
totalInstanceCount number
Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
available_instance_count int
Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
aws_id str
The ID of the Capacity Reservation.
id str
The provider-assigned unique ID for this managed resource.
total_instance_count int
Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
availableInstanceCount Number
Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
awsId String
The ID of the Capacity Reservation.
id String
The provider-assigned unique ID for this managed resource.
totalInstanceCount Number
Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .

Supporting Types

CapacityReservationTag
, CapacityReservationTagArgs

Key This property is required. string
The tag key.
Value This property is required. string
The tag value.
Key This property is required. string
The tag key.
Value This property is required. string
The tag value.
key This property is required. String
The tag key.
value This property is required. String
The tag value.
key This property is required. string
The tag key.
value This property is required. string
The tag value.
key This property is required. str
The tag key.
value This property is required. str
The tag value.
key This property is required. String
The tag key.
value This property is required. String
The tag value.

CapacityReservationTagSpecification
, CapacityReservationTagSpecificationArgs

ResourceType string
The type of resource to tag. Specify capacity-reservation .
Tags List<Pulumi.AwsNative.Ec2.Inputs.CapacityReservationTag>
The tags to apply to the resource.
ResourceType string
The type of resource to tag. Specify capacity-reservation .
Tags []CapacityReservationTag
The tags to apply to the resource.
resourceType String
The type of resource to tag. Specify capacity-reservation .
tags List<CapacityReservationTag>
The tags to apply to the resource.
resourceType string
The type of resource to tag. Specify capacity-reservation .
tags CapacityReservationTag[]
The tags to apply to the resource.
resource_type str
The type of resource to tag. Specify capacity-reservation .
tags Sequence[CapacityReservationTag]
The tags to apply to the resource.
resourceType String
The type of resource to tag. Specify capacity-reservation .
tags List<Property Map>
The tags to apply to the resource.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native