CfnContainerRecipeProps

All Known Implementing Classes:: CfnContainerRecipeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:46.950Z")
public interface CfnContainerRecipeProps

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();

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnContainerRecipeProps.Builder`	`builder()`
`java.lang.Object`	`getComponents()` Build and test components that are included in the container recipe.
`java.lang.String`	`getContainerType()` Specifies the type of container, such as Docker.
`default java.lang.String`	`getDescription()` The description of the container recipe.
`default java.lang.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 java.lang.String`	`getDockerfileTemplateUri()` The S3 URI for the Dockerfile that will be used to build your container image.
`default java.lang.String`	`getImageOsVersionOverride()` Specifies the operating system version for the base image.
`default java.lang.Object`	`getInstanceConfiguration()` A group of options that can be used to configure an instance for building and testing container images.
`default java.lang.String`	`getKmsKeyId()` Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
`java.lang.String`	`getName()` The name of the container recipe.
`java.lang.String`	`getParentImage()` The base image for the container recipe.
`default java.lang.String`	`getPlatformOverride()` Specifies the operating system platform when you use a custom base image.
`default java.util.Map<java.lang.String,java.lang.String>`	`getTags()` Tags that are attached to the container recipe.
`java.lang.Object`	`getTargetRepository()` The destination repository for the container image.
`java.lang.String`	`getVersion()` The semantic version of the container recipe.
`default java.lang.String`	`getWorkingDirectory()` The working directory for use during build and test workflows.

- Method Detail
  - getComponents
```
java.lang.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.
  - getContainerType
```
java.lang.String getContainerType()
```
    Specifies the type of container, such as Docker.
  - getName
```
java.lang.String getName()
```
    The name of the container recipe.
  - getParentImage
```
java.lang.String getParentImage()
```
    The base image for the container recipe.
  - getTargetRepository
```
java.lang.Object getTargetRepository()
```
    The destination repository for the container image.
  - getVersion
```
java.lang.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.
  - getDescription
```
default java.lang.String getDescription()
```
    The description of the container recipe.
  - getDockerfileTemplateData
```
default java.lang.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.
  - getDockerfileTemplateUri
```
default java.lang.String getDockerfileTemplateUri()
```
    The S3 URI for the Dockerfile that will be used to build your container image.
  - getImageOsVersionOverride
```
default java.lang.String getImageOsVersionOverride()
```
    Specifies the operating system version for the base image.
  - getInstanceConfiguration
```
default java.lang.Object getInstanceConfiguration()
```
    A group of options that can be used to configure an instance for building and testing container images.
  - getKmsKeyId
```
default java.lang.String getKmsKeyId()
```
    Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
  - getPlatformOverride
```
default java.lang.String getPlatformOverride()
```
    Specifies the operating system platform when you use a custom base image.
  - getTags
```
default java.util.Map<java.lang.String,java.lang.String> getTags()
```
    Tags that are attached to the container recipe.
  - getWorkingDirectory
```
default java.lang.String getWorkingDirectory()
```
    The working directory for use during build and test workflows.
  - builder
```
static CfnContainerRecipeProps.Builder builder()
```
    Returns:
    
    a CfnContainerRecipeProps.Builder of CfnContainerRecipeProps

Interface CfnContainerRecipeProps

Nested Class Summary

Method Summary

Method Detail

getComponents

getContainerType

getName

getParentImage

getTargetRepository

getVersion

getDescription

getDockerfileTemplateData

getDockerfileTemplateUri

getImageOsVersionOverride

getInstanceConfiguration

getKmsKeyId

getPlatformOverride

getTags

getWorkingDirectory

builder