ContainerRecipe (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

A container recipe.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ContainerRecipe()

Constructors
Constructor and Description
`ContainerRecipe()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContainerRecipe`	`addTagsEntry(String key, String value)` Add a single Tags entry
`ContainerRecipe`	`clearTagsEntries()` Removes all the entries added into Tags.
`ContainerRecipe`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the container recipe.
`List<ComponentConfiguration>`	`getComponents()` Components for build and test that are included in the container recipe.
`String`	`getContainerType()` Specifies the type of container, such as Docker.
`String`	`getDateCreated()` The date when this container recipe was created.
`String`	`getDescription()` The description of the container recipe.
`String`	`getDockerfileTemplateData()` Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
`Boolean`	`getEncrypted()` A flag that indicates if the target container is encrypted.
`String`	`getKmsKeyId()` Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
`String`	`getName()` The name of the container recipe.
`String`	`getOwner()` The owner of the container recipe.
`String`	`getParentImage()` The source image for the container recipe.
`String`	`getPlatform()` The system platform for the container, such as Windows or Linux.
`Map<String,String>`	`getTags()` Tags that are attached to the container recipe.
`TargetContainerRepository`	`getTargetRepository()` The destination repository for the container image.
`String`	`getVersion()` The semantic version of the container recipe (<major>.<minor>.<patch>).
`String`	`getWorkingDirectory()` The working directory for use during build and test workflows.
`int`	`hashCode()`
`Boolean`	`isEncrypted()` A flag that indicates if the target container is encrypted.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the container recipe.
`void`	`setComponents(Collection<ComponentConfiguration> components)` Components for build and test that are included in the container recipe.
`void`	`setContainerType(String containerType)` Specifies the type of container, such as Docker.
`void`	`setDateCreated(String dateCreated)` The date when this container recipe was created.
`void`	`setDescription(String description)` The description of the container recipe.
`void`	`setDockerfileTemplateData(String dockerfileTemplateData)` Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
`void`	`setEncrypted(Boolean encrypted)` A flag that indicates if the target container is encrypted.
`void`	`setKmsKeyId(String kmsKeyId)` Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
`void`	`setName(String name)` The name of the container recipe.
`void`	`setOwner(String owner)` The owner of the container recipe.
`void`	`setParentImage(String parentImage)` The source image for the container recipe.
`void`	`setPlatform(String platform)` The system platform for the container, such as Windows or Linux.
`void`	`setTags(Map<String,String> tags)` Tags that are attached to the container recipe.
`void`	`setTargetRepository(TargetContainerRepository targetRepository)` The destination repository for the container image.
`void`	`setVersion(String version)` The semantic version of the container recipe (<major>.<minor>.<patch>).
`void`	`setWorkingDirectory(String workingDirectory)` The working directory for use during build and test workflows.
`String`	`toString()` Returns a string representation of this object.
`ContainerRecipe`	`withArn(String arn)` The Amazon Resource Name (ARN) of the container recipe.
`ContainerRecipe`	`withComponents(Collection<ComponentConfiguration> components)` Components for build and test that are included in the container recipe.
`ContainerRecipe`	`withComponents(ComponentConfiguration... components)` Components for build and test that are included in the container recipe.
`ContainerRecipe`	`withContainerType(ContainerType containerType)` Specifies the type of container, such as Docker.
`ContainerRecipe`	`withContainerType(String containerType)` Specifies the type of container, such as Docker.
`ContainerRecipe`	`withDateCreated(String dateCreated)` The date when this container recipe was created.
`ContainerRecipe`	`withDescription(String description)` The description of the container recipe.
`ContainerRecipe`	`withDockerfileTemplateData(String dockerfileTemplateData)` Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
`ContainerRecipe`	`withEncrypted(Boolean encrypted)` A flag that indicates if the target container is encrypted.
`ContainerRecipe`	`withKmsKeyId(String kmsKeyId)` Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
`ContainerRecipe`	`withName(String name)` The name of the container recipe.
`ContainerRecipe`	`withOwner(String owner)` The owner of the container recipe.
`ContainerRecipe`	`withParentImage(String parentImage)` The source image for the container recipe.
`ContainerRecipe`	`withPlatform(Platform platform)` The system platform for the container, such as Windows or Linux.
`ContainerRecipe`	`withPlatform(String platform)` The system platform for the container, such as Windows or Linux.
`ContainerRecipe`	`withTags(Map<String,String> tags)` Tags that are attached to the container recipe.
`ContainerRecipe`	`withTargetRepository(TargetContainerRepository targetRepository)` The destination repository for the container image.
`ContainerRecipe`	`withVersion(String version)` The semantic version of the container recipe (<major>.<minor>.<patch>).
`ContainerRecipe`	`withWorkingDirectory(String workingDirectory)` The working directory for use during build and test workflows.

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

- Constructor Detail
  - ContainerRecipe
```
public ContainerRecipe()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the container recipe.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the container recipe.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the container recipe.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container recipe.
  - withArn
```
public ContainerRecipe withArn(String arn)
```
    The Amazon Resource Name (ARN) of the container recipe.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the container recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainerType
```
public void setContainerType(String containerType)
```
    Specifies the type of container, such as Docker.
    
    Parameters:
    
    containerType - Specifies the type of container, such as Docker.
    
    See Also:
    
    ContainerType
  - getContainerType
```
public String getContainerType()
```
    Specifies the type of container, such as Docker.
    
    Returns:
    
    Specifies the type of container, such as Docker.
    
    See Also:
    
    ContainerType
  - withContainerType
```
public ContainerRecipe withContainerType(String containerType)
```
    Specifies the type of container, such as Docker.
    
    Parameters:
    
    containerType - Specifies the type of container, such as Docker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContainerType
  - withContainerType
```
public ContainerRecipe withContainerType(ContainerType containerType)
```
    Specifies the type of container, such as Docker.
    
    Parameters:
    
    containerType - Specifies the type of container, such as Docker.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContainerType
  - setName
```
public void setName(String name)
```
    The name of the container recipe.
    
    Parameters:
    
    name - The name of the container recipe.
  - getName
```
public String getName()
```
    The name of the container recipe.
    
    Returns:
    
    The name of the container recipe.
  - withName
```
public ContainerRecipe withName(String name)
```
    The name of the container recipe.
    
    Parameters:
    
    name - The name of the container 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 container recipe.
    
    Parameters:
    
    description - The description of the container recipe.
  - getDescription
```
public String getDescription()
```
    The description of the container recipe.
    
    Returns:
    
    The description of the container recipe.
  - withDescription
```
public ContainerRecipe withDescription(String description)
```
    The description of the container recipe.
    
    Parameters:
    
    description - The description of the container recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatform
```
public void setPlatform(String platform)
```
    The system platform for the container, such as Windows or Linux.
    
    Parameters:
    
    platform - The system platform for the container, such as Windows or Linux.
    
    See Also:
    
    Platform
  - getPlatform
```
public String getPlatform()
```
    The system platform for the container, such as Windows or Linux.
    
    Returns:
    
    The system platform for the container, such as Windows or Linux.
    
    See Also:
    
    Platform
  - withPlatform
```
public ContainerRecipe withPlatform(String platform)
```
    The system platform for the container, such as Windows or Linux.
    
    Parameters:
    
    platform - The system platform for the container, such as Windows or Linux.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Platform
  - withPlatform
```
public ContainerRecipe withPlatform(Platform platform)
```
    The system platform for the container, such as Windows or Linux.
    
    Parameters:
    
    platform - The system platform for the container, such as Windows or Linux.
    
    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 container recipe.
    
    Parameters:
    
    owner - The owner of the container recipe.
  - getOwner
```
public String getOwner()
```
    The owner of the container recipe.
    
    Returns:
    
    The owner of the container recipe.
  - withOwner
```
public ContainerRecipe withOwner(String owner)
```
    The owner of the container recipe.
    
    Parameters:
    
    owner - The owner of the container recipe.
    
    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 container recipe (<major>.<minor>.<patch>).
    
    Parameters:
    
    version - The semantic version of the container recipe (<major>.<minor>.<patch>).
  - getVersion
```
public String getVersion()
```
    The semantic version of the container recipe (<major>.<minor>.<patch>).
    
    Returns:
    
    The semantic version of the container recipe (<major>.<minor>.<patch>).
  - withVersion
```
public ContainerRecipe withVersion(String version)
```
    The semantic version of the container recipe (<major>.<minor>.<patch>).
    
    Parameters:
    
    version - The semantic version of the container recipe (<major>.<minor>.<patch>).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getComponents
```
public List<ComponentConfiguration> getComponents()
```
    Components for build and test that are included in the container recipe.
    
    Returns:
    
    Components for build and test that are included in the container recipe.
  - setComponents
```
public void setComponents(Collection<ComponentConfiguration> components)
```
    Components for build and test that are included in the container recipe.
    
    Parameters:
    
    components - Components for build and test that are included in the container recipe.
  - withComponents
```
public ContainerRecipe withComponents(ComponentConfiguration... components)
```
    Components for build and test that are included in the container recipe.
    
    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 - Components for build and test that are included in the container recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withComponents
```
public ContainerRecipe withComponents(Collection<ComponentConfiguration> components)
```
    Components for build and test that are included in the container recipe.
    
    Parameters:
    
    components - Components for build and test that are included in the container recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDockerfileTemplateData
```
public void setDockerfileTemplateData(String dockerfileTemplateData)
```
    Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
    
    Parameters:
    
    dockerfileTemplateData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
  - getDockerfileTemplateData
```
public String getDockerfileTemplateData()
```
    Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
    
    Returns:
    
    Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
  - withDockerfileTemplateData
```
public ContainerRecipe withDockerfileTemplateData(String dockerfileTemplateData)
```
    Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
    
    Parameters:
    
    dockerfileTemplateData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
    
    Parameters:
    
    kmsKeyId - Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
    
    Returns:
    
    Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
  - withKmsKeyId
```
public ContainerRecipe withKmsKeyId(String kmsKeyId)
```
    Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
    
    Parameters:
    
    kmsKeyId - Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncrypted
```
public void setEncrypted(Boolean encrypted)
```
    A flag that indicates if the target container is encrypted.
    
    Parameters:
    
    encrypted - A flag that indicates if the target container is encrypted.
  - getEncrypted
```
public Boolean getEncrypted()
```
    A flag that indicates if the target container is encrypted.
    
    Returns:
    
    A flag that indicates if the target container is encrypted.
  - withEncrypted
```
public ContainerRecipe withEncrypted(Boolean encrypted)
```
    A flag that indicates if the target container is encrypted.
    
    Parameters:
    
    encrypted - A flag that indicates if the target container is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEncrypted
```
public Boolean isEncrypted()
```
    A flag that indicates if the target container is encrypted.
    
    Returns:
    
    A flag that indicates if the target container is encrypted.
  - setParentImage
```
public void setParentImage(String parentImage)
```
    The source image for the container recipe.
    
    Parameters:
    
    parentImage - The source image for the container recipe.
  - getParentImage
```
public String getParentImage()
```
    The source image for the container recipe.
    
    Returns:
    
    The source image for the container recipe.
  - withParentImage
```
public ContainerRecipe withParentImage(String parentImage)
```
    The source image for the container recipe.
    
    Parameters:
    
    parentImage - The source image for the container recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateCreated
```
public void setDateCreated(String dateCreated)
```
    The date when this container recipe was created.
    
    Parameters:
    
    dateCreated - The date when this container recipe was created.
  - getDateCreated
```
public String getDateCreated()
```
    The date when this container recipe was created.
    
    Returns:
    
    The date when this container recipe was created.
  - withDateCreated
```
public ContainerRecipe withDateCreated(String dateCreated)
```
    The date when this container recipe was created.
    
    Parameters:
    
    dateCreated - The date when this container recipe was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Tags that are attached to the container recipe.
    
    Returns:
    
    Tags that are attached to the container recipe.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tags that are attached to the container recipe.
    
    Parameters:
    
    tags - Tags that are attached to the container recipe.
  - withTags
```
public ContainerRecipe withTags(Map<String,String> tags)
```
    Tags that are attached to the container recipe.
    
    Parameters:
    
    tags - Tags that are attached to the container recipe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ContainerRecipe addTagsEntry(String key,
                                    String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public ContainerRecipe 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 for use during build and test workflows.
    
    Parameters:
    
    workingDirectory - The working directory for use during build and test workflows.
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
    The working directory for use during build and test workflows.
    
    Returns:
    
    The working directory for use during build and test workflows.
  - withWorkingDirectory
```
public ContainerRecipe withWorkingDirectory(String workingDirectory)
```
    The working directory for use during build and test workflows.
    
    Parameters:
    
    workingDirectory - The working directory for use during build and test workflows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetRepository
```
public void setTargetRepository(TargetContainerRepository targetRepository)
```
    The destination repository for the container image.
    
    Parameters:
    
    targetRepository - The destination repository for the container image.
  - getTargetRepository
```
public TargetContainerRepository getTargetRepository()
```
    The destination repository for the container image.
    
    Returns:
    
    The destination repository for the container image.
  - withTargetRepository
```
public ContainerRecipe withTargetRepository(TargetContainerRepository targetRepository)
```
    The destination repository for the container image.
    
    Parameters:
    
    targetRepository - The destination repository for the container 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 ContainerRecipe 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.

Did this page help you?

Class ContainerRecipe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerRecipe

Method Detail

setArn

getArn

withArn

setContainerType

getContainerType

withContainerType

withContainerType

setName

getName

withName

setDescription

getDescription

withDescription

setPlatform

getPlatform

withPlatform

withPlatform

setOwner

getOwner

withOwner

setVersion

getVersion

withVersion

getComponents

setComponents

withComponents

withComponents

setDockerfileTemplateData

getDockerfileTemplateData

withDockerfileTemplateData

setKmsKeyId

getKmsKeyId

withKmsKeyId

setEncrypted

getEncrypted

withEncrypted

isEncrypted

setParentImage

getParentImage

withParentImage

setDateCreated

getDateCreated

withDateCreated

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setWorkingDirectory

getWorkingDirectory

withWorkingDirectory

setTargetRepository

getTargetRepository

withTargetRepository

toString

equals

hashCode

clone

marshall