Image (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.imagebuilder.model.Image

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Image
extends Object
implements Serializable, Cloneable, StructuredPojo

An image build version.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Image()

Constructors
Constructor and Description
`Image()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Image`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Image`	`clearTagsEntries()` Removes all the entries added into Tags.
`Image`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the image.
`ContainerRecipe`	`getContainerRecipe()` The container recipe used to create the container image type.
`String`	`getDateCreated()` The date on which this image was created.
`DistributionConfiguration`	`getDistributionConfiguration()` The distribution configuration used when creating this image.
`Boolean`	`getEnhancedImageMetadataEnabled()` Collects additional information about the image being created, including the operating system (OS) version and package list.
`ImageRecipe`	`getImageRecipe()` The image recipe used when creating the image.
`ImageTestsConfiguration`	`getImageTestsConfiguration()` The image tests configuration used when creating this image.
`InfrastructureConfiguration`	`getInfrastructureConfiguration()` The infrastructure used when creating this image.
`String`	`getName()` The name of the image.
`String`	`getOsVersion()` The operating system version of the instance.
`OutputResources`	`getOutputResources()` The output resources produced when creating this image.
`String`	`getPlatform()` The platform of the image.
`String`	`getSourcePipelineArn()` The Amazon Resource Name (ARN) of the image pipeline that created this image.
`String`	`getSourcePipelineName()` The name of the image pipeline that created this image.
`ImageState`	`getState()` The state of the image.
`Map<String,String>`	`getTags()` The tags of the image.
`String`	`getType()` Specifies whether this is an AMI or container image.
`String`	`getVersion()` The semantic version of the image.
`int`	`hashCode()`
`Boolean`	`isEnhancedImageMetadataEnabled()` Collects additional information about the image being created, including the operating system (OS) version and package list.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the image.
`void`	`setContainerRecipe(ContainerRecipe containerRecipe)` The container recipe used to create the container image type.
`void`	`setDateCreated(String dateCreated)` The date on which this image was created.
`void`	`setDistributionConfiguration(DistributionConfiguration distributionConfiguration)` The distribution configuration used when creating this image.
`void`	`setEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)` Collects additional information about the image being created, including the operating system (OS) version and package list.
`void`	`setImageRecipe(ImageRecipe imageRecipe)` The image recipe used when creating the image.
`void`	`setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)` The image tests configuration used when creating this image.
`void`	`setInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)` The infrastructure used when creating this image.
`void`	`setName(String name)` The name of the image.
`void`	`setOsVersion(String osVersion)` The operating system version of the instance.
`void`	`setOutputResources(OutputResources outputResources)` The output resources produced when creating this image.
`void`	`setPlatform(String platform)` The platform of the image.
`void`	`setSourcePipelineArn(String sourcePipelineArn)` The Amazon Resource Name (ARN) of the image pipeline that created this image.
`void`	`setSourcePipelineName(String sourcePipelineName)` The name of the image pipeline that created this image.
`void`	`setState(ImageState state)` The state of the image.
`void`	`setTags(Map<String,String> tags)` The tags of the image.
`void`	`setType(String type)` Specifies whether this is an AMI or container image.
`void`	`setVersion(String version)` The semantic version of the image.
`String`	`toString()` Returns a string representation of this object.
`Image`	`withArn(String arn)` The Amazon Resource Name (ARN) of the image.
`Image`	`withContainerRecipe(ContainerRecipe containerRecipe)` The container recipe used to create the container image type.
`Image`	`withDateCreated(String dateCreated)` The date on which this image was created.
`Image`	`withDistributionConfiguration(DistributionConfiguration distributionConfiguration)` The distribution configuration used when creating this image.
`Image`	`withEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)` Collects additional information about the image being created, including the operating system (OS) version and package list.
`Image`	`withImageRecipe(ImageRecipe imageRecipe)` The image recipe used when creating the image.
`Image`	`withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)` The image tests configuration used when creating this image.
`Image`	`withInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)` The infrastructure used when creating this image.
`Image`	`withName(String name)` The name of the image.
`Image`	`withOsVersion(String osVersion)` The operating system version of the instance.
`Image`	`withOutputResources(OutputResources outputResources)` The output resources produced when creating this image.
`Image`	`withPlatform(Platform platform)` The platform of the image.
`Image`	`withPlatform(String platform)` The platform of the image.
`Image`	`withSourcePipelineArn(String sourcePipelineArn)` The Amazon Resource Name (ARN) of the image pipeline that created this image.
`Image`	`withSourcePipelineName(String sourcePipelineName)` The name of the image pipeline that created this image.
`Image`	`withState(ImageState state)` The state of the image.
`Image`	`withTags(Map<String,String> tags)` The tags of the image.
`Image`	`withType(ImageType type)` Specifies whether this is an AMI or container image.
`Image`	`withType(String type)` Specifies whether this is an AMI or container image.
`Image`	`withVersion(String version)` The semantic version of the image.

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

- Constructor Detail
  - Image
```
public Image()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the image.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the image.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the image.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the image.
  - withArn
```
public Image withArn(String arn)
```
    The Amazon Resource Name (ARN) of the image.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Specifies whether this is an AMI or container image.
    
    Parameters:
    
    type - Specifies whether this is an AMI or container image.
    
    See Also:
    
    ImageType
  - getType
```
public String getType()
```
    Specifies whether this is an AMI or container image.
    
    Returns:
    
    Specifies whether this is an AMI or container image.
    
    See Also:
    
    ImageType
  - withType
```
public Image withType(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
  - withType
```
public Image withType(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
  - setName
```
public void setName(String name)
```
    The name of the image.
    
    Parameters:
    
    name - The name of the image.
  - getName
```
public String getName()
```
    The name of the image.
    
    Returns:
    
    The name of the image.
  - withName
```
public Image withName(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.
  - setVersion
```
public void setVersion(String version)
```
    The semantic version of the image.
    
    Parameters:
    
    version - The semantic version of the image.
  - getVersion
```
public String getVersion()
```
    The semantic version of the image.
    
    Returns:
    
    The semantic version of the image.
  - withVersion
```
public Image withVersion(String version)
```
    The semantic version of the image.
    
    Parameters:
    
    version - The semantic version of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatform
```
public void setPlatform(String platform)
```
    The platform of the image.
    
    Parameters:
    
    platform - The platform of the image.
    
    See Also:
    
    Platform
  - getPlatform
```
public String getPlatform()
```
    The platform of the image.
    
    Returns:
    
    The platform of the image.
    
    See Also:
    
    Platform
  - withPlatform
```
public Image withPlatform(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
  - withPlatform
```
public Image withPlatform(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
  - setEnhancedImageMetadataEnabled
```
public void setEnhancedImageMetadataEnabled(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.
  - getEnhancedImageMetadataEnabled
```
public Boolean getEnhancedImageMetadataEnabled()
```
    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.
  - withEnhancedImageMetadataEnabled
```
public Image withEnhancedImageMetadataEnabled(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.
  - isEnhancedImageMetadataEnabled
```
public Boolean isEnhancedImageMetadataEnabled()
```
    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.
  - setOsVersion
```
public void setOsVersion(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.
  - getOsVersion
```
public String getOsVersion()
```
    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.
  - withOsVersion
```
public Image withOsVersion(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.
  - setState
```
public void setState(ImageState state)
```
    The state of the image.
    
    Parameters:
    
    state - The state of the image.
  - getState
```
public ImageState getState()
```
    The state of the image.
    
    Returns:
    
    The state of the image.
  - withState
```
public Image withState(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.
  - setImageRecipe
```
public void setImageRecipe(ImageRecipe imageRecipe)
```
    The image recipe used when creating the image.
    
    Parameters:
    
    imageRecipe - The image recipe used when creating the image.
  - getImageRecipe
```
public ImageRecipe getImageRecipe()
```
    The image recipe used when creating the image.
    
    Returns:
    
    The image recipe used when creating the image.
  - withImageRecipe
```
public Image withImageRecipe(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.
  - setContainerRecipe
```
public void setContainerRecipe(ContainerRecipe containerRecipe)
```
    The container recipe used to create the container image type.
    
    Parameters:
    
    containerRecipe - The container recipe used to create the container image type.
  - getContainerRecipe
```
public ContainerRecipe getContainerRecipe()
```
    The container recipe used to create the container image type.
    
    Returns:
    
    The container recipe used to create the container image type.
  - withContainerRecipe
```
public Image withContainerRecipe(ContainerRecipe containerRecipe)
```
    The container recipe used to create the container image type.
    
    Parameters:
    
    containerRecipe - The container recipe used to create the container image type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourcePipelineName
```
public void setSourcePipelineName(String sourcePipelineName)
```
    The name of the image pipeline that created this image.
    
    Parameters:
    
    sourcePipelineName - The name of the image pipeline that created this image.
  - getSourcePipelineName
```
public String getSourcePipelineName()
```
    The name of the image pipeline that created this image.
    
    Returns:
    
    The name of the image pipeline that created this image.
  - withSourcePipelineName
```
public Image withSourcePipelineName(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.
  - setSourcePipelineArn
```
public void setSourcePipelineArn(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.
  - getSourcePipelineArn
```
public String getSourcePipelineArn()
```
    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.
  - withSourcePipelineArn
```
public Image withSourcePipelineArn(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.
  - setInfrastructureConfiguration
```
public void setInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
```
    The infrastructure used when creating this image.
    
    Parameters:
    
    infrastructureConfiguration - The infrastructure used when creating this image.
  - getInfrastructureConfiguration
```
public InfrastructureConfiguration getInfrastructureConfiguration()
```
    The infrastructure used when creating this image.
    
    Returns:
    
    The infrastructure used when creating this image.
  - withInfrastructureConfiguration
```
public Image withInfrastructureConfiguration(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.
  - setDistributionConfiguration
```
public void setDistributionConfiguration(DistributionConfiguration distributionConfiguration)
```
    The distribution configuration used when creating this image.
    
    Parameters:
    
    distributionConfiguration - The distribution configuration used when creating this image.
  - getDistributionConfiguration
```
public DistributionConfiguration getDistributionConfiguration()
```
    The distribution configuration used when creating this image.
    
    Returns:
    
    The distribution configuration used when creating this image.
  - withDistributionConfiguration
```
public Image withDistributionConfiguration(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.
  - setImageTestsConfiguration
```
public void setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
```
    The image tests configuration used when creating this image.
    
    Parameters:
    
    imageTestsConfiguration - The image tests configuration used when creating this image.
  - getImageTestsConfiguration
```
public ImageTestsConfiguration getImageTestsConfiguration()
```
    The image tests configuration used when creating this image.
    
    Returns:
    
    The image tests configuration used when creating this image.
  - withImageTestsConfiguration
```
public Image withImageTestsConfiguration(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.
  - setDateCreated
```
public void setDateCreated(String dateCreated)
```
    The date on which this image was created.
    
    Parameters:
    
    dateCreated - The date on which this image was created.
  - getDateCreated
```
public String getDateCreated()
```
    The date on which this image was created.
    
    Returns:
    
    The date on which this image was created.
  - withDateCreated
```
public Image withDateCreated(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.
  - setOutputResources
```
public void setOutputResources(OutputResources outputResources)
```
    The output resources produced when creating this image.
    
    Parameters:
    
    outputResources - The output resources produced when creating this image.
  - getOutputResources
```
public OutputResources getOutputResources()
```
    The output resources produced when creating this image.
    
    Returns:
    
    The output resources produced when creating this image.
  - withOutputResources
```
public Image withOutputResources(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.
  - getTags
```
public Map<String,String> getTags()
```
    The tags of the image.
    
    Returns:
    
    The tags of the image.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags of the image.
    
    Parameters:
    
    tags - The tags of the image.
  - withTags
```
public Image withTags(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.
  - addTagsEntry
```
public Image addTagsEntry(String key,
                          String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Image clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Image clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Image

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Image

Method Detail

setArn

getArn

withArn

setType

getType

withType

withType

setName

getName

withName

setVersion

getVersion

withVersion

setPlatform

getPlatform

withPlatform

withPlatform

setEnhancedImageMetadataEnabled

getEnhancedImageMetadataEnabled

withEnhancedImageMetadataEnabled

isEnhancedImageMetadataEnabled

setOsVersion

getOsVersion

withOsVersion

setState

getState

withState

setImageRecipe

getImageRecipe

withImageRecipe

setContainerRecipe

getContainerRecipe

withContainerRecipe

setSourcePipelineName

getSourcePipelineName

withSourcePipelineName

setSourcePipelineArn

getSourcePipelineArn

withSourcePipelineArn

setInfrastructureConfiguration

getInfrastructureConfiguration

withInfrastructureConfiguration

setDistributionConfiguration

getDistributionConfiguration

withDistributionConfiguration

setImageTestsConfiguration

getImageTestsConfiguration

withImageTestsConfiguration

setDateCreated

getDateCreated

withDateCreated

setOutputResources

getOutputResources

withOutputResources

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall