CfnComponentProps Struct
Properties for defining a CfnComponent.
| Source |
|---|
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',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_imagebuilder as imagebuilder
cfn_component_props = imagebuilder.CfnComponentProps(
name="name",
platform="platform",
version="version",
# the properties below are optional
change_description="changeDescription",
data="data",
description="description",
kms_key_id="kmsKeyId",
supported_os_versions=["supportedOsVersions"],
tags={
"tags_key": "tags"
},
uri="uri"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.imagebuilder.*;
CfnComponentProps cfnComponentProps = CfnComponentProps.builder()
.name("name")
.platform("platform")
.version("version")
// the properties below are optional
.changeDescription("changeDescription")
.data("data")
.description("description")
.kmsKeyId("kmsKeyId")
.supportedOsVersions(List.of("supportedOsVersions"))
.tags(Map.of(
"tagsKey", "tags"))
.uri("uri")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder;
var cfnComponentProps = new CfnComponentProps {
Name = "name",
Platform = "platform",
Version = "version",
// the properties below are optional
ChangeDescription = "changeDescription",
Data = "data",
Description = "description",
KmsKeyId = "kmsKeyId",
SupportedOsVersions = new [] { "supportedOsVersions" },
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
Uri = "uri"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnComponentProps := &CfnComponentProps{
Name: jsii.String("name"),
Platform: jsii.String("platform"),
Version: jsii.String("version"),
// the properties below are optional
ChangeDescription: jsii.String("changeDescription"),
Data: jsii.String("data"),
Description: jsii.String("description"),
KmsKeyId: jsii.String("kmsKeyId"),
SupportedOsVersions: []*string{
jsii.String("supportedOsVersions"),
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
Uri: jsii.String("uri"),
}
Properties
changeDescriptionoptionalstringchange_descriptionoptionalstrchangeDescriptionoptionalStringChangeDescriptionoptionalstringChangeDescriptionoptional*string #Describes what change has been made in this version, or what makes this version different from other versions of the component.
Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string #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 .
supportedOsVersionsoptionalstring[]supported_os_versionsoptionaltyping.List[str]supportedOsVersionsoptionalList<String>SupportedOsVersionsoptionalstring[]SupportedOsVersionsoptional*[]*string #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 }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string #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.
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.