@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateContainerRecipeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateContainerRecipeRequest() |
Modifier and Type | Method and Description |
---|---|
CreateContainerRecipeRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateContainerRecipeRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateContainerRecipeRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
List<ComponentConfiguration> |
getComponents()
Components for build and test that are included in the container recipe.
|
String |
getContainerType()
The type of container to create.
|
String |
getDescription()
The description of the container recipe.
|
String |
getDockerfileTemplateData()
The Dockerfile template used to build your image as an inline data blob.
|
String |
getDockerfileTemplateUri()
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
|
String |
getImageOsVersionOverride()
Specifies the operating system version for the base image.
|
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.
|
String |
getName()
The name of the container recipe.
|
String |
getParentImage()
The base image for the container recipe.
|
String |
getPlatformOverride()
Specifies the operating system platform when you use a custom base image.
|
String |
getSemanticVersion()
The semantic version of the container recipe.
|
Map<String,String> |
getTags()
Tags that are attached to the container recipe.
|
TargetContainerRepository |
getTargetRepository()
The destination repository for the container image.
|
String |
getWorkingDirectory()
The working directory for use during build and test workflows.
|
int |
hashCode() |
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
void |
setComponents(Collection<ComponentConfiguration> components)
Components for build and test that are included in the container recipe.
|
void |
setContainerType(String containerType)
The type of container to create.
|
void |
setDescription(String description)
The description of the container recipe.
|
void |
setDockerfileTemplateData(String dockerfileTemplateData)
The Dockerfile template used to build your image as an inline data blob.
|
void |
setDockerfileTemplateUri(String dockerfileTemplateUri)
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
|
void |
setImageOsVersionOverride(String imageOsVersionOverride)
Specifies the operating system version for the base image.
|
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.
|
void |
setName(String name)
The name of the container recipe.
|
void |
setParentImage(String parentImage)
The base image for the container recipe.
|
void |
setPlatformOverride(String platformOverride)
Specifies the operating system platform when you use a custom base image.
|
void |
setSemanticVersion(String semanticVersion)
The semantic version of the container recipe.
|
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 |
setWorkingDirectory(String workingDirectory)
The working directory for use during build and test workflows.
|
String |
toString()
Returns a string representation of this object.
|
CreateContainerRecipeRequest |
withClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
CreateContainerRecipeRequest |
withComponents(Collection<ComponentConfiguration> components)
Components for build and test that are included in the container recipe.
|
CreateContainerRecipeRequest |
withComponents(ComponentConfiguration... components)
Components for build and test that are included in the container recipe.
|
CreateContainerRecipeRequest |
withContainerType(ContainerType containerType)
The type of container to create.
|
CreateContainerRecipeRequest |
withContainerType(String containerType)
The type of container to create.
|
CreateContainerRecipeRequest |
withDescription(String description)
The description of the container recipe.
|
CreateContainerRecipeRequest |
withDockerfileTemplateData(String dockerfileTemplateData)
The Dockerfile template used to build your image as an inline data blob.
|
CreateContainerRecipeRequest |
withDockerfileTemplateUri(String dockerfileTemplateUri)
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
|
CreateContainerRecipeRequest |
withImageOsVersionOverride(String imageOsVersionOverride)
Specifies the operating system version for the base image.
|
CreateContainerRecipeRequest |
withInstanceConfiguration(InstanceConfiguration instanceConfiguration)
A group of options that can be used to configure an instance for building and testing container images.
|
CreateContainerRecipeRequest |
withKmsKeyId(String kmsKeyId)
Identifies which KMS key is used to encrypt the container image.
|
CreateContainerRecipeRequest |
withName(String name)
The name of the container recipe.
|
CreateContainerRecipeRequest |
withParentImage(String parentImage)
The base image for the container recipe.
|
CreateContainerRecipeRequest |
withPlatformOverride(Platform platformOverride)
Specifies the operating system platform when you use a custom base image.
|
CreateContainerRecipeRequest |
withPlatformOverride(String platformOverride)
Specifies the operating system platform when you use a custom base image.
|
CreateContainerRecipeRequest |
withSemanticVersion(String semanticVersion)
The semantic version of the container recipe.
|
CreateContainerRecipeRequest |
withTags(Map<String,String> tags)
Tags that are attached to the container recipe.
|
CreateContainerRecipeRequest |
withTargetRepository(TargetContainerRepository targetRepository)
The destination repository for the container image.
|
CreateContainerRecipeRequest |
withWorkingDirectory(String workingDirectory)
The working directory for use during build and test workflows.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setContainerType(String containerType)
The type of container to create.
containerType
- The type of container to create.ContainerType
public String getContainerType()
The type of container to create.
ContainerType
public CreateContainerRecipeRequest withContainerType(String containerType)
The type of container to create.
containerType
- The type of container to create.ContainerType
public CreateContainerRecipeRequest withContainerType(ContainerType containerType)
The type of container to create.
containerType
- The type of container to create.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 CreateContainerRecipeRequest 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 CreateContainerRecipeRequest withDescription(String description)
The description of the container recipe.
description
- The description of the container recipe.public void setSemanticVersion(String semanticVersion)
The semantic version of the container recipe. This version follows the semantic version syntax.
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.
semanticVersion
- The semantic version of the container recipe. This version follows the semantic version syntax. 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.
public String getSemanticVersion()
The semantic version of the container recipe. This version follows the semantic version syntax.
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.
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.
public CreateContainerRecipeRequest withSemanticVersion(String semanticVersion)
The semantic version of the container recipe. This version follows the semantic version syntax.
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.
semanticVersion
- The semantic version of the container recipe. This version follows the semantic version syntax. 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.
public List<ComponentConfiguration> getComponents()
Components for build and test 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)
Components for build and test 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
- Components for build and test 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 CreateContainerRecipeRequest withComponents(ComponentConfiguration... components)
Components for build and test 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
- Components for build and test 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 CreateContainerRecipeRequest withComponents(Collection<ComponentConfiguration> components)
Components for build and test 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
- Components for build and test 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 CreateContainerRecipeRequest 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)
The Dockerfile template used to build your image as an inline data blob.
dockerfileTemplateData
- The Dockerfile template used to build your image as an inline data blob.public String getDockerfileTemplateData()
The Dockerfile template used to build your image as an inline data blob.
public CreateContainerRecipeRequest withDockerfileTemplateData(String dockerfileTemplateData)
The Dockerfile template used to build your image as an inline data blob.
dockerfileTemplateData
- The Dockerfile template used to build your image as an inline data blob.public void setDockerfileTemplateUri(String dockerfileTemplateUri)
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
dockerfileTemplateUri
- The Amazon S3 URI for the Dockerfile that will be used to build your container image.public String getDockerfileTemplateUri()
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
public CreateContainerRecipeRequest withDockerfileTemplateUri(String dockerfileTemplateUri)
The Amazon S3 URI for the Dockerfile that will be used to build your container image.
dockerfileTemplateUri
- The Amazon S3 URI for the Dockerfile that will be used to build your container image.public void setPlatformOverride(String platformOverride)
Specifies the operating system platform when you use a custom base image.
platformOverride
- Specifies the operating system platform when you use a custom base image.Platform
public String getPlatformOverride()
Specifies the operating system platform when you use a custom base image.
Platform
public CreateContainerRecipeRequest withPlatformOverride(String platformOverride)
Specifies the operating system platform when you use a custom base image.
platformOverride
- Specifies the operating system platform when you use a custom base image.Platform
public CreateContainerRecipeRequest withPlatformOverride(Platform platformOverride)
Specifies the operating system platform when you use a custom base image.
platformOverride
- Specifies the operating system platform when you use a custom base image.Platform
public void setImageOsVersionOverride(String imageOsVersionOverride)
Specifies the operating system version for the base image.
imageOsVersionOverride
- Specifies the operating system version for the base image.public String getImageOsVersionOverride()
Specifies the operating system version for the base image.
public CreateContainerRecipeRequest withImageOsVersionOverride(String imageOsVersionOverride)
Specifies the operating system version for the base image.
imageOsVersionOverride
- Specifies the operating system version for the base image.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 CreateContainerRecipeRequest withParentImage(String parentImage)
The base image for the container recipe.
parentImage
- The base image for the container recipe.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 CreateContainerRecipeRequest withTags(Map<String,String> tags)
Tags that are attached to the container recipe.
tags
- Tags that are attached to the container recipe.public CreateContainerRecipeRequest addTagsEntry(String key, String value)
public CreateContainerRecipeRequest 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 CreateContainerRecipeRequest 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 CreateContainerRecipeRequest withTargetRepository(TargetContainerRepository targetRepository)
The destination repository for the container image.
targetRepository
- The destination repository for the container image.public void setKmsKeyId(String kmsKeyId)
Identifies which KMS key is used to encrypt the container image.
kmsKeyId
- Identifies which KMS key is used to encrypt the container image.public String getKmsKeyId()
Identifies which KMS key is used to encrypt the container image.
public CreateContainerRecipeRequest withKmsKeyId(String kmsKeyId)
Identifies which KMS key is used to encrypt the container image.
kmsKeyId
- Identifies which KMS key is used to encrypt the container image.public void setClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information,
see Ensuring
idempotency in the Amazon EC2 API Reference.public String getClientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
public CreateContainerRecipeRequest withClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information,
see Ensuring
idempotency in the Amazon EC2 API Reference.public String toString()
toString
in class Object
Object.toString()
public CreateContainerRecipeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()