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
changeDescriptionoptionalstringchange_descriptionoptionalstrchangeDescriptionoptionalStringChangeDescriptionoptionalstringChangeDescriptionoptional*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.
componentNameoptionalstringcomponent_nameoptionalstrcomponentNameoptionalStringComponentNameoptionalstringComponentNameoptional*string#The name of the component.
Default: a name is generated
componentVersionoptionalstringcomponent_versionoptionalstrcomponentVersionoptionalStringComponentVersionoptionalstringComponentVersionoptional*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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#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.
supportedOsVersionsoptionalOSVersion[]supported_os_versionsoptionaltyping.List[OSVersion]supportedOsVersionsoptionalList<OSVersion>SupportedOsVersionsoptionalOSVersion[]SupportedOsVersionsoptional*[]OSVersion= None#The operating system versions supported by the component.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string= None#The tags to apply to the component.