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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.808Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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() The description of the component.
default String	getKmsKeyId() The ID of the KMS key that should be used to encrypt this component.
String	getName() The name of the component.
String	getPlatform() The platform of the component.
default List<String>	getSupportedOsVersions() The operating system (OS) version supported by the component.
default Map<String,String>	getTags() The tags of the component.
default String	getUri() The `uri` of a YAML component document file.
String	getVersion() The component version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the component.

getPlatform

@Stability(value=Stable)
 @NotNull
String getPlatform()

The platform of the component.

getVersion

@Stability(value=Stable)
 @NotNull
String getVersion()

The component version.

For example, 1.0.0 .

getChangeDescription

@Stability(value=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 this component.

getData

@Stability(value=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.

getDescription

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

The description of the component.

Describes the contents of the component.

getKmsKeyId

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

The ID of the KMS key that should be used to encrypt this component.

getSupportedOsVersions

@Stability(value=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.

getTags

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

The tags of the component.

getUri

@Stability(value=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.

builder

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

Returns:

a CfnComponentProps.Builder of CfnComponentProps