Interface CreateContainerRecipeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateContainerRecipeRequest.Builder,CreateContainerRecipeRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateContainerRecipeRequest.Builder,CreateContainerRecipeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateContainerRecipeRequest

public static interface CreateContainerRecipeRequest.Builder extends ImagebuilderRequest.Builder, SdkPojo, CopyableBuilder<CreateContainerRecipeRequest.Builder,CreateContainerRecipeRequest>
  • Method Details

    • containerType

      CreateContainerRecipeRequest.Builder containerType(String containerType)

      The type of container to create.

      Parameters:
      containerType - The type of container to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • containerType

      The type of container to create.

      Parameters:
      containerType - The type of container to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • name

      The name of the container recipe.

      Parameters:
      name - The name of the container recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      CreateContainerRecipeRequest.Builder description(String description)

      The description of the container recipe.

      Parameters:
      description - The description of the container recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • semanticVersion

      CreateContainerRecipeRequest.Builder semanticVersion(String semanticVersion)

      The semantic version of the container recipe. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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.

      Parameters:
      semanticVersion - The semantic version of the container recipe. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • components

      Components for build and test 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 - Components for build and test 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • components

      Components for build and test 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 - Components for build and test 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • components

      Components for build and test 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.

      This is a convenience method that creates an instance of the ComponentConfiguration.Builder avoiding the need to create one manually via ComponentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to components(List<ComponentConfiguration>).

      Parameters:
      components - a consumer that will call methods on ComponentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • instanceConfiguration

      CreateContainerRecipeRequest.Builder instanceConfiguration(InstanceConfiguration 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • instanceConfiguration

      default CreateContainerRecipeRequest.Builder instanceConfiguration(Consumer<InstanceConfiguration.Builder> instanceConfiguration)

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

      This is a convenience method that creates an instance of the InstanceConfiguration.Builder avoiding the need to create one manually via InstanceConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceConfiguration(InstanceConfiguration).

      Parameters:
      instanceConfiguration - a consumer that will call methods on InstanceConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • dockerfileTemplateData

      CreateContainerRecipeRequest.Builder dockerfileTemplateData(String dockerfileTemplateData)

      The Dockerfile template used to build your image as an inline data blob.

      Parameters:
      dockerfileTemplateData - The Dockerfile template used to build your image as an inline data blob.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dockerfileTemplateUri

      CreateContainerRecipeRequest.Builder dockerfileTemplateUri(String dockerfileTemplateUri)

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

      Parameters:
      dockerfileTemplateUri - The Amazon S3 URI for the Dockerfile that will be used to build your container image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • platformOverride

      CreateContainerRecipeRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • platformOverride

      CreateContainerRecipeRequest.Builder platformOverride(Platform 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • imageOsVersionOverride

      CreateContainerRecipeRequest.Builder imageOsVersionOverride(String imageOsVersionOverride)

      Specifies the operating system version for the base image.

      Parameters:
      imageOsVersionOverride - Specifies the operating system version for the base image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • parentImage

      CreateContainerRecipeRequest.Builder parentImage(String parentImage)

      The base image for the container recipe.

      Parameters:
      parentImage - The base image for the container recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      Tags that are attached to the container recipe.

      Parameters:
      tags - Tags that are attached to the container recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • workingDirectory

      CreateContainerRecipeRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetRepository

      The destination repository for the container image.

      Parameters:
      targetRepository - The destination repository for the container image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetRepository

      The destination repository for the container image.

      This is a convenience method that creates an instance of the TargetContainerRepository.Builder avoiding the need to create one manually via TargetContainerRepository.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetRepository(TargetContainerRepository).

      Parameters:
      targetRepository - a consumer that will call methods on TargetContainerRepository.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • kmsKeyId

      Identifies which KMS key is used to encrypt the container image.

      Parameters:
      kmsKeyId - Identifies which KMS key is used to encrypt the container image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientToken

      CreateContainerRecipeRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      CreateContainerRecipeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.