Package software.amazon.awscdk.services.imagebuilder

Class CfnContainerRecipe.Builder

java.lang.Object
software.amazon.awscdk.services.imagebuilder.CfnContainerRecipe.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnContainerRecipe>
Enclosing class:
CfnContainerRecipe
@Stability(Stable) public static final class CfnContainerRecipe.Builder extends Object implements software.amazon.jsii.Builder<CfnContainerRecipe>
A fluent builder for CfnContainerRecipe.

  • Method Details

    • create

      @Stability(Stable) public static CfnContainerRecipe.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnContainerRecipe.Builder.

    • components

      @Stability(Stable) public CfnContainerRecipe.Builder components(IResolvable components)
      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.

      Parameters:
      components - Build and test components that are included in the container recipe. This parameter is required.
      Returns:
      this

    • components

      @Stability(Stable) public CfnContainerRecipe.Builder components(List<? extends Object> components)
      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.

      Parameters:
      components - Build and test components that are included in the container recipe. This parameter is required.
      Returns:
      this

    • containerType

      @Stability(Stable) public CfnContainerRecipe.Builder containerType(String containerType)
      Specifies the type of container, such as Docker.

      Parameters:
      containerType - Specifies the type of container, such as Docker. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnContainerRecipe.Builder name(String name)
      The name of the container recipe.

      Parameters:
      name - The name of the container recipe. This parameter is required.
      Returns:
      this

    • parentImage

      @Stability(Stable) public CfnContainerRecipe.Builder parentImage(String parentImage)
      The base image for the container recipe.

      Parameters:
      parentImage - The base image for the container recipe. This parameter is required.
      Returns:
      this

    • targetRepository

      @Stability(Stable) public CfnContainerRecipe.Builder targetRepository(IResolvable targetRepository)
      The destination repository for the container image.

      Parameters:
      targetRepository - The destination repository for the container image. This parameter is required.
      Returns:
      this

    • targetRepository

      @Stability(Stable) public CfnContainerRecipe.Builder targetRepository(CfnContainerRecipe.TargetContainerRepositoryProperty targetRepository)
      The destination repository for the container image.

      Parameters:
      targetRepository - The destination repository for the container image. This parameter is required.
      Returns:
      this

    • version

      @Stability(Stable) public CfnContainerRecipe.Builder version(String version)
      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.

      Parameters:
      version - The semantic version of the container recipe. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnContainerRecipe.Builder description(String description)
      The description of the container recipe.

      Parameters:
      description - The description of the container recipe. This parameter is required.
      Returns:
      this

    • dockerfileTemplateData

      @Stability(Stable) public CfnContainerRecipe.Builder dockerfileTemplateData(String dockerfileTemplateData)
      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.

      Parameters:
      dockerfileTemplateData - 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. This parameter is required.
      Returns:
      this

    • dockerfileTemplateUri

      @Stability(Stable) public CfnContainerRecipe.Builder dockerfileTemplateUri(String dockerfileTemplateUri)
      The S3 URI for the Dockerfile that will be used to build your container image.

      Parameters:
      dockerfileTemplateUri - The S3 URI for the Dockerfile that will be used to build your container image. This parameter is required.
      Returns:
      this

    • imageOsVersionOverride

      @Stability(Stable) public CfnContainerRecipe.Builder imageOsVersionOverride(String imageOsVersionOverride)
      Specifies the operating system version for the base image.

      Parameters:
      imageOsVersionOverride - Specifies the operating system version for the base image. This parameter is required.
      Returns:
      this

    • instanceConfiguration

      @Stability(Stable) public CfnContainerRecipe.Builder instanceConfiguration(IResolvable instanceConfiguration)
      A group of options that can be used to configure an instance for building and testing container images.

      Parameters:
      instanceConfiguration - A group of options that can be used to configure an instance for building and testing container images. This parameter is required.
      Returns:
      this

    • instanceConfiguration

      @Stability(Stable) public CfnContainerRecipe.Builder instanceConfiguration(CfnContainerRecipe.InstanceConfigurationProperty instanceConfiguration)
      A group of options that can be used to configure an instance for building and testing container images.

      Parameters:
      instanceConfiguration - A group of options that can be used to configure an instance for building and testing container images. This parameter is required.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnContainerRecipe.Builder kmsKeyId(String kmsKeyId)
      Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

      Parameters:
      kmsKeyId - Identifies which KMS key is used to encrypt the container image for distribution to the target Region. This parameter is required.
      Returns:
      this

    • platformOverride

      @Stability(Stable) public CfnContainerRecipe.Builder platformOverride(String platformOverride)
      Specifies the operating system platform when you use a custom base image.

      Parameters:
      platformOverride - Specifies the operating system platform when you use a custom base image. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnContainerRecipe.Builder tags(Map<String,String> tags)
      Tags that are attached to the container recipe.

      Parameters:
      tags - Tags that are attached to the container recipe. This parameter is required.
      Returns:
      this

    • workingDirectory

      @Stability(Stable) public CfnContainerRecipe.Builder workingDirectory(String workingDirectory)
      The working directory for use during build and test workflows.

      Parameters:
      workingDirectory - The working directory for use during build and test workflows. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnContainerRecipe build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnContainerRecipe>
      Returns:
      a newly built instance of CfnContainerRecipe.