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.57.0 (build f614666)",
           date="2022-04-22T22:36:22.864Z")
 @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() A change description of the component.
default String	getData() The data of the component.
default String	getDescription() The description of the component.
default String	getKmsKeyId() The KMS key identifier used to encrypt the 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 associated with 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.

For example, Windows .

getVersion

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

The component version.

For example, 1.0.0 .

getChangeDescription

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

A change description of the component.

For example initial version .

getData

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

The data of the component.

For example, name: HelloWorldTestingDocument\ndescription: This is hello world testing document.\nschemaVersion: 1.0\n\nphases:\n - name: test\n steps:\n - name: HelloWorldStep\n action: ExecuteBash\n inputs:\n commands:\n - echo \"Hello World! Test.\"\n . See Examples below for the schema for creating a component using Data.

getDescription

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

The description of the component.

getKmsKeyId

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

The KMS key identifier used to encrypt the 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 associated with 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