ImageRecipe (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

An image recipe.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ImageRecipe()

Constructors
Constructor and Description
`ImageRecipe()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImageRecipe`	`addTagsEntry(String key, String value)` Add a single Tags entry
`ImageRecipe`	`clearTagsEntries()` Removes all the entries added into Tags.
`ImageRecipe`	`clone()`
`boolean`	`equals(Object obj)`
`AdditionalInstanceConfiguration`	`getAdditionalInstanceConfiguration()` Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
`String`	`getArn()` The Amazon Resource Name (ARN) of the image recipe.
`List<InstanceBlockDeviceMapping>`	`getBlockDeviceMappings()` The block device mappings to apply when creating images from this recipe.
`List<ComponentConfiguration>`	`getComponents()` The components that are included in the image recipe.
`String`	`getDateCreated()` The date on which this image recipe was created.
`String`	`getDescription()` The description of the image recipe.
`String`	`getName()` The name of the image recipe.
`String`	`getOwner()` The owner of the image recipe.
`String`	`getParentImage()` The base image of the image recipe.
`String`	`getPlatform()` The platform of the image recipe.
`Map<String,String>`	`getTags()` The tags of the image recipe.
`String`	`getType()` Specifies which type of image is created by the recipe - an AMI or a container image.
`String`	`getVersion()` The version of the image recipe.
`String`	`getWorkingDirectory()` The working directory to be used during build and test workflows.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)` Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the image recipe.
`void`	`setBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)` The block device mappings to apply when creating images from this recipe.
`void`	`setComponents(Collection<ComponentConfiguration> components)` The components that are included in the image recipe.
`void`	`setDateCreated(String dateCreated)` The date on which this image recipe was created.
`void`	`setDescription(String description)` The description of the image recipe.
`void`	`setName(String name)` The name of the image recipe.
`void`	`setOwner(String owner)` The owner of the image recipe.
`void`	`setParentImage(String parentImage)` The base image of the image recipe.
`void`	`setPlatform(String platform)` The platform of the image recipe.
`void`	`setTags(Map<String,String> tags)` The tags of the image recipe.
`void`	`setType(String type)` Specifies which type of image is created by the recipe - an AMI or a container image.
`void`	`setVersion(String version)` The version of the image recipe.
`void`	`setWorkingDirectory(String workingDirectory)` The working directory to be used during build and test workflows.
`String`	`toString()` Returns a string representation of this object.
`ImageRecipe`	`withAdditionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)` Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
`ImageRecipe`	`withArn(String arn)` The Amazon Resource Name (ARN) of the image recipe.
`ImageRecipe`	`withBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)` The block device mappings to apply when creating images from this recipe.
`ImageRecipe`	`withBlockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)` The block device mappings to apply when creating images from this recipe.
`ImageRecipe`	`withComponents(Collection<ComponentConfiguration> components)` The components that are included in the image recipe.
`ImageRecipe`	`withComponents(ComponentConfiguration... components)` The components that are included in the image recipe.
`ImageRecipe`	`withDateCreated(String dateCreated)` The date on which this image recipe was created.
`ImageRecipe`	`withDescription(String description)` The description of the image recipe.
`ImageRecipe`	`withName(String name)` The name of the image recipe.
`ImageRecipe`	`withOwner(String owner)` The owner of the image recipe.
`ImageRecipe`	`withParentImage(String parentImage)` The base image of the image recipe.
`ImageRecipe`	`withPlatform(Platform platform)` The platform of the image recipe.
`ImageRecipe`	`withPlatform(String platform)` The platform of the image recipe.
`ImageRecipe`	`withTags(Map<String,String> tags)` The tags of the image recipe.
`ImageRecipe`	`withType(ImageType type)` Specifies which type of image is created by the recipe - an AMI or a container image.
`ImageRecipe`	`withType(String type)` Specifies which type of image is created by the recipe - an AMI or a container image.
`ImageRecipe`	`withVersion(String version)` The version of the image recipe.
`ImageRecipe`	`withWorkingDirectory(String workingDirectory)` The working directory to be used during build and test workflows.

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

- Constructor Detail
  - ImageRecipe
```
public ImageRecipe()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the image recipe.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the image recipe.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the image recipe.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the image recipe.
  - withArn
```
public ImageRecipe withArn(String arn)
```
    The Amazon Resource Name (ARN) of the image recipe.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Specifies which type of image is created by the recipe - an AMI or a container image.
    
    Parameters:
    
    type - Specifies which type of image is created by the recipe - an AMI or a container image.
    
    See Also:
    
    ImageType
  - getType
```
public String getType()
```
    Specifies which type of image is created by the recipe - an AMI or a container image.
    
    Returns:
    
    Specifies which type of image is created by the recipe - an AMI or a container image.
    
    See Also:
    
    ImageType
  - withType
```
public ImageRecipe withType(String type)
```
    Specifies which type of image is created by the recipe - an AMI or a container image.
    
    Parameters:
    
    type - Specifies which type of image is created by the recipe - 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 ImageRecipe withType(ImageType type)
```
    Specifies which type of image is created by the recipe - an AMI or a container image.
    
    Parameters:
    
    type - Specifies which type of image is created by the recipe - 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 recipe.
    
    Parameters:
    
    name - The name of the image recipe.
  - getName
```
public String getName()
```
    The name of the image recipe.
    
    Returns:
    
    The name of the image recipe.
  - withName
```
public ImageRecipe withName(String name)
```
    The name of the image recipe.
    
    Parameters:
    
    name - The name of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the image recipe.
    
    Parameters:
    
    description - The description of the image recipe.
  - getDescription
```
public String getDescription()
```
    The description of the image recipe.
    
    Returns:
    
    The description of the image recipe.
  - withDescription
```
public ImageRecipe withDescription(String description)
```
    The description of the image recipe.
    
    Parameters:
    
    description - The description of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatform
```
public void setPlatform(String platform)
```
    The platform of the image recipe.
    
    Parameters:
    
    platform - The platform of the image recipe.
    
    See Also:
    
    Platform
  - getPlatform
```
public String getPlatform()
```
    The platform of the image recipe.
    
    Returns:
    
    The platform of the image recipe.
    
    See Also:
    
    Platform
  - withPlatform
```
public ImageRecipe withPlatform(String platform)
```
    The platform of the image recipe.
    
    Parameters:
    
    platform - The platform of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform
  - withPlatform
```
public ImageRecipe withPlatform(Platform platform)
```
    The platform of the image recipe.
    
    Parameters:
    
    platform - The platform of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform
  - setOwner
```
public void setOwner(String owner)
```
    The owner of the image recipe.
    
    Parameters:
    
    owner - The owner of the image recipe.
  - getOwner
```
public String getOwner()
```
    The owner of the image recipe.
    
    Returns:
    
    The owner of the image recipe.
  - withOwner
```
public ImageRecipe withOwner(String owner)
```
    The owner of the image recipe.
    
    Parameters:
    
    owner - The owner of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version of the image recipe.
    
    Parameters:
    
    version - The version of the image recipe.
  - getVersion
```
public String getVersion()
```
    The version of the image recipe.
    
    Returns:
    
    The version of the image recipe.
  - withVersion
```
public ImageRecipe withVersion(String version)
```
    The version of the image recipe.
    
    Parameters:
    
    version - The version of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getComponents
```
public List<ComponentConfiguration> getComponents()
```
    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.
    
    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.
  - setComponents
```
public void setComponents(Collection<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.
    
    Parameters:
    
    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.
  - withComponents
```
public ImageRecipe withComponents(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setComponents(java.util.Collection) or withComponents(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withComponents
```
public ImageRecipe withComponents(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParentImage
```
public void setParentImage(String parentImage)
```
    The base image of the image recipe.
    
    Parameters:
    
    parentImage - The base image of the image recipe.
  - getParentImage
```
public String getParentImage()
```
    The base image of the image recipe.
    
    Returns:
    
    The base image of the image recipe.
  - withParentImage
```
public ImageRecipe withParentImage(String parentImage)
```
    The base image of the image recipe.
    
    Parameters:
    
    parentImage - The base image of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBlockDeviceMappings
```
public List<InstanceBlockDeviceMapping> getBlockDeviceMappings()
```
    The block device mappings to apply when creating images from this recipe.
    
    Returns:
    
    The block device mappings to apply when creating images from this recipe.
  - setBlockDeviceMappings
```
public void setBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)
```
    The block device mappings to apply when creating images from this recipe.
    
    Parameters:
    
    blockDeviceMappings - The block device mappings to apply when creating images from this recipe.
  - withBlockDeviceMappings
```
public ImageRecipe withBlockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)
```
    The block device mappings to apply when creating images from this recipe.
    
    NOTE: This method appends the values to the existing list (if any). Use setBlockDeviceMappings(java.util.Collection) or withBlockDeviceMappings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    blockDeviceMappings - The block device mappings to apply when creating images from this recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBlockDeviceMappings
```
public ImageRecipe withBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)
```
    The block device mappings to apply when creating images from this recipe.
    
    Parameters:
    
    blockDeviceMappings - The block device mappings to apply when creating images from this recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateCreated
```
public void setDateCreated(String dateCreated)
```
    The date on which this image recipe was created.
    
    Parameters:
    
    dateCreated - The date on which this image recipe was created.
  - getDateCreated
```
public String getDateCreated()
```
    The date on which this image recipe was created.
    
    Returns:
    
    The date on which this image recipe was created.
  - withDateCreated
```
public ImageRecipe withDateCreated(String dateCreated)
```
    The date on which this image recipe was created.
    
    Parameters:
    
    dateCreated - The date on which this image recipe was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags of the image recipe.
    
    Returns:
    
    The tags of the image recipe.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags of the image recipe.
    
    Parameters:
    
    tags - The tags of the image recipe.
  - withTags
```
public ImageRecipe withTags(Map<String,String> tags)
```
    The tags of the image recipe.
    
    Parameters:
    
    tags - The tags of the image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ImageRecipe addTagsEntry(String key,
                                String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public ImageRecipe clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkingDirectory
```
public void setWorkingDirectory(String workingDirectory)
```
    The working directory to be used during build and test workflows.
    
    Parameters:
    
    workingDirectory - The working directory to be used during build and test workflows.
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
    The working directory to be used during build and test workflows.
    
    Returns:
    
    The working directory to be used during build and test workflows.
  - withWorkingDirectory
```
public ImageRecipe withWorkingDirectory(String workingDirectory)
```
    The working directory to be used during build and test workflows.
    
    Parameters:
    
    workingDirectory - The working directory to be used during build and test workflows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdditionalInstanceConfiguration
```
public void setAdditionalInstanceConfiguration(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.
    
    Parameters:
    
    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.
  - getAdditionalInstanceConfiguration
```
public AdditionalInstanceConfiguration getAdditionalInstanceConfiguration()
```
    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.
  - withAdditionalInstanceConfiguration
```
public ImageRecipe withAdditionalInstanceConfiguration(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.
    
    Parameters:
    
    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:
    
    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 ImageRecipe 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 ImageRecipe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageRecipe

Method Detail

setArn

getArn

withArn

setType

getType

withType

withType

setName

getName

withName

setDescription

getDescription

withDescription

setPlatform

getPlatform

withPlatform

withPlatform

setOwner

getOwner

withOwner

setVersion

getVersion

withVersion

getComponents

setComponents

withComponents

withComponents

setParentImage

getParentImage

withParentImage

getBlockDeviceMappings

setBlockDeviceMappings

withBlockDeviceMappings

withBlockDeviceMappings

setDateCreated

getDateCreated

withDateCreated

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setWorkingDirectory

getWorkingDirectory

withWorkingDirectory

setAdditionalInstanceConfiguration

getAdditionalInstanceConfiguration

withAdditionalInstanceConfiguration

toString

equals

hashCode

clone

marshall