Skip to content

Latest commit

 

History

History
2572 lines (1579 loc) · 100 KB

dataAwsAmi.md

File metadata and controls

2572 lines (1579 loc) · 100 KB

data_aws_ami

Refer to the Terraform Registory for docs: data_aws_ami.

dataAwsAmi Submodule

Constructs

DataAwsAmi

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami aws_ami}.

Initializers 

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

new dataAwsAmi.DataAwsAmi(scope: Construct, id: string, config: DataAwsAmiConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataAwsAmiConfig 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.
putFilter No description.
resetExecutableUsers No description.
resetFilter No description.
resetId No description.
resetMostRecent No description.
resetNameRegex No description.
resetTags 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
putFilter 
public putFilter(value: IResolvable | DataAwsAmiFilter[]): void
valueRequired
resetExecutableUsers 
public resetExecutableUsers(): void
resetFilter 
public resetFilter(): void
resetId 
public resetId(): void
resetMostRecent 
public resetMostRecent(): void
resetNameRegex 
public resetNameRegex(): void
resetTags 
public resetTags(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
isConstruct 
import { dataAwsAmi } from '@cdktf/aws-cdk'

dataAwsAmi.DataAwsAmi.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 { dataAwsAmi } from '@cdktf/aws-cdk'

dataAwsAmi.DataAwsAmi.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformDataSource 
import { dataAwsAmi } from '@cdktf/aws-cdk'

dataAwsAmi.DataAwsAmi.isTerraformDataSource(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.
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.
architecture string No description.
arn string No description.
blockDeviceMappings DataAwsAmiBlockDeviceMappingsList No description.
creationDate string No description.
description string No description.
enaSupport cdktf.IResolvable No description.
filter DataAwsAmiFilterList No description.
hypervisor string No description.
imageId string No description.
imageLocation string No description.
imageOwnerAlias string No description.
imageType string No description.
kernelId string No description.
name string No description.
ownerId string No description.
platform string No description.
platformDetails string No description.
productCodes DataAwsAmiProductCodesList No description.
public cdktf.IResolvable No description.
ramdiskId string No description.
rootDeviceName string No description.
rootDeviceType string No description.
rootSnapshotId string No description.
sriovNetSupport string No description.
state string No description.
stateReason cdktf.StringMap No description.
usageOperation string No description.
virtualizationType string No description.
executableUsersInput string[] No description.
filterInput cdktf.IResolvable | DataAwsAmiFilter[] No description.
idInput string No description.
mostRecentInput boolean | cdktf.IResolvable No description.
nameRegexInput string No description.
ownersInput string[] No description.
tagsInput {[ key: string ]: string} No description.
executableUsers string[] No description.
id string No description.
mostRecent boolean | cdktf.IResolvable No description.
nameRegex string No description.
owners string[] No description.
tags {[ 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
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
architectureRequired 
public readonly architecture: string;
  • Type: string
arnRequired 
public readonly arn: string;
  • Type: string
blockDeviceMappingsRequired 
public readonly blockDeviceMappings: DataAwsAmiBlockDeviceMappingsList;
creationDateRequired 
public readonly creationDate: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
enaSupportRequired 
public readonly enaSupport: IResolvable;
  • Type: cdktf.IResolvable
filterRequired 
public readonly filter: DataAwsAmiFilterList;
hypervisorRequired 
public readonly hypervisor: string;
  • Type: string
imageIdRequired 
public readonly imageId: 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
nameRequired 
public readonly name: string;
  • Type: string
ownerIdRequired 
public readonly ownerId: string;
  • Type: string
platformRequired 
public readonly platform: string;
  • Type: string
platformDetailsRequired 
public readonly platformDetails: string;
  • Type: string
productCodesRequired 
public readonly productCodes: DataAwsAmiProductCodesList;
publicRequired 
public readonly public: IResolvable;
  • Type: cdktf.IResolvable
ramdiskIdRequired 
public readonly ramdiskId: string;
  • Type: string
rootDeviceNameRequired 
public readonly rootDeviceName: string;
  • Type: string
rootDeviceTypeRequired 
public readonly rootDeviceType: string;
  • Type: string
rootSnapshotIdRequired 
public readonly rootSnapshotId: string;
  • Type: string
sriovNetSupportRequired 
public readonly sriovNetSupport: string;
  • Type: string
stateRequired 
public readonly state: string;
  • Type: string
stateReasonRequired 
public readonly stateReason: StringMap;
  • Type: cdktf.StringMap
usageOperationRequired 
public readonly usageOperation: string;
  • Type: string
virtualizationTypeRequired 
public readonly virtualizationType: string;
  • Type: string
executableUsersInputOptional 
public readonly executableUsersInput: string[];
  • Type: string[]
filterInputOptional 
public readonly filterInput: IResolvable | DataAwsAmiFilter[];
idInputOptional 
public readonly idInput: string;
  • Type: string
mostRecentInputOptional 
public readonly mostRecentInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameRegexInputOptional 
public readonly nameRegexInput: string;
  • Type: string
ownersInputOptional 
public readonly ownersInput: string[];
  • Type: string[]
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
executableUsersRequired 
public readonly executableUsers: string[];
  • Type: string[]
idRequired 
public readonly id: string;
  • Type: string
mostRecentRequired 
public readonly mostRecent: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameRegexRequired 
public readonly nameRegex: string;
  • Type: string
ownersRequired 
public readonly owners: string[];
  • Type: string[]
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

DataAwsAmiBlockDeviceMappings

Initializer 

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

const dataAwsAmiBlockDeviceMappings: dataAwsAmi.DataAwsAmiBlockDeviceMappings = { ... }

DataAwsAmiConfig

Initializer 

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

const dataAwsAmiConfig: dataAwsAmi.DataAwsAmiConfig = { ... }

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.
owners string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#owners DataAwsAmi#owners}.
executableUsers string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#executable_users DataAwsAmi#executable_users}.
filter cdktf.IResolvable | DataAwsAmiFilter[] filter block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#id DataAwsAmi#id}.
mostRecent boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#most_recent DataAwsAmi#most_recent}.
nameRegex string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#name_regex DataAwsAmi#name_regex}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#tags DataAwsAmi#tags}.
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[]
ownersRequired 
public readonly owners: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#owners DataAwsAmi#owners}.

executableUsersOptional 
public readonly executableUsers: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#executable_users DataAwsAmi#executable_users}.

filterOptional 
public readonly filter: IResolvable | DataAwsAmiFilter[];

filter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#filter DataAwsAmi#filter}

idOptional 
public readonly id: string;
  • Type: string

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

mostRecentOptional 
public readonly mostRecent: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#most_recent DataAwsAmi#most_recent}.

nameRegexOptional 
public readonly nameRegex: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#name_regex DataAwsAmi#name_regex}.

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/data-sources/ami#tags DataAwsAmi#tags}.

DataAwsAmiFilter

Initializer 

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

const dataAwsAmiFilter: dataAwsAmi.DataAwsAmiFilter = { ... }

Properties

Name Type Description
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#name DataAwsAmi#name}.
values string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#values DataAwsAmi#values}.
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#name DataAwsAmi#name}.

valuesRequired 
public readonly values: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/ami#values DataAwsAmi#values}.

DataAwsAmiProductCodes

Initializer 

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

const dataAwsAmiProductCodes: dataAwsAmi.DataAwsAmiProductCodes = { ... }

Classes

DataAwsAmiBlockDeviceMappingsList

Initializers 

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

new dataAwsAmi.DataAwsAmiBlockDeviceMappingsList(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): DataAwsAmiBlockDeviceMappingsOutputReference
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.
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

DataAwsAmiBlockDeviceMappingsOutputReference

Initializers 

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

new dataAwsAmi.DataAwsAmiBlockDeviceMappingsOutputReference(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.
ebs cdktf.StringMap No description.
noDevice string No description.
virtualName string No description.
internalValue DataAwsAmiBlockDeviceMappings 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
ebsRequired 
public readonly ebs: StringMap;
  • Type: cdktf.StringMap
noDeviceRequired 
public readonly noDevice: string;
  • Type: string
virtualNameRequired 
public readonly virtualName: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DataAwsAmiBlockDeviceMappings;

DataAwsAmiFilterList

Initializers 

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

new dataAwsAmi.DataAwsAmiFilterList(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): DataAwsAmiFilterOutputReference
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 | DataAwsAmiFilter[] 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 | DataAwsAmiFilter[];

DataAwsAmiFilterOutputReference

Initializers 

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

new dataAwsAmi.DataAwsAmiFilterOutputReference(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.
nameInput string No description.
valuesInput string[] No description.
name string No description.
values string[] No description.
internalValue cdktf.IResolvable | DataAwsAmiFilter 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
nameInputOptional 
public readonly nameInput: string;
  • Type: string
valuesInputOptional 
public readonly valuesInput: string[];
  • Type: string[]
nameRequired 
public readonly name: string;
  • Type: string
valuesRequired 
public readonly values: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: IResolvable | DataAwsAmiFilter;

DataAwsAmiProductCodesList

Initializers 

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

new dataAwsAmi.DataAwsAmiProductCodesList(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): DataAwsAmiProductCodesOutputReference
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.
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

DataAwsAmiProductCodesOutputReference

Initializers 

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

new dataAwsAmi.DataAwsAmiProductCodesOutputReference(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.
productCodeId string No description.
productCodeType string No description.
internalValue DataAwsAmiProductCodes 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
productCodeIdRequired 
public readonly productCodeId: string;
  • Type: string
productCodeTypeRequired 
public readonly productCodeType: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DataAwsAmiProductCodes;