interface CfnComponentProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ImageBuilder.CfnComponentProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnComponentProps |
![]() | software.amazon.awscdk.services.imagebuilder.CfnComponentProps |
![]() | aws_cdk.aws_imagebuilder.CfnComponentProps |
![]() | aws-cdk-lib » aws_imagebuilder » CfnComponentProps |
Properties for defining a CfnComponent
.
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
Name | Type | Description |
---|---|---|
name | string | The name of the component. |
platform | string | The operating system platform of the component. |
version | string | The component version. |
change | string | The change description of the component. |
data? | string | Component data contains inline YAML document content for the component. |
description? | string | Describes the contents of the component. |
kms | string | The ID of the KMS key that is used to encrypt this component. |
supported | string[] | The operating system (OS) version supported by the component. |
tags? | { [string]: string } | The tags that apply to the component. |
uri? | string | The uri of a YAML component document file. |
name
Type:
string
The name of the component.
platform
Type:
string
The operating system platform of the component.
version
Type:
string
The component version.
For example, 1.0.0
.
changeDescription?
Type:
string
(optional)
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?
Type:
string
(optional)
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?
Type:
string
(optional)
Describes the contents of the component.
kmsKeyId?
Type:
string
(optional)
The ID of the KMS key that is used to encrypt this component.
supportedOsVersions?
Type:
string[]
(optional)
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?
Type:
{ [string]: string }
(optional)
The tags that apply to the component.
uri?
Type:
string
(optional)
The 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.