AWS::ImageBuilder::ComponentCfnComponent
Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods: - Inline, using the `data` property in the request body. - A URL that points to a YAML document file stored in Amazon S3, using the `uri` property in the request body.
Import
import { CfnComponent } from 'aws-cdk-lib/aws-imagebuilder';Or use the module namespace:
import * as imagebuilder from 'aws-cdk-lib/aws-imagebuilder';
// imagebuilder.CfnComponentProperties
Configuration passed to the constructor as CfnComponentProps.
nameRequiredstringThe name of the component.
platformRequiredstringThe operating system platform of the component.
versionRequiredstringThe semantic version of the component. This version follows the semantic version syntax. > The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. > > *Assignment:* For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. > > *Patterns:* You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
changeDescriptionOptionalstringThe change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.
dataOptionalstringComponent `data` contains inline YAML document content for the component. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
descriptionOptionalstringDescribes the contents of the component.
kmsKeyIdOptionalstringThe Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN) in the *AWS Key Management Service Developer Guide* .
supportedOsVersionsOptionalstring[]The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
tagsOptional{ [key: string]: string }The tags that apply to the component.
uriOptionalstringThe `uri` of a YAML component document file. This must be an S3 URL ( `s3://bucket/key` ), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota. Alternatively, you can specify the YAML document inline, using the component `data` property. You cannot specify both properties.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-imagebuilderAWS::ImageBuilder::Component