Skip to content

Latest commit

 

History

History
2616 lines (1615 loc) · 111 KB

amiFromInstance.md

File metadata and controls

2616 lines (1615 loc) · 111 KB

aws_ami_from_instance

Refer to the Terraform Registory for docs: aws_ami_from_instance.

amiFromInstance Submodule

Constructs

AmiFromInstance

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

Initializers

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

new amiFromInstance.AmiFromInstance(scope: Construct, id: string, config: AmiFromInstanceConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config AmiFromInstanceConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
interpolationForAttribute No description.
putEbsBlockDevice No description.
putEphemeralBlockDevice No description.
putTimeouts No description.
resetDescription No description.
resetEbsBlockDevice No description.
resetEphemeralBlockDevice No description.
resetId No description.
resetSnapshotWithoutReboot No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

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

toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

putEbsBlockDevice
public putEbsBlockDevice(value: IResolvable | AmiFromInstanceEbsBlockDevice[]): void
valueRequired

putEphemeralBlockDevice
public putEphemeralBlockDevice(value: IResolvable | AmiFromInstanceEphemeralBlockDevice[]): void
valueRequired

putTimeouts
public putTimeouts(value: AmiFromInstanceTimeouts): void
valueRequired

resetDescription
public resetDescription(): void
resetEbsBlockDevice
public resetEbsBlockDevice(): void
resetEphemeralBlockDevice
public resetEphemeralBlockDevice(): void
resetId
public resetId(): void
resetSnapshotWithoutReboot
public resetSnapshotWithoutReboot(): void
resetTags
public resetTags(): void
resetTagsAll
public resetTagsAll(): void
resetTimeouts
public resetTimeouts(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.

isConstruct
import { amiFromInstance } from '@cdktf/aws-cdk'

amiFromInstance.AmiFromInstance.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { amiFromInstance } from '@cdktf/aws-cdk'

amiFromInstance.AmiFromInstance.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { amiFromInstance } from '@cdktf/aws-cdk'

amiFromInstance.AmiFromInstance.isTerraformResource(x: any)
xRequired
  • Type: any

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.
architecture string No description.
arn string No description.
ebsBlockDevice AmiFromInstanceEbsBlockDeviceList No description.
enaSupport cdktf.IResolvable No description.
ephemeralBlockDevice AmiFromInstanceEphemeralBlockDeviceList No description.
hypervisor string No description.
imageLocation string No description.
imageOwnerAlias string No description.
imageType string No description.
kernelId string No description.
manageEbsSnapshots cdktf.IResolvable No description.
ownerId string No description.
platform string No description.
platformDetails string No description.
public cdktf.IResolvable No description.
ramdiskId string No description.
rootDeviceName string No description.
rootSnapshotId string No description.
sriovNetSupport string No description.
timeouts AmiFromInstanceTimeoutsOutputReference No description.
usageOperation string No description.
virtualizationType string No description.
descriptionInput string No description.
ebsBlockDeviceInput cdktf.IResolvable | AmiFromInstanceEbsBlockDevice[] No description.
ephemeralBlockDeviceInput cdktf.IResolvable | AmiFromInstanceEphemeralBlockDevice[] No description.
idInput string No description.
nameInput string No description.
snapshotWithoutRebootInput boolean | cdktf.IResolvable No description.
sourceInstanceIdInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | AmiFromInstanceTimeouts No description.
description string No description.
id string No description.
name string No description.
snapshotWithoutReboot boolean | cdktf.IResolvable No description.
sourceInstanceId string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

architectureRequired
public readonly architecture: string;
  • Type: string

arnRequired
public readonly arn: string;
  • Type: string

ebsBlockDeviceRequired
public readonly ebsBlockDevice: AmiFromInstanceEbsBlockDeviceList;

enaSupportRequired
public readonly enaSupport: IResolvable;
  • Type: cdktf.IResolvable

ephemeralBlockDeviceRequired
public readonly ephemeralBlockDevice: AmiFromInstanceEphemeralBlockDeviceList;

hypervisorRequired
public readonly hypervisor: string;
  • Type: string

imageLocationRequired
public readonly imageLocation: string;
  • Type: string

imageOwnerAliasRequired
public readonly imageOwnerAlias: string;
  • Type: string

imageTypeRequired
public readonly imageType: string;
  • Type: string

kernelIdRequired
public readonly kernelId: string;
  • Type: string

manageEbsSnapshotsRequired
public readonly manageEbsSnapshots: IResolvable;
  • Type: cdktf.IResolvable

ownerIdRequired
public readonly ownerId: string;
  • Type: string

platformRequired
public readonly platform: string;
  • Type: string

platformDetailsRequired
public readonly platformDetails: string;
  • Type: string

publicRequired
public readonly public: IResolvable;
  • Type: cdktf.IResolvable

ramdiskIdRequired
public readonly ramdiskId: string;
  • Type: string

rootDeviceNameRequired
public readonly rootDeviceName: string;
  • Type: string

rootSnapshotIdRequired
public readonly rootSnapshotId: string;
  • Type: string

sriovNetSupportRequired
public readonly sriovNetSupport: string;
  • Type: string

timeoutsRequired
public readonly timeouts: AmiFromInstanceTimeoutsOutputReference;

usageOperationRequired
public readonly usageOperation: string;
  • Type: string

virtualizationTypeRequired
public readonly virtualizationType: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

ebsBlockDeviceInputOptional
public readonly ebsBlockDeviceInput: IResolvable | AmiFromInstanceEbsBlockDevice[];

ephemeralBlockDeviceInputOptional
public readonly ephemeralBlockDeviceInput: IResolvable | AmiFromInstanceEphemeralBlockDevice[];

idInputOptional
public readonly idInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

snapshotWithoutRebootInputOptional
public readonly snapshotWithoutRebootInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

sourceInstanceIdInputOptional
public readonly sourceInstanceIdInput: string;
  • Type: string

tagsAllInputOptional
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | AmiFromInstanceTimeouts;

descriptionRequired
public readonly description: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

snapshotWithoutRebootRequired
public readonly snapshotWithoutReboot: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

sourceInstanceIdRequired
public readonly sourceInstanceId: string;
  • Type: string

tagsRequired
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsAllRequired
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

AmiFromInstanceConfig

Initializer

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

const amiFromInstanceConfig: amiFromInstance.AmiFromInstanceConfig = { ... }

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.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#name AmiFromInstance#name}.
sourceInstanceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#source_instance_id AmiFromInstance#source_instance_id}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#description AmiFromInstance#description}.
ebsBlockDevice cdktf.IResolvable | AmiFromInstanceEbsBlockDevice[] ebs_block_device block.
ephemeralBlockDevice cdktf.IResolvable | AmiFromInstanceEphemeralBlockDevice[] ephemeral_block_device block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#id AmiFromInstance#id}.
snapshotWithoutReboot boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#snapshot_without_reboot AmiFromInstance#snapshot_without_reboot}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#tags AmiFromInstance#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#tags_all AmiFromInstance#tags_all}.
timeouts AmiFromInstanceTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#name AmiFromInstance#name}.


sourceInstanceIdRequired
public readonly sourceInstanceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#source_instance_id AmiFromInstance#source_instance_id}.


descriptionOptional
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#description AmiFromInstance#description}.


ebsBlockDeviceOptional
public readonly ebsBlockDevice: IResolvable | AmiFromInstanceEbsBlockDevice[];

ebs_block_device block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#ebs_block_device AmiFromInstance#ebs_block_device}


ephemeralBlockDeviceOptional
public readonly ephemeralBlockDevice: IResolvable | AmiFromInstanceEphemeralBlockDevice[];

ephemeral_block_device block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#ephemeral_block_device AmiFromInstance#ephemeral_block_device}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#id AmiFromInstance#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.


snapshotWithoutRebootOptional
public readonly snapshotWithoutReboot: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#snapshot_without_reboot AmiFromInstance#snapshot_without_reboot}.


tagsOptional
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/ami_from_instance#tags AmiFromInstance#tags}.


tagsAllOptional
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/ami_from_instance#tags_all AmiFromInstance#tags_all}.


timeoutsOptional
public readonly timeouts: AmiFromInstanceTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#timeouts AmiFromInstance#timeouts}


AmiFromInstanceEbsBlockDevice

Initializer

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

const amiFromInstanceEbsBlockDevice: amiFromInstance.AmiFromInstanceEbsBlockDevice = { ... }

AmiFromInstanceEphemeralBlockDevice

Initializer

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

const amiFromInstanceEphemeralBlockDevice: amiFromInstance.AmiFromInstanceEphemeralBlockDevice = { ... }

AmiFromInstanceTimeouts

Initializer

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

const amiFromInstanceTimeouts: amiFromInstance.AmiFromInstanceTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#create AmiFromInstance#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#delete AmiFromInstance#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#update AmiFromInstance#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#create AmiFromInstance#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#delete AmiFromInstance#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ami_from_instance#update AmiFromInstance#update}.


Classes

AmiFromInstanceEbsBlockDeviceList

Initializers

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

new amiFromInstance.AmiFromInstanceEbsBlockDeviceList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): AmiFromInstanceEbsBlockDeviceOutputReference
indexRequired
  • Type: number

the index of the item to return.


Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | AmiFromInstanceEbsBlockDevice[] No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | AmiFromInstanceEbsBlockDevice[];

AmiFromInstanceEbsBlockDeviceOutputReference

Initializers

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

new amiFromInstance.AmiFromInstanceEbsBlockDeviceOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
deleteOnTermination cdktf.IResolvable No description.
deviceName string No description.
encrypted cdktf.IResolvable No description.
iops number No description.
snapshotId string No description.
throughput number No description.
volumeSize number No description.
volumeType string No description.
internalValue cdktf.IResolvable | AmiFromInstanceEbsBlockDevice No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

deleteOnTerminationRequired
public readonly deleteOnTermination: IResolvable;
  • Type: cdktf.IResolvable

deviceNameRequired
public readonly deviceName: string;
  • Type: string

encryptedRequired
public readonly encrypted: IResolvable;
  • Type: cdktf.IResolvable

iopsRequired
public readonly iops: number;
  • Type: number

snapshotIdRequired
public readonly snapshotId: string;
  • Type: string

throughputRequired
public readonly throughput: number;
  • Type: number

volumeSizeRequired
public readonly volumeSize: number;
  • Type: number

volumeTypeRequired
public readonly volumeType: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | AmiFromInstanceEbsBlockDevice;

AmiFromInstanceEphemeralBlockDeviceList

Initializers

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

new amiFromInstance.AmiFromInstanceEphemeralBlockDeviceList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): AmiFromInstanceEphemeralBlockDeviceOutputReference
indexRequired
  • Type: number

the index of the item to return.


Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | AmiFromInstanceEphemeralBlockDevice[] No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | AmiFromInstanceEphemeralBlockDevice[];

AmiFromInstanceEphemeralBlockDeviceOutputReference

Initializers

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

new amiFromInstance.AmiFromInstanceEphemeralBlockDeviceOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
deviceName string No description.
virtualName string No description.
internalValue cdktf.IResolvable | AmiFromInstanceEphemeralBlockDevice No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

deviceNameRequired
public readonly deviceName: string;
  • Type: string

virtualNameRequired
public readonly virtualName: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | AmiFromInstanceEphemeralBlockDevice;

AmiFromInstanceTimeoutsOutputReference

Initializers

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

new amiFromInstance.AmiFromInstanceTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
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.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetUpdate No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | AmiFromInstanceTimeouts No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | AmiFromInstanceTimeouts;