ec2CapacityReservation.md

ec2CapacityReservation Submodule

Constructs

Ec2CapacityReservation

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation aws_ec2_capacity_reservation}.

Initializers

import { ec2CapacityReservation } from '@cdktf/aws-cdk'

new ec2CapacityReservation.Ec2CapacityReservation(scope: Construct, id: string, config: Ec2CapacityReservationConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	Ec2CapacityReservationConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: Ec2CapacityReservationConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
resetEbsOptimized	No description.
resetEndDate	No description.
resetEndDateType	No description.
resetEphemeralStorage	No description.
resetId	No description.
resetInstanceMatchCriteria	No description.
resetOutpostArn	No description.
resetTags	No description.
resetTagsAll	No description.
resetTenancy	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

resetEbsOptimized

public resetEbsOptimized(): void

resetEndDate

public resetEndDate(): void

resetEndDateType

public resetEndDateType(): void

resetEphemeralStorage

public resetEphemeralStorage(): void

resetId

public resetId(): void

resetInstanceMatchCriteria

public resetInstanceMatchCriteria(): void

resetOutpostArn

public resetOutpostArn(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetTenancy

public resetTenancy(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a Ec2CapacityReservation resource upon running "cdktf plan ".

---

isConstruct

import { ec2CapacityReservation } from '@cdktf/aws-cdk'

ec2CapacityReservation.Ec2CapacityReservation.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { ec2CapacityReservation } from '@cdktf/aws-cdk'

ec2CapacityReservation.Ec2CapacityReservation.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { ec2CapacityReservation } from '@cdktf/aws-cdk'

ec2CapacityReservation.Ec2CapacityReservation.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { ec2CapacityReservation } from '@cdktf/aws-cdk'

ec2CapacityReservation.Ec2CapacityReservation.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a Ec2CapacityReservation resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the Ec2CapacityReservation to import.

---

importFromId^Required

• Type: string

The id of the existing Ec2CapacityReservation that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the Ec2CapacityReservation to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
arn	string	No description.
ownerId	string	No description.
availabilityZoneInput	string	No description.
ebsOptimizedInput	boolean | cdktf.IResolvable	No description.
endDateInput	string	No description.
endDateTypeInput	string	No description.
ephemeralStorageInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
instanceCountInput	number	No description.
instanceMatchCriteriaInput	string	No description.
instancePlatformInput	string	No description.
instanceTypeInput	string	No description.
outpostArnInput	string	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
tenancyInput	string	No description.
availabilityZone	string	No description.
ebsOptimized	boolean | cdktf.IResolvable	No description.
endDate	string	No description.
endDateType	string	No description.
ephemeralStorage	boolean | cdktf.IResolvable	No description.
id	string	No description.
instanceCount	number	No description.
instanceMatchCriteria	string	No description.
instancePlatform	string	No description.
instanceType	string	No description.
outpostArn	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
tenancy	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arn^Required

public readonly arn: string;

• Type: string

---

ownerId^Required

public readonly ownerId: string;

• Type: string

---

availabilityZoneInput^Optional

public readonly availabilityZoneInput: string;

• Type: string

---

ebsOptimizedInput^Optional

public readonly ebsOptimizedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

endDateInput^Optional

public readonly endDateInput: string;

• Type: string

---

endDateTypeInput^Optional

public readonly endDateTypeInput: string;

• Type: string

---

ephemeralStorageInput^Optional

public readonly ephemeralStorageInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

instanceCountInput^Optional

public readonly instanceCountInput: number;

• Type: number

---

instanceMatchCriteriaInput^Optional

public readonly instanceMatchCriteriaInput: string;

• Type: string

---

instancePlatformInput^Optional

public readonly instancePlatformInput: string;

• Type: string

---

instanceTypeInput^Optional

public readonly instanceTypeInput: string;

• Type: string

---

outpostArnInput^Optional

public readonly outpostArnInput: string;

• Type: string

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tenancyInput^Optional

public readonly tenancyInput: string;

• Type: string

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

ebsOptimized^Required

public readonly ebsOptimized: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

endDate^Required

public readonly endDate: string;

• Type: string

---

endDateType^Required

public readonly endDateType: string;

• Type: string

---

ephemeralStorage^Required

public readonly ephemeralStorage: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

instanceCount^Required

public readonly instanceCount: number;

• Type: number

---

instanceMatchCriteria^Required

public readonly instanceMatchCriteria: string;

• Type: string

---

instancePlatform^Required

public readonly instancePlatform: string;

• Type: string

---

instanceType^Required

public readonly instanceType: string;

• Type: string

---

outpostArn^Required

public readonly outpostArn: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tenancy^Required

public readonly tenancy: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

Ec2CapacityReservationConfig

Initializer

import { ec2CapacityReservation } from '@cdktf/aws-cdk'

const ec2CapacityReservationConfig: ec2CapacityReservation.Ec2CapacityReservationConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
availabilityZone	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#availability_zone Ec2CapacityReservation#availability_zone}.
instanceCount	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_count Ec2CapacityReservation#instance_count}.
instancePlatform	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_platform Ec2CapacityReservation#instance_platform}.
instanceType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_type Ec2CapacityReservation#instance_type}.
ebsOptimized	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#ebs_optimized Ec2CapacityReservation#ebs_optimized}.
endDate	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#end_date Ec2CapacityReservation#end_date}.
endDateType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#end_date_type Ec2CapacityReservation#end_date_type}.
ephemeralStorage	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#ephemeral_storage Ec2CapacityReservation#ephemeral_storage}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#id Ec2CapacityReservation#id}.
instanceMatchCriteria	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_match_criteria Ec2CapacityReservation#instance_match_criteria}.
outpostArn	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#outpost_arn Ec2CapacityReservation#outpost_arn}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#tags Ec2CapacityReservation#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#tags_all Ec2CapacityReservation#tags_all}.
tenancy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#tenancy Ec2CapacityReservation#tenancy}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#availability_zone Ec2CapacityReservation#availability_zone}.

---

instanceCount^Required

public readonly instanceCount: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_count Ec2CapacityReservation#instance_count}.

---

instancePlatform^Required

public readonly instancePlatform: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_platform Ec2CapacityReservation#instance_platform}.

---

instanceType^Required

public readonly instanceType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_type Ec2CapacityReservation#instance_type}.

---

ebsOptimized^Optional

public readonly ebsOptimized: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#ebs_optimized Ec2CapacityReservation#ebs_optimized}.

---

endDate^Optional

public readonly endDate: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#end_date Ec2CapacityReservation#end_date}.

---

endDateType^Optional

public readonly endDateType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#end_date_type Ec2CapacityReservation#end_date_type}.

---

ephemeralStorage^Optional

public readonly ephemeralStorage: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#ephemeral_storage Ec2CapacityReservation#ephemeral_storage}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#id Ec2CapacityReservation#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

instanceMatchCriteria^Optional

public readonly instanceMatchCriteria: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#instance_match_criteria Ec2CapacityReservation#instance_match_criteria}.

---

outpostArn^Optional

public readonly outpostArn: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#outpost_arn Ec2CapacityReservation#outpost_arn}.

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#tags Ec2CapacityReservation#tags}.

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#tags_all Ec2CapacityReservation#tags_all}.

---

tenancy^Optional

public readonly tenancy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_capacity_reservation#tenancy Ec2CapacityReservation#tenancy}.

---