Package software.amazon.awscdk.services.imagebuilder

Interface CfnComponentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:11.556Z")
@Stability(Stable)
public interface CfnComponentProps
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComponentProps.Builder	A builder for CfnComponentProps
static final class	CfnComponentProps.Jsii$Proxy	An implementation for CfnComponentProps

Method Summary

Modifier and Type	Method	Description
static CfnComponentProps.Builder	builder()
default String	getChangeDescription()	The change description of the component.
default String	getData()	Component data contains inline YAML document content for the component.
default String	getDescription()	Describes the contents of the component.
default String	getKmsKeyId()	The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component.
String	getName()	The name of the component.
String	getPlatform()	The operating system platform of the component.
default List<String>	getSupportedOsVersions()	The operating system (OS) version supported by the component.
default Map<String,String>	getTags()	The tags that apply to the component.
default String	getUri()	The uri of a YAML component document file.
String	getVersion()	The semantic version of the component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-name

getPlatform

@Stability(Stable)
@NotNull
String getPlatform()

The operating system platform of the component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-platform

getVersion

@Stability(Stable)
@NotNull
String getVersion()

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

The semantic version has four nodes: ../. 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-version

getChangeDescription

@Stability(Stable)
@Nullable
default String getChangeDescription()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-changedescription

getData

@Stability(Stable)
@Nullable
default String getData()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-data

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Describes the contents of the component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-description

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-kmskeyid

getSupportedOsVersions

@Stability(Stable)
@Nullable
default List<String> getSupportedOsVersions()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-supportedosversions

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The tags that apply to the component.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-tags

getUri

@Stability(Stable)
@Nullable
default String getUri()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-component.html#cfn-imagebuilder-component-uri

builder

@Stability(Stable)
static CfnComponentProps.Builder builder()

Returns:

a CfnComponentProps.Builder of CfnComponentProps