`imagebuilderComponent` Submodule

Constructs

ImagebuilderComponent

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

Initializers

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

new imagebuilderComponent.ImagebuilderComponent(scope: Construct, id: string, config: ImagebuilderComponentConfig)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: ImagebuilderComponentConfig

Methods

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

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

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

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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

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

`id`^Required

Type: string

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

`moveTo`

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

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`resetChangeDescription`

public resetChangeDescription(): void

`resetData`

public resetData(): void

`resetDescription`

public resetDescription(): void

`resetId`

public resetId(): void

`resetKmsKeyId`

public resetKmsKeyId(): void

`resetSupportedOsVersions`

public resetSupportedOsVersions(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

`resetUri`

public resetUri(): void

Static Functions

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

`isConstruct`

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

imagebuilderComponent.ImagebuilderComponent.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

imagebuilderComponent.ImagebuilderComponent.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

imagebuilderComponent.ImagebuilderComponent.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

imagebuilderComponent.ImagebuilderComponent.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing ImagebuilderComponent that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`arn`	`string`	No description.
`dateCreated`	`string`	No description.
`encrypted`	`cdktf.IResolvable`	No description.
`owner`	`string`	No description.
`type`	`string`	No description.
`changeDescriptionInput`	`string`	No description.
`dataInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`idInput`	`string`	No description.
`kmsKeyIdInput`	`string`	No description.
`nameInput`	`string`	No description.
`platformInput`	`string`	No description.
`supportedOsVersionsInput`	`string[]`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`uriInput`	`string`	No description.
`versionInput`	`string`	No description.
`changeDescription`	`string`	No description.
`data`	`string`	No description.
`description`	`string`	No description.
`id`	`string`	No description.
`kmsKeyId`	`string`	No description.
`name`	`string`	No description.
`platform`	`string`	No description.
`supportedOsVersions`	`string[]`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: string}`	No description.
`uri`	`string`	No description.
`version`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

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

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

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

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

`arn`^Required

public readonly arn: string;

Type: string

`dateCreated`^Required

public readonly dateCreated: string;

Type: string

`encrypted`^Required

public readonly encrypted: IResolvable;

Type: cdktf.IResolvable

`owner`^Required

public readonly owner: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

`changeDescriptionInput`^Optional

public readonly changeDescriptionInput: string;

Type: string

`dataInput`^Optional

public readonly dataInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`kmsKeyIdInput`^Optional

public readonly kmsKeyIdInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`platformInput`^Optional

public readonly platformInput: string;

Type: string

`supportedOsVersionsInput`^Optional

public readonly supportedOsVersionsInput: string[];

Type: string[]

`tagsAllInput`^Optional

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

Type: {[ key: string ]: string}

`tagsInput`^Optional

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

Type: {[ key: string ]: string}

`uriInput`^Optional

public readonly uriInput: string;

Type: string

`versionInput`^Optional

public readonly versionInput: string;

Type: string

`changeDescription`^Required

public readonly changeDescription: string;

Type: string

`data`^Required

public readonly data: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`kmsKeyId`^Required

public readonly kmsKeyId: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`platform`^Required

public readonly platform: string;

Type: string

`supportedOsVersions`^Required

public readonly supportedOsVersions: string[];

Type: string[]

`tags`^Required

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

Type: {[ key: string ]: string}

`tagsAll`^Required

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

Type: {[ key: string ]: string}

`uri`^Required

public readonly uri: string;

Type: string

`version`^Required

public readonly version: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ImagebuilderComponentConfig

Initializer

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

const imagebuilderComponentConfig: imagebuilderComponent.ImagebuilderComponentConfig = { ... }

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/imagebuilder_component#name ImagebuilderComponent#name}.
`platform`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#platform ImagebuilderComponent#platform}.
`version`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#version ImagebuilderComponent#version}.
`changeDescription`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#change_description ImagebuilderComponent#change_description}.
`data`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#data ImagebuilderComponent#data}.
`description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#description ImagebuilderComponent#description}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#id ImagebuilderComponent#id}.
`kmsKeyId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#kms_key_id ImagebuilderComponent#kms_key_id}.
`supportedOsVersions`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#supported_os_versions ImagebuilderComponent#supported_os_versions}.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#tags ImagebuilderComponent#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#tags_all ImagebuilderComponent#tags_all}.
`uri`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#uri ImagebuilderComponent#uri}.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

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

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

`name`^Required

public readonly name: string;

Type: string

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

`platform`^Required

public readonly platform: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#platform ImagebuilderComponent#platform}.

`version`^Required

public readonly version: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#version ImagebuilderComponent#version}.

`changeDescription`^Optional

public readonly changeDescription: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#change_description ImagebuilderComponent#change_description}.

`data`^Optional

public readonly data: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#data ImagebuilderComponent#data}.

`description`^Optional

public readonly description: string;

Type: string

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

`id`^Optional

public readonly id: string;

Type: string

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

`kmsKeyId`^Optional

public readonly kmsKeyId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#kms_key_id ImagebuilderComponent#kms_key_id}.

`supportedOsVersions`^Optional

public readonly supportedOsVersions: string[];

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#supported_os_versions ImagebuilderComponent#supported_os_versions}.

`tags`^Optional

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

Type: {[ key: string ]: string}

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

`tagsAll`^Optional

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

Type: {[ key: string ]: string}

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

`uri`^Optional

public readonly uri: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/imagebuilder_component#uri ImagebuilderComponent#uri}.

Files

imagebuilderComponent.md

Latest commit

History

imagebuilderComponent.md

File metadata and controls

imagebuilderComponent Submodule

Constructs