`imagebuilderComponent` Submodule

Constructs

ImagebuilderComponent

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

Initializers

from cdktn_provider_aws import imagebuilder_component

imagebuilderComponent.ImagebuilderComponent(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  platform: str,
  version: str,
  change_description: str = None,
  data: str = None,
  description: str = None,
  id: str = None,
  kms_key_id: str = None,
  region: str = None,
  skip_destroy: bool | IResolvable = None,
  supported_os_versions: typing.List[str] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  uri: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#name ImagebuilderComponent#name}.
`platform`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#platform ImagebuilderComponent#platform}.
`version`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#version ImagebuilderComponent#version}.
`change_description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#change_description ImagebuilderComponent#change_description}.
`data`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#data ImagebuilderComponent#data}.
`description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#description ImagebuilderComponent#description}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#id ImagebuilderComponent#id}.
`kms_key_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#kms_key_id ImagebuilderComponent#kms_key_id}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`skip_destroy`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#skip_destroy ImagebuilderComponent#skip_destroy}.
`supported_os_versions`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#supported_os_versions ImagebuilderComponent#supported_os_versions}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#tags ImagebuilderComponent#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#tags_all ImagebuilderComponent#tags_all}.
`uri`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#uri ImagebuilderComponent#uri}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`name`^Required

Type: str

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

`platform`^Required

Type: str

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

`version`^Required

Type: str

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

`change_description`^Optional

Type: str

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

`data`^Optional

Type: str

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

`description`^Optional

Type: str

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

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/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.

`kms_key_id`^Optional

Type: str

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

`region`^Optional

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`skip_destroy`^Optional

Type: bool | cdktn.IResolvable

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

`supported_os_versions`^Optional

Type: typing.List[str]

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

`tags`^Optional

Type: typing.Mapping[str]

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

`tags_all`^Optional

Type: typing.Mapping[str]

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

`uri`^Optional

Type: str

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`reset_change_description`	No description.
`reset_data`	No description.
`reset_description`	No description.
`reset_id`	No description.
`reset_kms_key_id`	No description.
`reset_region`	No description.
`reset_skip_destroy`	No description.
`reset_supported_os_versions`	No description.
`reset_tags`	No description.
`reset_tags_all`	No description.
`reset_uri`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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: str

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`reset_change_description`

def reset_change_description() -> None

`reset_data`

def reset_data() -> None

`reset_description`

def reset_description() -> None

`reset_id`

def reset_id() -> None

`reset_kms_key_id`

def reset_kms_key_id() -> None

`reset_region`

def reset_region() -> None

`reset_skip_destroy`

def reset_skip_destroy() -> None

`reset_supported_os_versions`

def reset_supported_os_versions() -> None

`reset_tags`

def reset_tags() -> None

`reset_tags_all`

def reset_tags_all() -> None

`reset_uri`

def reset_uri() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a ImagebuilderComponent resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import imagebuilder_component

imagebuilderComponent.ImagebuilderComponent.is_construct(
  x: typing.Any
)

Checks if x is a construct.

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

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

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_aws import imagebuilder_component

imagebuilderComponent.ImagebuilderComponent.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import imagebuilder_component

imagebuilderComponent.ImagebuilderComponent.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import imagebuilder_component

imagebuilderComponent.ImagebuilderComponent.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a ImagebuilderComponent resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing ImagebuilderComponent that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`arn`	`str`	No description.
`date_created`	`str`	No description.
`encrypted`	`cdktn.IResolvable`	No description.
`owner`	`str`	No description.
`type`	`str`	No description.
`change_description_input`	`str`	No description.
`data_input`	`str`	No description.
`description_input`	`str`	No description.
`id_input`	`str`	No description.
`kms_key_id_input`	`str`	No description.
`name_input`	`str`	No description.
`platform_input`	`str`	No description.
`region_input`	`str`	No description.
`skip_destroy_input`	`bool \| cdktn.IResolvable`	No description.
`supported_os_versions_input`	`typing.List[str]`	No description.
`tags_all_input`	`typing.Mapping[str]`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`uri_input`	`str`	No description.
`version_input`	`str`	No description.
`change_description`	`str`	No description.
`data`	`str`	No description.
`description`	`str`	No description.
`id`	`str`	No description.
`kms_key_id`	`str`	No description.
`name`	`str`	No description.
`platform`	`str`	No description.
`region`	`str`	No description.
`skip_destroy`	`bool \| cdktn.IResolvable`	No description.
`supported_os_versions`	`typing.List[str]`	No description.
`tags`	`typing.Mapping[str]`	No description.
`tags_all`	`typing.Mapping[str]`	No description.
`uri`	`str`	No description.
`version`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`arn`^Required

arn: str

Type: str

`date_created`^Required

date_created: str

Type: str

`encrypted`^Required

encrypted: IResolvable

Type: cdktn.IResolvable

`owner`^Required

owner: str

Type: str

`type`^Required

type: str

Type: str

`change_description_input`^Optional

change_description_input: str

Type: str

`data_input`^Optional

data_input: str

Type: str

`description_input`^Optional

description_input: str

Type: str

`id_input`^Optional

id_input: str

Type: str

`kms_key_id_input`^Optional

kms_key_id_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`platform_input`^Optional

platform_input: str

Type: str

`region_input`^Optional

region_input: str

Type: str

`skip_destroy_input`^Optional

skip_destroy_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`supported_os_versions_input`^Optional

supported_os_versions_input: typing.List[str]

Type: typing.List[str]

`tags_all_input`^Optional

tags_all_input: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`uri_input`^Optional

uri_input: str

Type: str

`version_input`^Optional

version_input: str

Type: str

`change_description`^Required

change_description: str

Type: str

`data`^Required

data: str

Type: str

`description`^Required

description: str

Type: str

`id`^Required

id: str

Type: str

`kms_key_id`^Required

kms_key_id: str

Type: str

`name`^Required

name: str

Type: str

`platform`^Required

platform: str

Type: str

`region`^Required

region: str

Type: str

`skip_destroy`^Required

skip_destroy: bool | IResolvable

Type: bool | cdktn.IResolvable

`supported_os_versions`^Required

supported_os_versions: typing.List[str]

Type: typing.List[str]

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_all`^Required

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

`uri`^Required

uri: str

Type: str

`version`^Required

version: str

Type: str

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

ImagebuilderComponentConfig

Initializer

from cdktn_provider_aws import imagebuilder_component

imagebuilderComponent.ImagebuilderComponentConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  name: str,
  platform: str,
  version: str,
  change_description: str = None,
  data: str = None,
  description: str = None,
  id: str = None,
  kms_key_id: str = None,
  region: str = None,
  skip_destroy: bool | IResolvable = None,
  supported_os_versions: typing.List[str] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None,
  uri: str = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#name ImagebuilderComponent#name}.
`platform`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#platform ImagebuilderComponent#platform}.
`version`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#version ImagebuilderComponent#version}.
`change_description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#change_description ImagebuilderComponent#change_description}.
`data`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#data ImagebuilderComponent#data}.
`description`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#description ImagebuilderComponent#description}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#id ImagebuilderComponent#id}.
`kms_key_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#kms_key_id ImagebuilderComponent#kms_key_id}.
`region`	`str`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`skip_destroy`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#skip_destroy ImagebuilderComponent#skip_destroy}.
`supported_os_versions`	`typing.List[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#supported_os_versions ImagebuilderComponent#supported_os_versions}.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#tags ImagebuilderComponent#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#tags_all ImagebuilderComponent#tags_all}.
`uri`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/imagebuilder_component#uri ImagebuilderComponent#uri}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`name`^Required

name: str

Type: str

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

`platform`^Required

platform: str

Type: str

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

`version`^Required

version: str

Type: str

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

`change_description`^Optional

change_description: str

Type: str

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

`data`^Optional

data: str

Type: str

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

`description`^Optional

description: str

Type: str

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

`id`^Optional

id: str

Type: str

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

`kms_key_id`^Optional

kms_key_id: str

Type: str

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

`region`^Optional

region: str

Type: str

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

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

`skip_destroy`^Optional

skip_destroy: bool | IResolvable

Type: bool | cdktn.IResolvable

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

`supported_os_versions`^Optional

supported_os_versions: typing.List[str]

Type: typing.List[str]

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

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

`tags_all`^Optional

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

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

`uri`^Optional

uri: str

Type: str

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

FilesExpand file tree

imagebuilderComponent.python.md

Latest commit

History

imagebuilderComponent.python.md

File metadata and controls

imagebuilderComponent Submodule

Constructs