software.amazon.awscdk.services.imagebuilder

Interface CfnImageRecipeProps

All Known Implementing Classes:

CfnImageRecipeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.732Z")
public interface CfnImageRecipeProps

Properties for defining a `CfnImageRecipe`.

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.*;
 CfnImageRecipeProps cfnImageRecipeProps = CfnImageRecipeProps.builder()
         .components(List.of(ComponentConfigurationProperty.builder()
                 .componentArn("componentArn")
                 .parameters(List.of(ComponentParameterProperty.builder()
                         .name("name")
                         .value(List.of("value"))
                         .build()))
                 .build()))
         .name("name")
         .parentImage("parentImage")
         .version("version")
         // the properties below are optional
         .additionalInstanceConfiguration(AdditionalInstanceConfigurationProperty.builder()
                 .systemsManagerAgent(SystemsManagerAgentProperty.builder()
                         .uninstallAfterBuild(false)
                         .build())
                 .userDataOverride("userDataOverride")
                 .build())
         .blockDeviceMappings(List.of(InstanceBlockDeviceMappingProperty.builder()
                 .deviceName("deviceName")
                 .ebs(EbsInstanceBlockDeviceSpecificationProperty.builder()
                         .deleteOnTermination(false)
                         .encrypted(false)
                         .iops(123)
                         .kmsKeyId("kmsKeyId")
                         .snapshotId("snapshotId")
                         .throughput(123)
                         .volumeSize(123)
                         .volumeType("volumeType")
                         .build())
                 .noDevice("noDevice")
                 .virtualName("virtualName")
                 .build()))
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .workingDirectory("workingDirectory")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnImageRecipeProps.Builder	builder()
default java.lang.Object	getAdditionalInstanceConfiguration() Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
default java.lang.Object	getBlockDeviceMappings() The block device mappings to apply when creating images from this recipe.
java.lang.Object	getComponents() The components of the image recipe.
default java.lang.String	getDescription() The description of the image recipe.
java.lang.String	getName() The name of the image recipe.
java.lang.String	getParentImage() The parent image of the image recipe.
default java.util.Map<java.lang.String,java.lang.String>	getTags() The tags of the image recipe.
java.lang.String	getVersion() The semantic version of the image recipe.
default java.lang.String	getWorkingDirectory() The working directory to be used during build and test workflows.

Method Detail

getComponents

java.lang.Object getComponents()

The components of the image recipe.

Components are orchestration documents that define a sequence of steps for downloading, installing, configuring, and testing software packages. They also define validation and security hardening steps. A component is defined using a YAML document format.

getName

java.lang.String getName()

The name of the image recipe.

getParentImage

java.lang.String getParentImage()

The parent image of the image recipe.

The string must be either an Image ARN or an AMI ID.

getVersion

java.lang.String getVersion()

The semantic version of the image recipe.

getAdditionalInstanceConfiguration

default java.lang.Object getAdditionalInstanceConfiguration()

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.

Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

getBlockDeviceMappings

default java.lang.Object getBlockDeviceMappings()

The block device mappings to apply when creating images from this recipe.

getDescription

default java.lang.String getDescription()

The description of the image recipe.

getTags

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

The tags of the image recipe.

getWorkingDirectory

default java.lang.String getWorkingDirectory()

The working directory to be used during build and test workflows.

builder

static CfnImageRecipeProps.Builder builder()

Returns:

a CfnImageRecipeProps.Builder of CfnImageRecipeProps