aws-cdk-lib.aws_ec2.CfnCapacityReservation

class CfnCapacityReservation (construct)

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnCapacityReservation
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnCapacityReservation
Javasoftware.amazon.awscdk.services.ec2.CfnCapacityReservation
Pythonaws_cdk.aws_ec2.CfnCapacityReservation
TypeScript aws-cdk-lib » aws_ec2 » CfnCapacityReservation

Implements IConstruct, IDependable, IInspectable

A CloudFormation AWS::EC2::CapacityReservation.

Creates a new Capacity Reservation with the specified attributes. For more information, see Capacity Reservations in the Amazon EC2 User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnCapacityReservation = new ec2.CfnCapacityReservation(this, 'MyCfnCapacityReservation', {
  availabilityZone: 'availabilityZone',
  instanceCount: 123,
  instancePlatform: 'instancePlatform',
  instanceType: 'instanceType',

  // the properties below are optional
  ebsOptimized: false,
  endDate: 'endDate',
  endDateType: 'endDateType',
  ephemeralStorage: false,
  instanceMatchCriteria: 'instanceMatchCriteria',
  outPostArn: 'outPostArn',
  placementGroupArn: 'placementGroupArn',
  tagSpecifications: [{
    resourceType: 'resourceType',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],
  tenancy: 'tenancy',
});

Initializer

new CfnCapacityReservation(scope: Construct, id: string, props: CfnCapacityReservationProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnCapacityReservationProps — - resource properties.

Create a new AWS::EC2::CapacityReservation.

Construct Props

NameTypeDescription
availabilityZonestringThe Availability Zone in which to create the Capacity Reservation.
instanceCountnumberThe number of instances for which to reserve capacity.
instancePlatformstringThe type of operating system for which to reserve capacity.
instanceTypestringThe instance type for which to reserve capacity.
ebsOptimized?boolean | IResolvableIndicates whether the Capacity Reservation supports EBS-optimized instances.
endDate?stringThe date and time at which the Capacity Reservation expires.
endDateType?stringIndicates the way in which the Capacity Reservation ends.
ephemeralStorage?boolean | IResolvableDeprecated..
instanceMatchCriteria?stringIndicates the type of instance launches that the Capacity Reservation accepts. The options include:.
outPostArn?stringThe Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
placementGroupArn?stringThe Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.
tagSpecifications?IResolvable | IResolvable | TagSpecificationProperty[]The tags to apply to the Capacity Reservation during launch.
tenancy?stringIndicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:.

availabilityZone

Type: string

The Availability Zone in which to create the Capacity Reservation.


instanceCount

Type: number

The number of instances for which to reserve capacity.

Valid range: 1 - 1000


instancePlatform

Type: string

The type of operating system for which to reserve capacity.


instanceType

Type: string

The instance type for which to reserve capacity.

For more information, see Instance types in the Amazon EC2 User Guide .


ebsOptimized?

Type: boolean | IResolvable (optional)

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?

Type: string (optional)

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.


endDateType?

Type: string (optional)

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?

Type: boolean | IResolvable (optional)

Deprecated..


instanceMatchCriteria?

Type: string (optional)

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


outPostArn?

Type: string (optional)

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


placementGroupArn?

Type: string (optional)

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?

Type: IResolvable | IResolvable | TagSpecificationProperty[] (optional)

The tags to apply to the Capacity Reservation during launch.


tenancy?

Type: string (optional)

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 .

Properties

NameTypeDescription
attrAvailabilityZonestringReturns the Availability Zone in which the capacity is reserved.
attrAvailableInstanceCountnumberReturns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation.
attrIdstringThe ID of the Capacity Reservation.
attrInstanceTypestringReturns the type of instance for which the capacity is reserved.
attrTenancystringReturns the tenancy of the Capacity Reservation.
attrTotalInstanceCountnumberReturns the total number of instances for which the Capacity Reservation reserves capacity.
availabilityZonestringThe Availability Zone in which to create the Capacity Reservation.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
instanceCountnumberThe number of instances for which to reserve capacity.
instancePlatformstringThe type of operating system for which to reserve capacity.
instanceTypestringThe instance type for which to reserve capacity.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
stackStackThe stack in which this element is defined.
ebsOptimized?boolean | IResolvableIndicates whether the Capacity Reservation supports EBS-optimized instances.
endDate?stringThe date and time at which the Capacity Reservation expires.
endDateType?stringIndicates the way in which the Capacity Reservation ends.
ephemeralStorage?boolean | IResolvableDeprecated..
instanceMatchCriteria?stringIndicates the type of instance launches that the Capacity Reservation accepts. The options include:.
outPostArn?stringThe Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
placementGroupArn?stringThe Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.
tagSpecifications?IResolvable | IResolvable | TagSpecificationProperty[]The tags to apply to the Capacity Reservation during launch.
tenancy?stringIndicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrAvailabilityZone

Type: string

Returns the Availability Zone in which the capacity is reserved.

For example: us-east-1a .


attrAvailableInstanceCount

Type: number

Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation.

For example: 9 .


attrId

Type: string

The ID of the Capacity Reservation.


attrInstanceType

Type: string

Returns the type of instance for which the capacity is reserved.

For example: m4.large .


attrTenancy

Type: string

Returns the tenancy of the Capacity Reservation.

For example: dedicated .


attrTotalInstanceCount

Type: number

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

For example: 15 .


availabilityZone

Type: string

The Availability Zone in which to create the Capacity Reservation.


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


instanceCount

Type: number

The number of instances for which to reserve capacity.

Valid range: 1 - 1000


instancePlatform

Type: string

The type of operating system for which to reserve capacity.


instanceType

Type: string

The instance type for which to reserve capacity.

For more information, see Instance types in the Amazon EC2 User Guide .


logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


node

Type: Node

The tree node.


ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


ebsOptimized?

Type: boolean | IResolvable (optional)

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?

Type: string (optional)

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.


endDateType?

Type: string (optional)

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?

Type: boolean | IResolvable (optional)

Deprecated..


instanceMatchCriteria?

Type: string (optional)

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


outPostArn?

Type: string (optional)

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


placementGroupArn?

Type: string (optional)

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?

Type: IResolvable | IResolvable | TagSpecificationProperty[] (optional)

The tags to apply to the Capacity Reservation during launch.


tenancy?

Type: string (optional)

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 .

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)


inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }