Class Image
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the image.static Image.Builder
builder()
final BuildType
Indicates the type of build that created this image.final String
Indicates the type of build that created this image.final ContainerRecipe
For container images, this is the container recipe that Image Builder used to create the image.final String
The date on which Image Builder created this image.final Instant
The time when deprecation occurs for an image resource.The distribution configuration that Image Builder used to create this image.final Boolean
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Workflows property.final ImageRecipe
For images that distribute an AMI, this is the image recipe that Image Builder used to create the image.Contains settings for vulnerability scans.final ImageSource
The origin of the base image that Image Builder used to build this image.final String
The origin of the base image that Image Builder used to build this image.final ImageTestsConfiguration
The image tests that ran when that Image Builder created this image.The infrastructure that Image Builder used to create this image.final String
Identifies the last runtime instance of the lifecycle policy to take action on the image.final String
name()
The name of the image.final String
The operating system version for instances that launch from this image.final OutputResources
The output resources that Image Builder produces for this image.final Platform
platform()
The image operating system platform, such as Linux or Windows.final String
The image operating system platform, such as Linux or Windows.final ImageScanState
Contains information about the current state of scans for this image.static Class
<? extends Image.Builder> final String
The Amazon Resource Name (ARN) of the image pipeline that created this image.final String
The name of the image pipeline that created this image.final ImageState
state()
The state of the image.tags()
The tags that apply to this image.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ImageType
type()
Specifies whether this image produces an AMI or a container image.final String
Specifies whether this image produces an AMI or a container image.final String
version()
The semantic version of the image.final List
<WorkflowConfiguration> Contains the build and test workflows that are associated with the image.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Specifies whether this image produces an AMI or a container image.
If the service returns an enum value that is not available in the current SDK version,
type
will returnImageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies whether this image produces an AMI or a container image.
- See Also:
-
typeAsString
Specifies whether this image produces an AMI or a container image.
If the service returns an enum value that is not available in the current SDK version,
type
will returnImageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies whether this image produces an AMI or a container image.
- See Also:
-
name
The name of the image.
- Returns:
- The name of the image.
-
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
The image operating system platform, such as Linux or Windows.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The image operating system platform, such as Linux or Windows.
- See Also:
-
platformAsString
The image operating system platform, such as Linux or Windows.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The image operating system platform, such as Linux or Windows.
- See Also:
-
enhancedImageMetadataEnabled
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.
-
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:
- The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
-
state
The state of the image.
- Returns:
- The state of the image.
-
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:
- 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.
-
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:
- 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.
-
sourcePipelineName
The name of the image pipeline that created this image.
- Returns:
- The name of the image pipeline that created this image.
-
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
The infrastructure that Image Builder used to create this image.
- Returns:
- The infrastructure that Image Builder used to create this image.
-
distributionConfiguration
The distribution configuration that Image Builder used to create this image.
- Returns:
- The distribution configuration that Image Builder used to create this image.
-
imageTestsConfiguration
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.
-
dateCreated
The date on which Image Builder created this image.
- Returns:
- The date on which Image Builder created this image.
-
outputResources
The output resources that Image Builder produces for this image.
- Returns:
- The output resources that Image Builder produces for 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 theisEmpty()
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
The tags that apply to this 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 that apply to this image.
-
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 returnBuildType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombuildTypeAsString()
.- 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:
-
-
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 returnBuildType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombuildTypeAsString()
.- 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:
-
-
imageSource
The origin of the base image that Image Builder used to build this image.
If the service returns an enum value that is not available in the current SDK version,
imageSource
will returnImageSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimageSourceAsString()
.- Returns:
- The origin of the base image that Image Builder used to build this image.
- See Also:
-
imageSourceAsString
The origin of the base image that Image Builder used to build this image.
If the service returns an enum value that is not available in the current SDK version,
imageSource
will returnImageSource.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimageSourceAsString()
.- Returns:
- The origin of the base image that Image Builder used to build this image.
- See Also:
-
scanState
Contains information about the current state of scans for this image.
- Returns:
- Contains information about the current state of scans for this image.
-
imageScanningConfiguration
Contains settings for vulnerability scans.
- Returns:
- Contains settings for vulnerability scans.
-
deprecationTime
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.
-
lifecycleExecutionId
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.
-
executionRole
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.
-
hasWorkflows
public final boolean hasWorkflows()For responses, this returns true if the service returned a value for the Workflows property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
workflows
Contains the build and test workflows that are associated with 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
hasWorkflows()
method.- Returns:
- Contains the build and test workflows that are associated with the image.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Image.Builder,
Image> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-