ImageRecipe (AWS Java SDK :: Services :: Imagebuilder 2.20.150 API)

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ImageRecipe.Builder,ImageRecipe>

@Generated(value="software.amazon.awssdk:codegen")
public final class ImageRecipe
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImageRecipe.Builder,ImageRecipe>

An image recipe.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImageRecipe.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdditionalInstanceConfiguration`	`additionalInstanceConfiguration()` Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
`String`	`arn()` The Amazon Resource Name (ARN) of the image recipe.
`List<InstanceBlockDeviceMapping>`	`blockDeviceMappings()` The block device mappings to apply when creating images from this recipe.
`static ImageRecipe.Builder`	`builder()`
`List<ComponentConfiguration>`	`components()` The components that are included in the image recipe.
`String`	`dateCreated()` The date on which this image recipe was created.
`String`	`description()` The description of the image recipe.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBlockDeviceMappings()` For responses, this returns true if the service returned a value for the BlockDeviceMappings property.
`boolean`	`hasComponents()` For responses, this returns true if the service returned a value for the Components property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()` The name of the image recipe.
`String`	`owner()` The owner of the image recipe.
`String`	`parentImage()` The base image of the image recipe.
`Platform`	`platform()` The platform of the image recipe.
`String`	`platformAsString()` The platform of the image recipe.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ImageRecipe.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags of the image recipe.
`ImageRecipe.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ImageType`	`type()` Specifies which type of image is created by the recipe - an AMI or a container image.
`String`	`typeAsString()` Specifies which type of image is created by the recipe - an AMI or a container image.
`String`	`version()` The version of the image recipe.
`String`	`workingDirectory()` The working directory to be used during build and test workflows.

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

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

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the image recipe.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the image recipe.
  - type
```
public final ImageType 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 return ImageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies which type of image is created by the recipe - an AMI or a container image.
    
    See Also:
    
    ImageType
  - typeAsString
```
public final String 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 return ImageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies which type of image is created by the recipe - an AMI or a container image.
    
    See Also:
    
    ImageType
  - name
```
public final String name()
```
    The name of the image recipe.
    
    Returns:
    
    The name of the image recipe.
  - description
```
public final String description()
```
    The description of the image recipe.
    
    Returns:
    
    The description of the image recipe.
  - platform
```
public final Platform 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 return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The platform of the image recipe.
    
    See Also:
    
    Platform
  - platformAsString
```
public final String 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 return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The platform of the image recipe.
    
    See Also:
    
    Platform
  - owner
```
public final String owner()
```
    The owner of the image recipe.
    
    Returns:
    
    The owner of the image recipe.
  - version
```
public final String 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 the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - components
```
public final List<ComponentConfiguration> 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
```
public final String 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 the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - blockDeviceMappings
```
public final List<InstanceBlockDeviceMapping> 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
```
public final String 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 the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags of the image 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
```
public final String 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
```
public final AdditionalInstanceConfiguration 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
```
public ImageRecipe.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImageRecipe.Builder,ImageRecipe>
  - builder
```
public static ImageRecipe.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImageRecipe.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ImageRecipe

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

type

typeAsString

name

description

platform

platformAsString

owner

version

hasComponents

components

parentImage

hasBlockDeviceMappings

blockDeviceMappings

dateCreated

hasTags

tags

workingDirectory

additionalInstanceConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields