Image.Builder (AWS Java SDK :: Services :: Imagebuilder 2.19.15 API)

All Superinterfaces:

Buildable, CopyableBuilder<Image.Builder,Image>, SdkBuilder<Image.Builder,Image>, SdkPojo

Enclosing class:

Image
```
public static interface Image.Builder
extends SdkPojo, CopyableBuilder<Image.Builder,Image>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Image.Builder`	`arn(String arn)` The Amazon Resource Name (ARN) of the image.
`Image.Builder`	`buildType(BuildType buildType)` Indicates the type of build that created this image.
`Image.Builder`	`buildType(String buildType)` Indicates the type of build that created this image.
`default Image.Builder`	`containerRecipe(Consumer<ContainerRecipe.Builder> containerRecipe)` The recipe that is used to create an Image Builder container image.
`Image.Builder`	`containerRecipe(ContainerRecipe containerRecipe)` The recipe that is used to create an Image Builder container image.
`Image.Builder`	`dateCreated(String dateCreated)` The date on which this image was created.
`default Image.Builder`	`distributionConfiguration(Consumer<DistributionConfiguration.Builder> distributionConfiguration)` The distribution configuration used when creating this image.
`Image.Builder`	`distributionConfiguration(DistributionConfiguration distributionConfiguration)` The distribution configuration used when creating this image.
`Image.Builder`	`enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)` Collects additional information about the image being created, including the operating system (OS) version and package list.
`default Image.Builder`	`imageRecipe(Consumer<ImageRecipe.Builder> imageRecipe)` The image recipe used when creating the image.
`Image.Builder`	`imageRecipe(ImageRecipe imageRecipe)` The image recipe used when creating the image.
`default Image.Builder`	`imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration)` The image tests configuration used when creating this image.
`Image.Builder`	`imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)` The image tests configuration used when creating this image.
`default Image.Builder`	`infrastructureConfiguration(Consumer<InfrastructureConfiguration.Builder> infrastructureConfiguration)` The infrastructure used when creating this image.
`Image.Builder`	`infrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)` The infrastructure used when creating this image.
`Image.Builder`	`name(String name)` The name of the image.
`Image.Builder`	`osVersion(String osVersion)` The operating system version of the instance.
`default Image.Builder`	`outputResources(Consumer<OutputResources.Builder> outputResources)` The output resources produced when creating this image.
`Image.Builder`	`outputResources(OutputResources outputResources)` The output resources produced when creating this image.
`Image.Builder`	`platform(Platform platform)` The platform of the image.
`Image.Builder`	`platform(String platform)` The platform of the image.
`Image.Builder`	`sourcePipelineArn(String sourcePipelineArn)` The Amazon Resource Name (ARN) of the image pipeline that created this image.
`Image.Builder`	`sourcePipelineName(String sourcePipelineName)` The name of the image pipeline that created this image.
`default Image.Builder`	`state(Consumer<ImageState.Builder> state)` The state of the image.
`Image.Builder`	`state(ImageState state)` The state of the image.
`Image.Builder`	`tags(Map<String,String> tags)` The tags of the image.
`Image.Builder`	`type(ImageType type)` Specifies whether this is an AMI or container image.
`Image.Builder`	`type(String type)` Specifies whether this is an AMI or container image.
`Image.Builder`	`version(String version)` The semantic version of the image.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - arn
```
Image.Builder arn(String arn)
```
    The Amazon Resource Name (ARN) of the image.
    Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
    
    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.
    
    Version ARNs have only the first three nodes: <major>.<minor>.<patch>
    
    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 image.
    
    Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
    
    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.
    
    Version ARNs have only the first three nodes: <major>.<minor>.<patch>
    
    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.
  - type
```
Image.Builder type(String type)
```
    Specifies whether this is an AMI or container image.
    
    Parameters:
    
    type - Specifies whether this is an AMI or container image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageType, ImageType
  - type
```
Image.Builder type(ImageType type)
```
    Specifies whether this is an AMI or container image.
    
    Parameters:
    
    type - Specifies whether this is an AMI or container image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageType, ImageType
  - name
```
Image.Builder name(String name)
```
    The name of the image.
    
    Parameters:
    
    name - The name of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - version
```
Image.Builder version(String version)
```
    The semantic version of the image.
    
    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.
    
    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 image.
    
    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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - platform
```
Image.Builder platform(String platform)
```
    The platform of the image.
    
    Parameters:
    
    platform - The platform of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform, Platform
  - platform
```
Image.Builder platform(Platform platform)
```
    The platform of the image.
    
    Parameters:
    
    platform - The platform of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform, Platform
  - enhancedImageMetadataEnabled
```
Image.Builder enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
```
    Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
    
    Parameters:
    
    enhancedImageMetadataEnabled - Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - osVersion
```
Image.Builder osVersion(String osVersion)
```
    The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
    
    Parameters:
    
    osVersion - The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - state
```
Image.Builder state(ImageState state)
```
    The state of the image.
    
    Parameters:
    
    state - The state of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - state
```
default Image.Builder state(Consumer<ImageState.Builder> state)
```
    The state of the image.
    This is a convenience method that creates an instance of the ImageState.Builder avoiding the need to create one manually via ImageState.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to state(ImageState).
    
    Parameters:
    
    state - a consumer that will call methods on ImageState.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    state(ImageState)
  - imageRecipe
```
Image.Builder imageRecipe(ImageRecipe imageRecipe)
```
    The image recipe used when creating the image.
    
    Parameters:
    
    imageRecipe - The image recipe used when creating the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - imageRecipe
```
default Image.Builder imageRecipe(Consumer<ImageRecipe.Builder> imageRecipe)
```
    The image recipe used when creating the image.
    This is a convenience method that creates an instance of the ImageRecipe.Builder avoiding the need to create one manually via ImageRecipe.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageRecipe(ImageRecipe).
    
    Parameters:
    
    imageRecipe - a consumer that will call methods on ImageRecipe.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    imageRecipe(ImageRecipe)
  - containerRecipe
```
Image.Builder containerRecipe(ContainerRecipe containerRecipe)
```
    The recipe that is used to create an Image Builder container image.
    
    Parameters:
    
    containerRecipe - The recipe that is used to create an Image Builder container image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - containerRecipe
```
default Image.Builder containerRecipe(Consumer<ContainerRecipe.Builder> containerRecipe)
```
    The recipe that is used to create an Image Builder container image.
    This is a convenience method that creates an instance of the ContainerRecipe.Builder avoiding the need to create one manually via ContainerRecipe.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containerRecipe(ContainerRecipe).
    
    Parameters:
    
    containerRecipe - a consumer that will call methods on ContainerRecipe.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    containerRecipe(ContainerRecipe)
  - sourcePipelineName
```
Image.Builder sourcePipelineName(String sourcePipelineName)
```
    The name of the image pipeline that created this image.
    
    Parameters:
    
    sourcePipelineName - The name of the image pipeline that created this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sourcePipelineArn
```
Image.Builder sourcePipelineArn(String sourcePipelineArn)
```
    The Amazon Resource Name (ARN) of the image pipeline that created this image.
    
    Parameters:
    
    sourcePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that created this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - infrastructureConfiguration
```
Image.Builder infrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
```
    The infrastructure used when creating this image.
    
    Parameters:
    
    infrastructureConfiguration - The infrastructure used when creating this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - infrastructureConfiguration
```
default Image.Builder infrastructureConfiguration(Consumer<InfrastructureConfiguration.Builder> infrastructureConfiguration)
```
    The infrastructure used when creating this image.
    This is a convenience method that creates an instance of the InfrastructureConfiguration.Builder avoiding the need to create one manually via InfrastructureConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to infrastructureConfiguration(InfrastructureConfiguration).
    
    Parameters:
    
    infrastructureConfiguration - a consumer that will call methods on InfrastructureConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    infrastructureConfiguration(InfrastructureConfiguration)
  - distributionConfiguration
```
Image.Builder distributionConfiguration(DistributionConfiguration distributionConfiguration)
```
    The distribution configuration used when creating this image.
    
    Parameters:
    
    distributionConfiguration - The distribution configuration used when creating this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - distributionConfiguration
```
default Image.Builder distributionConfiguration(Consumer<DistributionConfiguration.Builder> distributionConfiguration)
```
    The distribution configuration used when creating this image.
    This is a convenience method that creates an instance of the DistributionConfiguration.Builder avoiding the need to create one manually via DistributionConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to distributionConfiguration(DistributionConfiguration).
    
    Parameters:
    
    distributionConfiguration - a consumer that will call methods on DistributionConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    distributionConfiguration(DistributionConfiguration)
  - imageTestsConfiguration
```
Image.Builder imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
```
    The image tests configuration used when creating this image.
    
    Parameters:
    
    imageTestsConfiguration - The image tests configuration used when creating this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - imageTestsConfiguration
```
default Image.Builder imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration)
```
    The image tests configuration used when creating this image.
    This is a convenience method that creates an instance of the ImageTestsConfiguration.Builder avoiding the need to create one manually via ImageTestsConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageTestsConfiguration(ImageTestsConfiguration).
    
    Parameters:
    
    imageTestsConfiguration - a consumer that will call methods on ImageTestsConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    imageTestsConfiguration(ImageTestsConfiguration)
  - dateCreated
```
Image.Builder dateCreated(String dateCreated)
```
    The date on which this image was created.
    
    Parameters:
    
    dateCreated - The date on which this image was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputResources
```
Image.Builder outputResources(OutputResources outputResources)
```
    The output resources produced when creating this image.
    
    Parameters:
    
    outputResources - The output resources produced when creating this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputResources
```
default Image.Builder outputResources(Consumer<OutputResources.Builder> outputResources)
```
    The output resources produced when creating this image.
    This is a convenience method that creates an instance of the OutputResources.Builder avoiding the need to create one manually via OutputResources.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputResources(OutputResources).
    
    Parameters:
    
    outputResources - a consumer that will call methods on OutputResources.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    outputResources(OutputResources)
  - tags
```
Image.Builder tags(Map<String,String> tags)
```
    The tags of the image.
    
    Parameters:
    
    tags - The tags of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - buildType
```
Image.Builder buildType(String buildType)
```
    Indicates the type of build that created this image. The build can be initiated in the following ways:
    - USER_INITIATED – A manual pipeline build request.
    - SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
    - IMPORT – A VM import created the image to use as the base image for the recipe.
    Parameters:
    buildType - Indicates the type of build that created this image. The build can be initiated in the following ways:
    
    USER_INITIATED – A manual pipeline build request.
    
    SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
    
    IMPORT – A VM import created the image to use as the base image for the recipe.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BuildType, BuildType
  - buildType
```
Image.Builder buildType(BuildType buildType)
```
    Indicates the type of build that created this image. The build can be initiated in the following ways:
    - USER_INITIATED – A manual pipeline build request.
    - SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
    - IMPORT – A VM import created the image to use as the base image for the recipe.
    Parameters:
    buildType - Indicates the type of build that created this image. The build can be initiated in the following ways:
    
    USER_INITIATED – A manual pipeline build request.
    
    SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.
    
    IMPORT – A VM import created the image to use as the base image for the recipe.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BuildType, BuildType

Interface Image.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

arn

type

type

name

version

platform

platform

enhancedImageMetadataEnabled

osVersion

state

state

imageRecipe

imageRecipe

containerRecipe

containerRecipe

sourcePipelineName

sourcePipelineArn

infrastructureConfiguration

infrastructureConfiguration

distributionConfiguration

distributionConfiguration

imageTestsConfiguration

imageTestsConfiguration

dateCreated

outputResources

outputResources

tags

buildType

buildType