software.amazon.awscdk.services.imagebuilder

Interface CfnComponentProps

All Known Implementing Classes:

CfnComponentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-27T16:27:55.472Z")
public interface 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 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 java.lang.String	getChangeDescription() The change description of the component.
default java.lang.String	getData() Component `data` contains inline YAML document content for the component.
default java.lang.String	getDescription() The description of the component.
default java.lang.String	getKmsKeyId() The ID of the KMS key that should be used to encrypt this component.
java.lang.String	getName() The name of the component.
java.lang.String	getPlatform() The platform of the component.
default java.util.List<java.lang.String>	getSupportedOsVersions() The operating system (OS) version supported by the component.
default java.util.Map<java.lang.String,java.lang.String>	getTags() The tags of the component.
default java.lang.String	getUri() The `uri` of a YAML component document file.
java.lang.String	getVersion() The component version.

Method Detail

getName

java.lang.String getName()

The name of the component.

getPlatform

java.lang.String getPlatform()

The platform of the component.

getVersion

java.lang.String getVersion()

The component version.

For example, 1.0.0 .

getChangeDescription

default java.lang.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

default java.lang.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

default java.lang.String getDescription()

The description of the component.

Describes the contents of the component.

getKmsKeyId

default java.lang.String getKmsKeyId()

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

getSupportedOsVersions

default java.util.List<java.lang.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

default java.util.Map<java.lang.String,java.lang.String> getTags()

The tags of the component.

getUri

default java.lang.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

static CfnComponentProps.Builder builder()

Returns:

a CfnComponentProps.Builder of CfnComponentProps