Package software.amazon.awscdk.services.imagebuilder

Class CfnImageRecipe.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnImageRecipe.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 CfnImageRecipe.Builder.

    • components

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

      Parameters:
      components - The components of the image recipe. This parameter is required.
      Returns:
      this

    • components

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

      Parameters:
      components - The components of the image recipe. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnImageRecipe.Builder name(String name)
      The name of the image recipe.

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

    • parentImage

      @Stability(Stable) public CfnImageRecipe.Builder parentImage(String parentImage)
      The parent image of the image recipe.

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

      Parameters:
      parentImage - The parent image of the image recipe. This parameter is required.
      Returns:
      this

    • version

      @Stability(Stable) public CfnImageRecipe.Builder version(String version)
      The semantic version of the image recipe.

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

    • additionalInstanceConfiguration

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

      Parameters:
      additionalInstanceConfiguration - Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. This parameter is required.
      Returns:
      this

    • additionalInstanceConfiguration

      @Stability(Stable) public CfnImageRecipe.Builder additionalInstanceConfiguration(CfnImageRecipe.AdditionalInstanceConfigurationProperty additionalInstanceConfiguration)
      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.

      Parameters:
      additionalInstanceConfiguration - Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. This parameter is required.
      Returns:
      this

    • blockDeviceMappings

      @Stability(Stable) public CfnImageRecipe.Builder blockDeviceMappings(IResolvable blockDeviceMappings)
      The block device mappings to apply when creating images from this recipe.

      Parameters:
      blockDeviceMappings - The block device mappings to apply when creating images from this recipe. This parameter is required.
      Returns:
      this

    • blockDeviceMappings

      @Stability(Stable) public CfnImageRecipe.Builder blockDeviceMappings(List<? extends Object> blockDeviceMappings)
      The block device mappings to apply when creating images from this recipe.

      Parameters:
      blockDeviceMappings - The block device mappings to apply when creating images from this recipe. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnImageRecipe.Builder description(String description)
      The description of the image recipe.

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

    • tags

      @Stability(Stable) public CfnImageRecipe.Builder tags(Map<String,String> tags)
      The tags of the image recipe.

      Parameters:
      tags - The tags of the image recipe. This parameter is required.
      Returns:
      this

    • workingDirectory

      @Stability(Stable) public CfnImageRecipe.Builder workingDirectory(String workingDirectory)
      The working directory to be used during build and test workflows.

      Parameters:
      workingDirectory - The working directory to be used during build and test workflows. This parameter is required.
      Returns:
      this

    • build

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