Skip to content

Latest commit

 

History

History
2279 lines (1383 loc) · 110 KB

dataAwsImagebuilderImageRecipe.md

File metadata and controls

2279 lines (1383 loc) · 110 KB

dataAwsImagebuilderImageRecipe Submodule

Constructs

DataAwsImagebuilderImageRecipe

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

Initializers

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

new dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipe(scope: Construct, id: string, config: DataAwsImagebuilderImageRecipeConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataAwsImagebuilderImageRecipeConfig 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.
toHclTerraform Adds this resource to the terraform JSON output.
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.
resetId 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.

toHclTerraform
public toHclTerraform(): any

Adds this resource to the terraform JSON output.

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

resetId
public resetId(): void
resetTags
public resetTags(): void

Static Functions

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

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

dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipe.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


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

dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipe.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformDataSource
import { dataAwsImagebuilderImageRecipe } from '@cdktf/aws-cdk'

dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipe.isTerraformDataSource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dataAwsImagebuilderImageRecipe } from '@cdktf/aws-cdk'

dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipe.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing DataAwsImagebuilderImageRecipe that should be imported.

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


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataAwsImagebuilderImageRecipe 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.
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.
blockDeviceMapping DataAwsImagebuilderImageRecipeBlockDeviceMappingList No description.
component DataAwsImagebuilderImageRecipeComponentList No description.
dateCreated string No description.
description string No description.
name string No description.
owner string No description.
parentImage string No description.
platform string No description.
userDataBase64 string No description.
version string No description.
workingDirectory string No description.
arnInput string No description.
idInput string No description.
tagsInput {[ key: string ]: string} No description.
arn string No description.
id 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

blockDeviceMappingRequired
public readonly blockDeviceMapping: DataAwsImagebuilderImageRecipeBlockDeviceMappingList;

componentRequired
public readonly component: DataAwsImagebuilderImageRecipeComponentList;

dateCreatedRequired
public readonly dateCreated: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

ownerRequired
public readonly owner: string;
  • Type: string

parentImageRequired
public readonly parentImage: string;
  • Type: string

platformRequired
public readonly platform: string;
  • Type: string

userDataBase64Required
public readonly userDataBase64: string;
  • Type: string

versionRequired
public readonly version: string;
  • Type: string

workingDirectoryRequired
public readonly workingDirectory: string;
  • Type: string

arnInputOptional
public readonly arnInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

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

arnRequired
public readonly arn: string;
  • Type: string

idRequired
public readonly id: 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

DataAwsImagebuilderImageRecipeBlockDeviceMapping

Initializer

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

const dataAwsImagebuilderImageRecipeBlockDeviceMapping: dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeBlockDeviceMapping = { ... }

DataAwsImagebuilderImageRecipeBlockDeviceMappingEbs

Initializer

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

const dataAwsImagebuilderImageRecipeBlockDeviceMappingEbs: dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeBlockDeviceMappingEbs = { ... }

DataAwsImagebuilderImageRecipeComponent

Initializer

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

const dataAwsImagebuilderImageRecipeComponent: dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeComponent = { ... }

DataAwsImagebuilderImageRecipeConfig

Initializer

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

const dataAwsImagebuilderImageRecipeConfig: dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeConfig = { ... }

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.
arn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/imagebuilder_image_recipe#arn DataAwsImagebuilderImageRecipe#arn}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/imagebuilder_image_recipe#id DataAwsImagebuilderImageRecipe#id}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/imagebuilder_image_recipe#tags DataAwsImagebuilderImageRecipe#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[]

arnRequired
public readonly arn: string;
  • Type: string

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


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/imagebuilder_image_recipe#id DataAwsImagebuilderImageRecipe#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.


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/imagebuilder_image_recipe#tags DataAwsImagebuilderImageRecipe#tags}.


Classes

DataAwsImagebuilderImageRecipeBlockDeviceMappingEbsList

Initializers

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

new dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeBlockDeviceMappingEbsList(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
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string

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): DataAwsImagebuilderImageRecipeBlockDeviceMappingEbsOutputReference
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

DataAwsImagebuilderImageRecipeBlockDeviceMappingEbsOutputReference

Initializers

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

new dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeBlockDeviceMappingEbsOutputReference(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.
encrypted cdktf.IResolvable No description.
iops number No description.
kmsKeyId string No description.
snapshotId string No description.
volumeSize number No description.
volumeType string No description.
internalValue DataAwsImagebuilderImageRecipeBlockDeviceMappingEbs 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

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

iopsRequired
public readonly iops: number;
  • Type: number

kmsKeyIdRequired
public readonly kmsKeyId: string;
  • Type: string

snapshotIdRequired
public readonly snapshotId: string;
  • Type: string

volumeSizeRequired
public readonly volumeSize: number;
  • Type: number

volumeTypeRequired
public readonly volumeType: string;
  • Type: string

internalValueOptional
public readonly internalValue: DataAwsImagebuilderImageRecipeBlockDeviceMappingEbs;

DataAwsImagebuilderImageRecipeBlockDeviceMappingList

Initializers

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

new dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeBlockDeviceMappingList(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
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string

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): DataAwsImagebuilderImageRecipeBlockDeviceMappingOutputReference
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

DataAwsImagebuilderImageRecipeBlockDeviceMappingOutputReference

Initializers

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

new dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeBlockDeviceMappingOutputReference(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 DataAwsImagebuilderImageRecipeBlockDeviceMappingEbsList No description.
noDevice string No description.
virtualName string No description.
internalValue DataAwsImagebuilderImageRecipeBlockDeviceMapping 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: DataAwsImagebuilderImageRecipeBlockDeviceMappingEbsList;

noDeviceRequired
public readonly noDevice: string;
  • Type: string

virtualNameRequired
public readonly virtualName: string;
  • Type: string

internalValueOptional
public readonly internalValue: DataAwsImagebuilderImageRecipeBlockDeviceMapping;

DataAwsImagebuilderImageRecipeComponentList

Initializers

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

new dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeComponentList(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
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string

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): DataAwsImagebuilderImageRecipeComponentOutputReference
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

DataAwsImagebuilderImageRecipeComponentOutputReference

Initializers

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

new dataAwsImagebuilderImageRecipe.DataAwsImagebuilderImageRecipeComponentOutputReference(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.
componentArn string No description.
internalValue DataAwsImagebuilderImageRecipeComponent 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

componentArnRequired
public readonly componentArn: string;
  • Type: string

internalValueOptional
public readonly internalValue: DataAwsImagebuilderImageRecipeComponent;