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 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:

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.
`String`	`getBuildType()` Indicates the type of build that created this image.
`ContainerRecipe`	`getContainerRecipe()` For container images, this is the container recipe that Image Builder used to create the image.
`String`	`getDateCreated()` The date on which Image Builder created this image.
`Date`	`getDeprecationTime()` The time when deprecation occurs for an image resource.
`DistributionConfiguration`	`getDistributionConfiguration()` The distribution configuration that Image Builder used to create this image.
`Boolean`	`getEnhancedImageMetadataEnabled()` Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
`String`	`getExecutionRole()` The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
`ImageRecipe`	`getImageRecipe()` For images that distribute an AMI, this is the image recipe that Image Builder used to create the image.
`ImageScanningConfiguration`	`getImageScanningConfiguration()` Contains settings for vulnerability scans.
`String`	`getImageSource()` The origin of the base image that Image Builder used to build this image.
`ImageTestsConfiguration`	`getImageTestsConfiguration()` The image tests that ran when that Image Builder created this image.
`InfrastructureConfiguration`	`getInfrastructureConfiguration()` The infrastructure that Image Builder used to create this image.
`String`	`getLifecycleExecutionId()` Identifies the last runtime instance of the lifecycle policy to take action on the image.
`String`	`getName()` The name of the image.
`String`	`getOsVersion()` The operating system version for instances that launch from this image.
`OutputResources`	`getOutputResources()` The output resources that Image Builder produces for this image.
`String`	`getPlatform()` The image operating system platform, such as Linux or Windows.
`ImageScanState`	`getScanState()` Contains information about the current state of scans for this 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 that apply to this image.
`String`	`getType()` Specifies whether this image produces an AMI or a container image.
`String`	`getVersion()` The semantic version of the image.
`List<WorkflowConfiguration>`	`getWorkflows()` Contains the build and test workflows that are associated with the image.
`int`	`hashCode()`
`Boolean`	`isEnhancedImageMetadataEnabled()` Indicates whether Image Builder collects additional information about the image, such as 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`	`setBuildType(String buildType)` Indicates the type of build that created this image.
`void`	`setContainerRecipe(ContainerRecipe containerRecipe)` For container images, this is the container recipe that Image Builder used to create the image.
`void`	`setDateCreated(String dateCreated)` The date on which Image Builder created this image.
`void`	`setDeprecationTime(Date deprecationTime)` The time when deprecation occurs for an image resource.
`void`	`setDistributionConfiguration(DistributionConfiguration distributionConfiguration)` The distribution configuration that Image Builder used to create this image.
`void`	`setEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)` Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
`void`	`setExecutionRole(String executionRole)` The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
`void`	`setImageRecipe(ImageRecipe imageRecipe)` For images that distribute an AMI, this is the image recipe that Image Builder used to create the image.
`void`	`setImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)` Contains settings for vulnerability scans.
`void`	`setImageSource(String imageSource)` The origin of the base image that Image Builder used to build this image.
`void`	`setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)` The image tests that ran when that Image Builder created this image.
`void`	`setInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)` The infrastructure that Image Builder used to create this image.
`void`	`setLifecycleExecutionId(String lifecycleExecutionId)` Identifies the last runtime instance of the lifecycle policy to take action on the image.
`void`	`setName(String name)` The name of the image.
`void`	`setOsVersion(String osVersion)` The operating system version for instances that launch from this image.
`void`	`setOutputResources(OutputResources outputResources)` The output resources that Image Builder produces for this image.
`void`	`setPlatform(String platform)` The image operating system platform, such as Linux or Windows.
`void`	`setScanState(ImageScanState scanState)` Contains information about the current state of scans for this 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 that apply to this image.
`void`	`setType(String type)` Specifies whether this image produces an AMI or a container image.
`void`	`setVersion(String version)` The semantic version of the image.
`void`	`setWorkflows(Collection<WorkflowConfiguration> workflows)` Contains the build and test workflows that are associated with the image.
`String`	`toString()` Returns a string representation of this object.
`Image`	`withArn(String arn)` The Amazon Resource Name (ARN) of the image.
`Image`	`withBuildType(BuildType buildType)` Indicates the type of build that created this image.
`Image`	`withBuildType(String buildType)` Indicates the type of build that created this image.
`Image`	`withContainerRecipe(ContainerRecipe containerRecipe)` For container images, this is the container recipe that Image Builder used to create the image.
`Image`	`withDateCreated(String dateCreated)` The date on which Image Builder created this image.
`Image`	`withDeprecationTime(Date deprecationTime)` The time when deprecation occurs for an image resource.
`Image`	`withDistributionConfiguration(DistributionConfiguration distributionConfiguration)` The distribution configuration that Image Builder used to create this image.
`Image`	`withEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)` Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
`Image`	`withExecutionRole(String executionRole)` The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
`Image`	`withImageRecipe(ImageRecipe imageRecipe)` For images that distribute an AMI, this is the image recipe that Image Builder used to create the image.
`Image`	`withImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)` Contains settings for vulnerability scans.
`Image`	`withImageSource(ImageSource imageSource)` The origin of the base image that Image Builder used to build this image.
`Image`	`withImageSource(String imageSource)` The origin of the base image that Image Builder used to build this image.
`Image`	`withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)` The image tests that ran when that Image Builder created this image.
`Image`	`withInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)` The infrastructure that Image Builder used to create this image.
`Image`	`withLifecycleExecutionId(String lifecycleExecutionId)` Identifies the last runtime instance of the lifecycle policy to take action on the image.
`Image`	`withName(String name)` The name of the image.
`Image`	`withOsVersion(String osVersion)` The operating system version for instances that launch from this image.
`Image`	`withOutputResources(OutputResources outputResources)` The output resources that Image Builder produces for this image.
`Image`	`withPlatform(Platform platform)` The image operating system platform, such as Linux or Windows.
`Image`	`withPlatform(String platform)` The image operating system platform, such as Linux or Windows.
`Image`	`withScanState(ImageScanState scanState)` Contains information about the current state of scans for this 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 that apply to this image.
`Image`	`withType(ImageType type)` Specifies whether this image produces an AMI or a container image.
`Image`	`withType(String type)` Specifies whether this image produces an AMI or a container image.
`Image`	`withVersion(String version)` The semantic version of the image.
`Image`	`withWorkflows(Collection<WorkflowConfiguration> workflows)` Contains the build and test workflows that are associated with the image.
`Image`	`withWorkflows(WorkflowConfiguration... workflows)` Contains the build and test workflows that are associated with 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.
    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.
  - getArn
```
public String getArn()
```
    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.
  - withArn
```
public Image withArn(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.
  - setType
```
public void setType(String type)
```
    Specifies whether this image produces an AMI or a container image.
    
    Parameters:
    
    type - Specifies whether this image produces an AMI or a container image.
    
    See Also:
    
    ImageType
  - getType
```
public String getType()
```
    Specifies whether this image produces an AMI or a container image.
    
    Returns:
    
    Specifies whether this image produces an AMI or a container image.
    
    See Also:
    
    ImageType
  - withType
```
public Image withType(String type)
```
    Specifies whether this image produces an AMI or a container image.
    
    Parameters:
    
    type - Specifies whether this image produces an AMI or a 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 image produces an AMI or a container image.
    
    Parameters:
    
    type - Specifies whether this image produces an AMI or a 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.
    
    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.
  - getVersion
```
public String getVersion()
```
    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.
  - withVersion
```
public Image withVersion(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.
  - setPlatform
```
public void setPlatform(String platform)
```
    The image operating system platform, such as Linux or Windows.
    
    Parameters:
    
    platform - The image operating system platform, such as Linux or Windows.
    
    See Also:
    
    Platform
  - getPlatform
```
public String getPlatform()
```
    The image operating system platform, such as Linux or Windows.
    
    Returns:
    
    The image operating system platform, such as Linux or Windows.
    
    See Also:
    
    Platform
  - withPlatform
```
public Image withPlatform(String platform)
```
    The image operating system platform, such as Linux or Windows.
    
    Parameters:
    
    platform - The image operating system platform, such as Linux or Windows.
    
    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 image operating system platform, such as Linux or Windows.
    
    Parameters:
    
    platform - The image operating system platform, such as Linux or Windows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform
  - setEnhancedImageMetadataEnabled
```
public void setEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
```
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
    
    Parameters:
    
    enhancedImageMetadataEnabled - Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
  - getEnhancedImageMetadataEnabled
```
public Boolean getEnhancedImageMetadataEnabled()
```
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
    
    Returns:
    
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
  - withEnhancedImageMetadataEnabled
```
public Image withEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)
```
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
    
    Parameters:
    
    enhancedImageMetadataEnabled - Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnhancedImageMetadataEnabled
```
public Boolean isEnhancedImageMetadataEnabled()
```
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
    
    Returns:
    
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
  - setOsVersion
```
public void setOsVersion(String osVersion)
```
    The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
    
    Parameters:
    
    osVersion - The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
  - getOsVersion
```
public String getOsVersion()
```
    The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
    
    Returns:
    
    The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
  - withOsVersion
```
public Image withOsVersion(String osVersion)
```
    The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
    
    Parameters:
    
    osVersion - The operating system version for instances that launch from this image. 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)
```
    For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
    
    Parameters:
    
    imageRecipe - For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
  - getImageRecipe
```
public ImageRecipe getImageRecipe()
```
    For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
    
    Returns:
    
    For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
  - withImageRecipe
```
public Image withImageRecipe(ImageRecipe imageRecipe)
```
    For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
    
    Parameters:
    
    imageRecipe - For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerRecipe
```
public void setContainerRecipe(ContainerRecipe containerRecipe)
```
    For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
    
    Parameters:
    
    containerRecipe - For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
  - getContainerRecipe
```
public ContainerRecipe getContainerRecipe()
```
    For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
    
    Returns:
    
    For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
  - withContainerRecipe
```
public Image withContainerRecipe(ContainerRecipe containerRecipe)
```
    For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
    
    Parameters:
    
    containerRecipe - For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.
    
    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 that Image Builder used to create this image.
    
    Parameters:
    
    infrastructureConfiguration - The infrastructure that Image Builder used to create this image.
  - getInfrastructureConfiguration
```
public InfrastructureConfiguration getInfrastructureConfiguration()
```
    The infrastructure that Image Builder used to create this image.
    
    Returns:
    
    The infrastructure that Image Builder used to create this image.
  - withInfrastructureConfiguration
```
public Image withInfrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)
```
    The infrastructure that Image Builder used to create this image.
    
    Parameters:
    
    infrastructureConfiguration - The infrastructure that Image Builder used to create 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 that Image Builder used to create this image.
    
    Parameters:
    
    distributionConfiguration - The distribution configuration that Image Builder used to create this image.
  - getDistributionConfiguration
```
public DistributionConfiguration getDistributionConfiguration()
```
    The distribution configuration that Image Builder used to create this image.
    
    Returns:
    
    The distribution configuration that Image Builder used to create this image.
  - withDistributionConfiguration
```
public Image withDistributionConfiguration(DistributionConfiguration distributionConfiguration)
```
    The distribution configuration that Image Builder used to create this image.
    
    Parameters:
    
    distributionConfiguration - The distribution configuration that Image Builder used to create 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 that ran when that Image Builder created this image.
    
    Parameters:
    
    imageTestsConfiguration - The image tests that ran when that Image Builder created this image.
  - getImageTestsConfiguration
```
public ImageTestsConfiguration getImageTestsConfiguration()
```
    The image tests that ran when that Image Builder created this image.
    
    Returns:
    
    The image tests that ran when that Image Builder created this image.
  - withImageTestsConfiguration
```
public Image withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)
```
    The image tests that ran when that Image Builder created this image.
    
    Parameters:
    
    imageTestsConfiguration - The image tests that ran when that Image Builder created 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 Image Builder created this image.
    
    Parameters:
    
    dateCreated - The date on which Image Builder created this image.
  - getDateCreated
```
public String getDateCreated()
```
    The date on which Image Builder created this image.
    
    Returns:
    
    The date on which Image Builder created this image.
  - withDateCreated
```
public Image withDateCreated(String dateCreated)
```
    The date on which Image Builder created this image.
    
    Parameters:
    
    dateCreated - The date on which Image Builder created this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputResources
```
public void setOutputResources(OutputResources outputResources)
```
    The output resources that Image Builder produces for this image.
    
    Parameters:
    
    outputResources - The output resources that Image Builder produces for this image.
  - getOutputResources
```
public OutputResources getOutputResources()
```
    The output resources that Image Builder produces for this image.
    
    Returns:
    
    The output resources that Image Builder produces for this image.
  - withOutputResources
```
public Image withOutputResources(OutputResources outputResources)
```
    The output resources that Image Builder produces for this image.
    
    Parameters:
    
    outputResources - The output resources that Image Builder produces for 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 that apply to this image.
    
    Returns:
    
    The tags that apply to this image.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags that apply to this image.
    
    Parameters:
    
    tags - The tags that apply to this image.
  - withTags
```
public Image withTags(Map<String,String> tags)
```
    The tags that apply to this image.
    
    Parameters:
    
    tags - The tags that apply to this 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.
  - setBuildType
```
public void setBuildType(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.
    See Also:
    
    BuildType
  - getBuildType
```
public String getBuildType()
```
    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:
    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
  - withBuildType
```
public Image withBuildType(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
  - withBuildType
```
public Image withBuildType(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
  - setImageSource
```
public void setImageSource(String imageSource)
```
    The origin of the base image that Image Builder used to build this image.
    
    Parameters:
    
    imageSource - The origin of the base image that Image Builder used to build this image.
    
    See Also:
    
    ImageSource
  - getImageSource
```
public String getImageSource()
```
    The origin of the base image that Image Builder used to build this image.
    
    Returns:
    
    The origin of the base image that Image Builder used to build this image.
    
    See Also:
    
    ImageSource
  - withImageSource
```
public Image withImageSource(String imageSource)
```
    The origin of the base image that Image Builder used to build this image.
    
    Parameters:
    
    imageSource - The origin of the base image that Image Builder used to build this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageSource
  - withImageSource
```
public Image withImageSource(ImageSource imageSource)
```
    The origin of the base image that Image Builder used to build this image.
    
    Parameters:
    
    imageSource - The origin of the base image that Image Builder used to build this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageSource
  - setScanState
```
public void setScanState(ImageScanState scanState)
```
    Contains information about the current state of scans for this image.
    
    Parameters:
    
    scanState - Contains information about the current state of scans for this image.
  - getScanState
```
public ImageScanState getScanState()
```
    Contains information about the current state of scans for this image.
    
    Returns:
    
    Contains information about the current state of scans for this image.
  - withScanState
```
public Image withScanState(ImageScanState scanState)
```
    Contains information about the current state of scans for this image.
    
    Parameters:
    
    scanState - Contains information about the current state of scans for this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageScanningConfiguration
```
public void setImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)
```
    Contains settings for vulnerability scans.
    
    Parameters:
    
    imageScanningConfiguration - Contains settings for vulnerability scans.
  - getImageScanningConfiguration
```
public ImageScanningConfiguration getImageScanningConfiguration()
```
    Contains settings for vulnerability scans.
    
    Returns:
    
    Contains settings for vulnerability scans.
  - withImageScanningConfiguration
```
public Image withImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)
```
    Contains settings for vulnerability scans.
    
    Parameters:
    
    imageScanningConfiguration - Contains settings for vulnerability scans.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeprecationTime
```
public void setDeprecationTime(Date deprecationTime)
```
    The time when deprecation occurs for an image resource. This can be a past or future date.
    
    Parameters:
    
    deprecationTime - The time when deprecation occurs for an image resource. This can be a past or future date.
  - getDeprecationTime
```
public Date getDeprecationTime()
```
    The time when deprecation occurs for an image resource. This can be a past or future date.
    
    Returns:
    
    The time when deprecation occurs for an image resource. This can be a past or future date.
  - withDeprecationTime
```
public Image withDeprecationTime(Date deprecationTime)
```
    The time when deprecation occurs for an image resource. This can be a past or future date.
    
    Parameters:
    
    deprecationTime - The time when deprecation occurs for an image resource. This can be a past or future date.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycleExecutionId
```
public void setLifecycleExecutionId(String lifecycleExecutionId)
```
    Identifies the last runtime instance of the lifecycle policy to take action on the image.
    
    Parameters:
    
    lifecycleExecutionId - Identifies the last runtime instance of the lifecycle policy to take action on the image.
  - getLifecycleExecutionId
```
public String getLifecycleExecutionId()
```
    Identifies the last runtime instance of the lifecycle policy to take action on the image.
    
    Returns:
    
    Identifies the last runtime instance of the lifecycle policy to take action on the image.
  - withLifecycleExecutionId
```
public Image withLifecycleExecutionId(String lifecycleExecutionId)
```
    Identifies the last runtime instance of the lifecycle policy to take action on the image.
    
    Parameters:
    
    lifecycleExecutionId - Identifies the last runtime instance of the lifecycle policy to take action on the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRole
```
public void setExecutionRole(String executionRole)
```
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
    
    Parameters:
    
    executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
  - getExecutionRole
```
public String getExecutionRole()
```
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
  - withExecutionRole
```
public Image withExecutionRole(String executionRole)
```
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
    
    Parameters:
    
    executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWorkflows
```
public List<WorkflowConfiguration> getWorkflows()
```
    Contains the build and test workflows that are associated with the image.
    
    Returns:
    
    Contains the build and test workflows that are associated with the image.
  - setWorkflows
```
public void setWorkflows(Collection<WorkflowConfiguration> workflows)
```
    Contains the build and test workflows that are associated with the image.
    
    Parameters:
    
    workflows - Contains the build and test workflows that are associated with the image.
  - withWorkflows
```
public Image withWorkflows(WorkflowConfiguration... workflows)
```
    Contains the build and test workflows that are associated with the image.
    
    NOTE: This method appends the values to the existing list (if any). Use setWorkflows(java.util.Collection) or withWorkflows(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    workflows - Contains the build and test workflows that are associated with the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWorkflows
```
public Image withWorkflows(Collection<WorkflowConfiguration> workflows)
```
    Contains the build and test workflows that are associated with the image.
    
    Parameters:
    
    workflows - Contains the build and test workflows that are associated with the image.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.780

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

setBuildType

getBuildType

withBuildType

withBuildType

setImageSource

getImageSource

withImageSource

withImageSource

setScanState

getScanState

withScanState

setImageScanningConfiguration

getImageScanningConfiguration