Interface CreateContainerRecipeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateContainerRecipeRequest.Builder,CreateContainerRecipeRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateContainerRecipeRequest.Builder,CreateContainerRecipeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateContainerRecipeRequest
@Mutable @NotThreadSafe 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

      CreateContainerRecipeRequest.Builder containerType(ContainerType 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

      CreateContainerRecipeRequest.Builder name(String name)

      The name of the container recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the container recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

      Parameters:
      name - The name of the container recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the container recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
      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. The upper limit is 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. The upper limit is 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

      CreateContainerRecipeRequest.Builder components(Collection<ComponentConfiguration> components)

      The components included in the container recipe. You can specify each component only one time in a recipe.

      Parameters:
      components - The components included in the container recipe. You can specify each component only one time in a recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • components

      CreateContainerRecipeRequest.Builder components(ComponentConfiguration... components)

      The components included in the container recipe. You can specify each component only one time in a recipe.

      Parameters:
      components - The components included in the container recipe. You can specify each component only one time in a recipe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • components

      CreateContainerRecipeRequest.Builder components(Consumer<ComponentConfiguration.Builder>... components)

      The components included in the container recipe. You can specify each component only one time in a recipe.

      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. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide.

      Parameters:
      dockerfileTemplateData - The Dockerfile template used to build your image, as an inline data blob. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide.
      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 template that is used to build your container image. You must have permission to read the object. Image Builder reads the object once, when it creates the recipe, and stores its content in the recipe. Later changes to the S3 object don't affect the recipe. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties.

      Parameters:
      dockerfileTemplateUri - The Amazon S3 URI for the Dockerfile template that is used to build your container image. You must have permission to read the object. Image Builder reads the object once, when it creates the recipe, and stores its content in the recipe. Later changes to the S3 object don't affect the recipe. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties.
      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. Container recipes support only the Linux and Windows platforms.

      Parameters:
      platformOverride - Specifies the operating system platform when you use a custom base image. Container recipes support only the Linux and Windows platforms.
      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. Container recipes support only the Linux and Windows platforms.

      Parameters:
      platformOverride - Specifies the operating system platform when you use a custom base image. Container recipes support only the Linux and Windows platforms.
      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. Use this property only when the base image is a container image from a registry. When the base image is an Image Builder image, the operating system version comes from the parent image.

      Parameters:
      imageOsVersionOverride - Specifies the operating system version for the base image. Use this property only when the base image is a container image from a registry. When the base image is an Image Builder image, the operating system version comes from the parent 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. This can be an Image Builder image resource ARN or a container image URI from a registry, for example amazonlinux:latest.

      Parameters:
      parentImage - The base image for the container recipe. This can be an Image Builder image resource ARN or a container image URI from a registry, for example amazonlinux:latest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateContainerRecipeRequest.Builder tags(Map<String,String> 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

      CreateContainerRecipeRequest.Builder targetRepository(TargetContainerRepository targetRepository)

      The destination repository for the container image. The Amazon ECR repository must already exist in the Amazon Web Services Region where the build runs.

      Parameters:
      targetRepository - The destination repository for the container image. The Amazon ECR repository must already exist in the Amazon Web Services Region where the build runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetRepository

      default CreateContainerRecipeRequest.Builder targetRepository(Consumer<TargetContainerRepository.Builder> targetRepository)

      The destination repository for the container image. The Amazon ECR repository must already exist in the Amazon Web Services Region where the build runs.

      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

      CreateContainerRecipeRequest.Builder kmsKeyId(String kmsKeyId)

      The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

      Parameters:
      kmsKeyId - The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateContainerRecipeRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. 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.

    • dryRun

      CreateContainerRecipeRequest.Builder dryRun(Boolean dryRun)

      Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

      Parameters:
      dryRun - Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
      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

      CreateContainerRecipeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.