interface ComponentProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.ComponentProps
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#ComponentProps
Java	software.amazon.awscdk.services.imagebuilder.alpha.ComponentProps
Python	aws_cdk.aws_imagebuilder_alpha.ComponentProps
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » ComponentProps

Properties for creating a Component resource.

Example

const component = new imagebuilder.Component(this, 'EncryptedComponent', {
  platform: imagebuilder.Platform.LINUX,
  kmsKey: new kms.Key(this, 'ComponentKey'),
  data: imagebuilder.ComponentData.fromJsonObject({
    schemaVersion: imagebuilder.ComponentSchemaVersion.V1_0,
    phases: [
      {
        name: imagebuilder.ComponentPhaseName.BUILD,
        steps: [
          {
            name: 'secure-setup',
            action: imagebuilder.ComponentAction.EXECUTE_BASH,
            inputs: {
              commands: ['echo "This component data is encrypted with KMS"']
            }
          }
        ]
      }
    ]
  })
});

Properties

Name	Type	Description
data🔹	ComponentData	The component document content that defines the build, validation, or test steps to be executed during the image building process.
platform🔹	Platform	The operating system platform of the component.
changeDescription?🔹	string	The change description of the component.
componentName?🔹	string	The name of the component.
componentVersion?🔹	string	The version of the component.
description?🔹	string	The description of the component.
kmsKey?🔹	IKey	The KMS key used to encrypt this component.
supportedOsVersions?🔹	OSVersion[]	The operating system versions supported by the component.
tags?🔹	{ [string]: string }	The tags to apply to the component.

---

data🔹

Type: ComponentData

The component document content that defines the build, validation, or test steps to be executed during the image building process.

---

platform🔹

Type: Platform

The operating system platform of the component.

---

changeDescription?🔹

Type: string (optional, default: None)

The change description of the component.

Describes what change has been made in this version of the component, or what makes this version different from other versions.

---

componentName?🔹

Type: string (optional, default: a name is generated)

The name of the component.

---

componentVersion?🔹

Type: string (optional, default: 1.0.0)

The version of the component.

---

description?🔹

Type: string (optional, default: None)

The description of the component.

---

kmsKey?🔹

Type: IKey (optional, default: an Image Builder owned key will be used to encrypt the component.)

The KMS key used to encrypt this component.

---

supportedOsVersions?🔹

Type: OSVersion[] (optional, default: None)

The operating system versions supported by the component.

---

tags?🔹

Type: { [string]: string } (optional, default: None)

The tags to apply to the component.