Package software.amazon.awscdk.services.imagebuilder

Interface CfnContainerRecipeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainerRecipeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:00.541Z")
@Stability(Stable)
public interface CfnContainerRecipeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnContainerRecipe.

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.*;
 CfnContainerRecipeProps cfnContainerRecipeProps = CfnContainerRecipeProps.builder()
         .components(List.of(ComponentConfigurationProperty.builder()
                 .componentArn("componentArn")
                 .parameters(List.of(ComponentParameterProperty.builder()
                         .name("name")
                         .value(List.of("value"))
                         .build()))
                 .build()))
         .containerType("containerType")
         .name("name")
         .parentImage("parentImage")
         .targetRepository(TargetContainerRepositoryProperty.builder()
                 .repositoryName("repositoryName")
                 .service("service")
                 .build())
         .version("version")
         // the properties below are optional
         .description("description")
         .dockerfileTemplateData("dockerfileTemplateData")
         .dockerfileTemplateUri("dockerfileTemplateUri")
         .imageOsVersionOverride("imageOsVersionOverride")
         .instanceConfiguration(InstanceConfigurationProperty.builder()
                 .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()))
                 .image("image")
                 .build())
         .kmsKeyId("kmsKeyId")
         .platformOverride("platformOverride")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .workingDirectory("workingDirectory")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainerRecipeProps.Builder	builder()
Object	getComponents()	Build and test components that are included in the container recipe.
String	getContainerType()	Specifies the type of container, such as Docker.
default String	getDescription()	The description of the container recipe.
default String	getDockerfileTemplateData()	Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
default String	getDockerfileTemplateUri()	The S3 URI for the Dockerfile that will be used to build your container image.
default String	getImageOsVersionOverride()	Specifies the operating system version for the base image.
default Object	getInstanceConfiguration()	A group of options that can be used to configure an instance for building and testing container images.
default String	getKmsKeyId()	Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
String	getName()	The name of the container recipe.
String	getParentImage()	The base image for the container recipe.
default String	getPlatformOverride()	Specifies the operating system platform when you use a custom base image.
default Map<String,String>	getTags()	Tags that are attached to the container recipe.
Object	getTargetRepository()	The destination repository for the container image.
String	getVersion()	The semantic version of the container recipe.
default String	getWorkingDirectory()	The working directory for use during build and test workflows.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponents

@Stability(Stable)
@NotNull
Object getComponents()

Build and test components that are included in the container recipe.

Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

See Also:

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

getContainerType

@Stability(Stable)
@NotNull
String getContainerType()

Specifies the type of container, such as Docker.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the container recipe.

See Also:

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

getParentImage

@Stability(Stable)
@NotNull
String getParentImage()

The base image for the container recipe.

See Also:

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

getTargetRepository

@Stability(Stable)
@NotNull
Object getTargetRepository()

The destination repository for the container image.

See Also:

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

getVersion

@Stability(Stable)
@NotNull
String getVersion()

The semantic version of the container recipe.

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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

See Also:

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

getDescription

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

The description of the container recipe.

See Also:

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

getDockerfileTemplateData

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

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.

The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

See Also:

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

getDockerfileTemplateUri

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

The S3 URI for the Dockerfile that will be used to build your container image.

See Also:

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

getImageOsVersionOverride

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

Specifies the operating system version for the base image.

See Also:

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

getInstanceConfiguration

@Stability(Stable)
@Nullable
default Object getInstanceConfiguration()

A group of options that can be used to configure an instance for building and testing container images.

See Also:

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

getKmsKeyId

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

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

See Also:

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

getPlatformOverride

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

Specifies the operating system platform when you use a custom base image.

See Also:

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

getTags

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

Tags that are attached to the container recipe.

See Also:

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

getWorkingDirectory

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

The working directory for use during build and test workflows.

See Also:

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

builder

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

Returns:

a CfnContainerRecipeProps.Builder of CfnContainerRecipeProps