@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ContainerRecipe extends Object implements Serializable, Cloneable, StructuredPojo
A container recipe.
Constructor and Description |
---|
ContainerRecipe() |
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()
Build and test components 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.
|
InstanceConfiguration |
getInstanceConfiguration()
A group of options that can be used to configure an instance for building and testing container images.
|
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 base 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.
|
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)
Build and test components 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 |
setInstanceConfiguration(InstanceConfiguration instanceConfiguration)
A group of options that can be used to configure an instance for building and testing container images.
|
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 base 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.
|
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)
Build and test components that are included in the container recipe.
|
ContainerRecipe |
withComponents(ComponentConfiguration... components)
Build and test components 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 |
withInstanceConfiguration(InstanceConfiguration instanceConfiguration)
A group of options that can be used to configure an instance for building and testing container images.
|
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 base 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.
|
ContainerRecipe |
withWorkingDirectory(String workingDirectory)
The working directory for use during build and test workflows.
|
public void setArn(String arn)
The Amazon Resource Name (ARN) of the container recipe.
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.
arn
- The Amazon Resource Name (ARN) of the container recipe. 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.
public String getArn()
The Amazon Resource Name (ARN) of the container recipe.
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.
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.
public ContainerRecipe withArn(String arn)
The Amazon Resource Name (ARN) of the container recipe.
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.
arn
- The Amazon Resource Name (ARN) of the container recipe. 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.
public void setContainerType(String containerType)
Specifies the type of container, such as Docker.
containerType
- Specifies the type of container, such as Docker.ContainerType
public String getContainerType()
Specifies the type of container, such as Docker.
ContainerType
public ContainerRecipe withContainerType(String containerType)
Specifies the type of container, such as Docker.
containerType
- Specifies the type of container, such as Docker.ContainerType
public ContainerRecipe withContainerType(ContainerType containerType)
Specifies the type of container, such as Docker.
containerType
- Specifies the type of container, such as Docker.ContainerType
public void setName(String name)
The name of the container recipe.
name
- The name of the container recipe.public String getName()
The name of the container recipe.
public ContainerRecipe withName(String name)
The name of the container recipe.
name
- The name of the container recipe.public void setDescription(String description)
The description of the container recipe.
description
- The description of the container recipe.public String getDescription()
The description of the container recipe.
public ContainerRecipe withDescription(String description)
The description of the container recipe.
description
- The description of the container recipe.public void setPlatform(String platform)
The system platform for the container, such as Windows or Linux.
platform
- The system platform for the container, such as Windows or Linux.Platform
public String getPlatform()
The system platform for the container, such as Windows or Linux.
Platform
public ContainerRecipe withPlatform(String platform)
The system platform for the container, such as Windows or Linux.
platform
- The system platform for the container, such as Windows or Linux.Platform
public ContainerRecipe withPlatform(Platform platform)
The system platform for the container, such as Windows or Linux.
platform
- The system platform for the container, such as Windows or Linux.Platform
public void setOwner(String owner)
The owner of the container recipe.
owner
- The owner of the container recipe.public String getOwner()
The owner of the container recipe.
public ContainerRecipe withOwner(String owner)
The owner of the container recipe.
owner
- The owner of the container recipe.public void setVersion(String version)
The semantic version of the container recipe.
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.
version
- The semantic version of the container recipe. 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.
public String getVersion()
The semantic version of the container recipe.
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.
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.
public ContainerRecipe withVersion(String version)
The semantic version of the container recipe.
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.
version
- The semantic version of the container recipe. 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.
public List<ComponentConfiguration> getComponents()
Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
public void setComponents(Collection<ComponentConfiguration> components)
Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
components
- Build and test components that are included in the container recipe. Recipes require a minimum of one
build component, and can have a maximum of 20 build and test components in any combination.public ContainerRecipe withComponents(ComponentConfiguration... components)
Build and test components that are included in the container 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.
components
- Build and test components that are included in the container recipe. Recipes require a minimum of one
build component, and can have a maximum of 20 build and test components in any combination.public ContainerRecipe withComponents(Collection<ComponentConfiguration> components)
Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
components
- Build and test components that are included in the container recipe. Recipes require a minimum of one
build component, and can have a maximum of 20 build and test components in any combination.public void setInstanceConfiguration(InstanceConfiguration instanceConfiguration)
A group of options that can be used to configure an instance for building and testing container images.
instanceConfiguration
- A group of options that can be used to configure an instance for building and testing container images.public InstanceConfiguration getInstanceConfiguration()
A group of options that can be used to configure an instance for building and testing container images.
public ContainerRecipe withInstanceConfiguration(InstanceConfiguration instanceConfiguration)
A group of options that can be used to configure an instance for building and testing container images.
instanceConfiguration
- A group of options that can be used to configure an instance for building and testing container images.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.
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.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.
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.
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.public void setKmsKeyId(String kmsKeyId)
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
kmsKeyId
- Identifies which KMS key is used to encrypt the container image for distribution to the target Region.public String getKmsKeyId()
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
public ContainerRecipe withKmsKeyId(String kmsKeyId)
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
kmsKeyId
- Identifies which KMS key is used to encrypt the container image for distribution to the target Region.public void setEncrypted(Boolean encrypted)
A flag that indicates if the target container is encrypted.
encrypted
- A flag that indicates if the target container is encrypted.public Boolean getEncrypted()
A flag that indicates if the target container is encrypted.
public ContainerRecipe withEncrypted(Boolean encrypted)
A flag that indicates if the target container is encrypted.
encrypted
- A flag that indicates if the target container is encrypted.public Boolean isEncrypted()
A flag that indicates if the target container is encrypted.
public void setParentImage(String parentImage)
The base image for the container recipe.
parentImage
- The base image for the container recipe.public String getParentImage()
The base image for the container recipe.
public ContainerRecipe withParentImage(String parentImage)
The base image for the container recipe.
parentImage
- The base image for the container recipe.public void setDateCreated(String dateCreated)
The date when this container recipe was created.
dateCreated
- The date when this container recipe was created.public String getDateCreated()
The date when this container recipe was created.
public ContainerRecipe withDateCreated(String dateCreated)
The date when this container recipe was created.
dateCreated
- The date when this container recipe was created.public Map<String,String> getTags()
Tags that are attached to the container recipe.
public void setTags(Map<String,String> tags)
Tags that are attached to the container recipe.
tags
- Tags that are attached to the container recipe.public ContainerRecipe withTags(Map<String,String> tags)
Tags that are attached to the container recipe.
tags
- Tags that are attached to the container recipe.public ContainerRecipe addTagsEntry(String key, String value)
public ContainerRecipe clearTagsEntries()
public void setWorkingDirectory(String workingDirectory)
The working directory for use during build and test workflows.
workingDirectory
- The working directory for use during build and test workflows.public String getWorkingDirectory()
The working directory for use during build and test workflows.
public ContainerRecipe withWorkingDirectory(String workingDirectory)
The working directory for use during build and test workflows.
workingDirectory
- The working directory for use during build and test workflows.public void setTargetRepository(TargetContainerRepository targetRepository)
The destination repository for the container image.
targetRepository
- The destination repository for the container image.public TargetContainerRepository getTargetRepository()
The destination repository for the container image.
public ContainerRecipe withTargetRepository(TargetContainerRepository targetRepository)
The destination repository for the container image.
targetRepository
- The destination repository for the container image.public String toString()
toString
in class Object
Object.toString()
public ContainerRecipe clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.