Experimental
@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ComponentProps Struct
Properties for creating a Component resource.
Example
ts
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
changeDescriptionstringchange_descriptionstrchangeDescriptionStringChangeDescriptionstringChangeDescription*string= 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.
The name of the component.
Default: a name is generated
componentVersionstringcomponent_versionstrcomponentVersionStringComponentVersionstringComponentVersion*string= 1.0.0#The version of the component.
The component document content that defines the build, validation, or test steps to be executed during the image building process.
The description of the component.
The KMS key used to encrypt this component.
Default: an Image Builder owned key will be used to encrypt the component.
The operating system platform of the component.
supportedOsVersionsOSVersion[]supported_os_versionstyping.List[OSVersion]supportedOsVersionsList<OSVersion>SupportedOsVersionsOSVersion[]SupportedOsVersions*[]OSVersion= None#The operating system versions supported by the component.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= None#The tags to apply to the component.