Class ImageRecipe
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ImageRecipe.Builder,
ImageRecipe>
An image recipe.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionBefore you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.final String
arn()
The Amazon Resource Name (ARN) of the image recipe.final List
<InstanceBlockDeviceMapping> The block device mappings to apply when creating images from this recipe.static ImageRecipe.Builder
builder()
final List
<ComponentConfiguration> The components that are included in the image recipe.final String
The date on which this image recipe was created.final String
The description of the image recipe.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the BlockDeviceMappings property.final boolean
For responses, this returns true if the service returned a value for the Components property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The name of the image recipe.final String
owner()
The owner of the image recipe.final String
The base image of the image recipe.final Platform
platform()
The platform of the image recipe.final String
The platform of the image recipe.static Class
<? extends ImageRecipe.Builder> tags()
The tags of the image recipe.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 which type of image is created by the recipe - an AMI or a container image.final String
Specifies which type of image is created by the recipe - an AMI or a container image.final String
version()
The version of the image recipe.final String
The working directory to be used during build and test workflows.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the image recipe.
- Returns:
- The Amazon Resource Name (ARN) of the image recipe.
-
type
Specifies which type of image is created by the recipe - 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 which type of image is created by the recipe - an AMI or a container image.
- See Also:
-
typeAsString
Specifies which type of image is created by the recipe - 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 which type of image is created by the recipe - an AMI or a container image.
- See Also:
-
name
The name of the image recipe.
- Returns:
- The name of the image recipe.
-
description
The description of the image recipe.
- Returns:
- The description of the image recipe.
-
platform
The platform of the image recipe.
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 platform of the image recipe.
- See Also:
-
platformAsString
The platform of the image recipe.
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 platform of the image recipe.
- See Also:
-
owner
The owner of the image recipe.
- Returns:
- The owner of the image recipe.
-
version
The version of the image recipe.
- Returns:
- The version of the image recipe.
-
hasComponents
public final boolean hasComponents()For responses, this returns true if the service returned a value for the Components 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. -
components
The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
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
hasComponents()
method.- Returns:
- The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
-
parentImage
The base image of the image recipe.
- Returns:
- The base image of the image recipe.
-
hasBlockDeviceMappings
public final boolean hasBlockDeviceMappings()For responses, this returns true if the service returned a value for the BlockDeviceMappings 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. -
blockDeviceMappings
The block device mappings to apply when creating images from this recipe.
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
hasBlockDeviceMappings()
method.- Returns:
- The block device mappings to apply when creating images from this recipe.
-
dateCreated
The date on which this image recipe was created.
- Returns:
- The date on which this image recipe was created.
-
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 of the image recipe.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tags of the image recipe.
-
workingDirectory
The working directory to be used during build and test workflows.
- Returns:
- The working directory to be used during build and test workflows.
-
additionalInstanceConfiguration
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
- Returns:
- Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
-
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<ImageRecipe.Builder,
ImageRecipe> - 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
-