Interface ContainerRecipe.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ContainerRecipe.Builder,ContainerRecipe>, SdkBuilder<ContainerRecipe.Builder,ContainerRecipe>, SdkPojo
Enclosing class:
ContainerRecipe
@Mutable @NotThreadSafe public static interface ContainerRecipe.Builder extends SdkPojo, CopyableBuilder<ContainerRecipe.Builder,ContainerRecipe>

  • Method Details

    • arn

      ContainerRecipe.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the container recipe.

      Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

      1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

      2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

      3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the container recipe.

      Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

      1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

      2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

      3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

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

    • containerType

      ContainerRecipe.Builder containerType(String containerType)

      Specifies the type of container, such as Docker.

      Parameters:
      containerType - Specifies the type of container, such as Docker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • containerType

      ContainerRecipe.Builder containerType(ContainerType containerType)

      Specifies the type of container, such as Docker.

      Parameters:
      containerType - Specifies the type of container, such as Docker.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      ContainerRecipe.Builder name(String 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

      ContainerRecipe.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.

    • platform

      ContainerRecipe.Builder platform(String platform)

      The system platform for the container. Container recipes support only the Linux and Windows platforms.

      Parameters:
      platform - The system platform for the container. 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:

    • platform

      ContainerRecipe.Builder platform(Platform platform)

      The system platform for the container. Container recipes support only the Linux and Windows platforms.

      Parameters:
      platform - The system platform for the container. 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:

    • owner

      ContainerRecipe.Builder owner(String owner)

      The owner of the container recipe.

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

    • version

      ContainerRecipe.Builder version(String version)

      The semantic version of the container recipe.

      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.

      Filtering: You can 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.

      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.

      Filtering: You can 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.

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

    • components

      ContainerRecipe.Builder components(Collection<ComponentConfiguration> components)

      Build and test components that are included in the container recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.

      Parameters:
      components - Build and test components that are included in the container recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • components

      ContainerRecipe.Builder components(ComponentConfiguration... components)

      Build and test components that are included in the container recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.

      Parameters:
      components - Build and test components that are included in the container recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • components

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

      Build and test components that are included in the container recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.

      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

      ContainerRecipe.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 ContainerRecipe.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

      ContainerRecipe.Builder dockerfileTemplateData(String dockerfileTemplateData)

      The Dockerfile template that Image Builder uses to build the container image. The template can include contextual variables that Image Builder replaces with build information at build time. 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 that Image Builder uses to build the container image. The template can include contextual variables that Image Builder replaces with build information at build time. 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.

    • kmsKeyId

      ContainerRecipe.Builder kmsKeyId(String kmsKeyId)

      The KMS key that Image Builder uses to encrypt the recipe's Dockerfile template data at rest. 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. If you don't specify a key, Image Builder encrypts the template data with a KMS key that Image Builder owns. This key isn't used to encrypt the output container image.

      Parameters:
      kmsKeyId - The KMS key that Image Builder uses to encrypt the recipe's Dockerfile template data at rest. 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. If you don't specify a key, Image Builder encrypts the template data with a KMS key that Image Builder owns. This key isn't used to encrypt the output container image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encrypted

      ContainerRecipe.Builder encrypted(Boolean encrypted)

      Specifies whether the recipe's Dockerfile template data is encrypted at rest. Image Builder encrypts all Dockerfile template data at rest, so this value is always true. This field is retained for backward compatibility, and doesn't describe encryption of the output container image.

      Parameters:
      encrypted - Specifies whether the recipe's Dockerfile template data is encrypted at rest. Image Builder encrypts all Dockerfile template data at rest, so this value is always true. This field is retained for backward compatibility, and doesn't describe encryption of the output container image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentImage

      ContainerRecipe.Builder parentImage(String parentImage)

      The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest.

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

    • dateCreated

      ContainerRecipe.Builder dateCreated(String dateCreated)

      The date when this container recipe was created.

      Parameters:
      dateCreated - The date when this container recipe was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      ContainerRecipe.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

      ContainerRecipe.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

      ContainerRecipe.Builder targetRepository(TargetContainerRepository 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

      default ContainerRecipe.Builder targetRepository(Consumer<TargetContainerRepository.Builder> 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: