aws-cdk-lib.aws_imagebuilder.CfnComponentProps

CfnComponentProps Struct

Properties for defining a CfnComponent.

CfnComponentProps

used as props by

• CfnComponent

Source

Generated code

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const cfnComponentProps: imagebuilder.CfnComponentProps = {
  name: 'name',
  platform: 'platform',
  version: 'version',

  // the properties below are optional
  changeDescription: 'changeDescription',
  data: 'data',
  description: 'description',
  kmsKeyId: 'kmsKeyId',
  supportedOsVersions: ['supportedOsVersions'],
  tags: {
    tagsKey: 'tags',
  },
  uri: 'uri',
};

Properties

changeDescription?optionalstringchange_description?optionalstrchangeDescription?optionalStringChangeDescription?optionalstringChangeDescription?optional*string#

The 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.

data?optionalstringdata?optionalstrdata?optionalStringData?optionalstringData?optional*string#

Component `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.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

Describes the contents of the component.

kmsKeyId?optionalstringkms_key_id?optionalstrkmsKeyId?optionalStringKmsKeyId?optionalstringKmsKeyId?optional*string#

The 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) in the AWS Key Management Service Developer Guide .

namestringnamestrnameStringNamestringName*stringrequired#

The name of the component.

platformstringplatformstrplatformStringPlatformstringPlatform*stringrequired#

The operating system platform of the component.

supportedOsVersions?optionalstring[]supported_os_versions?optionaltyping.List[str]supportedOsVersions?optionalList<String>SupportedOsVersions?optionalstring[]SupportedOsVersions?optional*[]*string#

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.

tags?optional{ [key: string]: string }tags?optionaltyping.Mapping[str, str]tags?optionalMap<String, String>Tags?optionalIDictionary<string, string>Tags?optional*map[string]*string#

The tags that apply to the component.

uri?optionalstringuri?optionalstruri?optionalStringUri?optionalstringUri?optional*string#

The `uri` of a YAML component document file.

notes

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.

versionstringversionstrversionStringVersionstringVersion*stringrequired#

The semantic version of the component. This version follows the semantic version syntax.

notes

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.