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

java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.Image

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Image.Builder,Image>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Image
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Image.Builder,Image>
```
An Image Builder image. You must specify exactly one recipe for the image – either a container recipe ( containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Image.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Image.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the image.
`static Image.Builder`	`builder()`
`BuildType`	`buildType()` Indicates the type of build that created this image.
`String`	`buildTypeAsString()` Indicates the type of build that created this image.
`ContainerRecipe`	`containerRecipe()` The recipe that is used to create an Image Builder container image.
`String`	`dateCreated()` The date on which this image was created.
`DistributionConfiguration`	`distributionConfiguration()` The distribution configuration used when creating this image.
`Boolean`	`enhancedImageMetadataEnabled()` Collects additional information about the image being created, including the operating system (OS) version and package list.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`ImageRecipe`	`imageRecipe()` The image recipe used when creating the image.
`ImageTestsConfiguration`	`imageTestsConfiguration()` The image tests configuration used when creating this image.
`InfrastructureConfiguration`	`infrastructureConfiguration()` The infrastructure used when creating this image.
`String`	`name()` The name of the image.
`String`	`osVersion()` The operating system version of the instance.
`OutputResources`	`outputResources()` The output resources produced when creating this image.
`Platform`	`platform()` The platform of the image.
`String`	`platformAsString()` The platform of the image.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Image.Builder>`	`serializableBuilderClass()`
`String`	`sourcePipelineArn()` The Amazon Resource Name (ARN) of the image pipeline that created this image.
`String`	`sourcePipelineName()` The name of the image pipeline that created this image.
`ImageState`	`state()` The state of the image.
`Map<String,String>`	`tags()` The tags of the image.
`Image.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ImageType`	`type()` Specifies whether this is an AMI or container image.
`String`	`typeAsString()` Specifies whether this is an AMI or container image.
`String`	`version()` The semantic version of the image.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - arn
```
public final 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.
    Returns:
    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.
  - type
```
public final ImageType type()
```
    Specifies whether this is an AMI or container image.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ImageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies whether this is an AMI or container image.
    
    See Also:
    
    ImageType
  - typeAsString
```
public final String typeAsString()
```
    Specifies whether this is an AMI or container image.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ImageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies whether this is an AMI or container image.
    
    See Also:
    
    ImageType
  - name
```
public final String name()
```
    The name of the image.
    
    Returns:
    
    The name of the image.
  - version
```
public final 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.
    
    Returns:
    
    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.
  - platform
```
public final Platform platform()
```
    The platform of the image.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The platform of the image.
    
    See Also:
    
    Platform
  - platformAsString
```
public final String platformAsString()
```
    The platform of the image.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The platform of the image.
    
    See Also:
    
    Platform
  - enhancedImageMetadataEnabled
```
public final 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.
    
    Returns:
    
    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.
  - osVersion
```
public final String osVersion()
```
    The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
    
    Returns:
    
    The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
  - state
```
public final ImageState state()
```
    The state of the image.
    
    Returns:
    
    The state of the image.
  - imageRecipe
```
public final ImageRecipe imageRecipe()
```
    The image recipe used when creating the image.
    
    Returns:
    
    The image recipe used when creating the image.
  - containerRecipe
```
public final ContainerRecipe containerRecipe()
```
    The recipe that is used to create an Image Builder container image.
    
    Returns:
    
    The recipe that is used to create an Image Builder container image.
  - sourcePipelineName
```
public final String sourcePipelineName()
```
    The name of the image pipeline that created this image.
    
    Returns:
    
    The name of the image pipeline that created this image.
  - sourcePipelineArn
```
public final String sourcePipelineArn()
```
    The Amazon Resource Name (ARN) of the image pipeline that created this image.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the image pipeline that created this image.
  - infrastructureConfiguration
```
public final InfrastructureConfiguration infrastructureConfiguration()
```
    The infrastructure used when creating this image.
    
    Returns:
    
    The infrastructure used when creating this image.
  - distributionConfiguration
```
public final DistributionConfiguration distributionConfiguration()
```
    The distribution configuration used when creating this image.
    
    Returns:
    
    The distribution configuration used when creating this image.
  - imageTestsConfiguration
```
public final ImageTestsConfiguration imageTestsConfiguration()
```
    The image tests configuration used when creating this image.
    
    Returns:
    
    The image tests configuration used when creating this image.
  - dateCreated
```
public final String dateCreated()
```
    The date on which this image was created.
    
    Returns:
    
    The date on which this image was created.
  - outputResources
```
public final OutputResources outputResources()
```
    The output resources produced when creating this image.
    
    Returns:
    
    The output resources produced when creating this image.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags of the image.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags of the image.
  - buildType
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, buildType will return BuildType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from buildTypeAsString().
    Returns:
    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.
    See Also:
    
    BuildType
  - buildTypeAsString
```
public final String buildTypeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, buildType will return BuildType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from buildTypeAsString().
    Returns:
    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.
    See Also:
    
    BuildType
  - toBuilder
```
public Image.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Image.Builder,Image>
  - builder
```
public static Image.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Image.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Image

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

type

typeAsString

name

version

platform

platformAsString

enhancedImageMetadataEnabled

osVersion

state

imageRecipe

containerRecipe

sourcePipelineName

sourcePipelineArn

infrastructureConfiguration

distributionConfiguration

imageTestsConfiguration

dateCreated

outputResources

hasTags

tags

buildType

buildTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields