@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateImageRecipeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
CreateImageRecipeRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateImageRecipeRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateImageRecipeRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateImageRecipeRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
AdditionalInstanceConfiguration |
getAdditionalInstanceConfiguration()
Specify additional settings and launch scripts for your build instances.
|
List<InstanceBlockDeviceMapping> |
getBlockDeviceMappings()
The block device mappings of the image recipe.
|
String |
getClientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
List<ComponentConfiguration> |
getComponents()
The components included in the image recipe.
|
String |
getDescription()
The description of the image recipe.
|
String |
getName()
The name of the image recipe.
|
String |
getParentImage()
The base image of the image recipe.
|
String |
getSemanticVersion()
The semantic version of the image recipe.
|
Map<String,String> |
getTags()
The tags of the image recipe.
|
String |
getWorkingDirectory()
The working directory used during build and test workflows.
|
int |
hashCode() |
void |
setAdditionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)
Specify additional settings and launch scripts for your build instances.
|
void |
setBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)
The block device mappings of the image recipe.
|
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
void |
setComponents(Collection<ComponentConfiguration> components)
The components included in the image recipe.
|
void |
setDescription(String description)
The description of the image recipe.
|
void |
setName(String name)
The name of the image recipe.
|
void |
setParentImage(String parentImage)
The base image of the image recipe.
|
void |
setSemanticVersion(String semanticVersion)
The semantic version of the image recipe.
|
void |
setTags(Map<String,String> tags)
The tags of the image recipe.
|
void |
setWorkingDirectory(String workingDirectory)
The working directory used during build and test workflows.
|
String |
toString()
Returns a string representation of this object.
|
CreateImageRecipeRequest |
withAdditionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)
Specify additional settings and launch scripts for your build instances.
|
CreateImageRecipeRequest |
withBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)
The block device mappings of the image recipe.
|
CreateImageRecipeRequest |
withBlockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)
The block device mappings of the image recipe.
|
CreateImageRecipeRequest |
withClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
CreateImageRecipeRequest |
withComponents(Collection<ComponentConfiguration> components)
The components included in the image recipe.
|
CreateImageRecipeRequest |
withComponents(ComponentConfiguration... components)
The components included in the image recipe.
|
CreateImageRecipeRequest |
withDescription(String description)
The description of the image recipe.
|
CreateImageRecipeRequest |
withName(String name)
The name of the image recipe.
|
CreateImageRecipeRequest |
withParentImage(String parentImage)
The base image of the image recipe.
|
CreateImageRecipeRequest |
withSemanticVersion(String semanticVersion)
The semantic version of the image recipe.
|
CreateImageRecipeRequest |
withTags(Map<String,String> tags)
The tags of the image recipe.
|
CreateImageRecipeRequest |
withWorkingDirectory(String workingDirectory)
The working directory used 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, withSdkRequestTimeoutpublic void setName(String name)
The name of the image recipe.
name - The name of the image recipe.public String getName()
The name of the image recipe.
public CreateImageRecipeRequest withName(String name)
The name of the image recipe.
name - The name of the image recipe.public void setDescription(String description)
The description of the image recipe.
description - The description of the image recipe.public String getDescription()
The description of the image recipe.
public CreateImageRecipeRequest withDescription(String description)
The description of the image recipe.
description - The description of the image recipe.public void setSemanticVersion(String semanticVersion)
The semantic version of the image 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 image 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 image 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 CreateImageRecipeRequest withSemanticVersion(String semanticVersion)
The semantic version of the image 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 image 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()
The components included in the image recipe.
public void setComponents(Collection<ComponentConfiguration> components)
The components included in the image recipe.
components - The components included in the image recipe.public CreateImageRecipeRequest withComponents(ComponentConfiguration... components)
The components included in the image 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.
components - The components included in the image recipe.public CreateImageRecipeRequest withComponents(Collection<ComponentConfiguration> components)
The components included in the image recipe.
components - The components included in the image recipe.public void setParentImage(String parentImage)
The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The
format for the ARN follows this example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can
provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter
an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which
you are using Image Builder.
parentImage - The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID.
The format for the ARN follows this example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You
can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If
you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same
Region in which you are using Image Builder.public String getParentImage()
The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The
format for the ARN follows this example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can
provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter
an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which
you are using Image Builder.
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x.
You can provide the specific version that you want to use, or you can use a wildcard in all of the
fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be
in the same Region in which you are using Image Builder.public CreateImageRecipeRequest withParentImage(String parentImage)
The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The
format for the ARN follows this example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can
provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter
an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which
you are using Image Builder.
parentImage - The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID.
The format for the ARN follows this example:
arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You
can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If
you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same
Region in which you are using Image Builder.public List<InstanceBlockDeviceMapping> getBlockDeviceMappings()
The block device mappings of the image recipe.
public void setBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)
The block device mappings of the image recipe.
blockDeviceMappings - The block device mappings of the image recipe.public CreateImageRecipeRequest withBlockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)
The block device mappings of the image 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.
blockDeviceMappings - The block device mappings of the image recipe.public CreateImageRecipeRequest withBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)
The block device mappings of the image recipe.
blockDeviceMappings - The block device mappings of the image recipe.public Map<String,String> getTags()
The tags of the image recipe.
public void setTags(Map<String,String> tags)
The tags of the image recipe.
tags - The tags of the image recipe.public CreateImageRecipeRequest withTags(Map<String,String> tags)
The tags of the image recipe.
tags - The tags of the image recipe.public CreateImageRecipeRequest addTagsEntry(String key, String value)
public CreateImageRecipeRequest clearTagsEntries()
public void setWorkingDirectory(String workingDirectory)
The working directory used during build and test workflows.
workingDirectory - The working directory used during build and test workflows.public String getWorkingDirectory()
The working directory used during build and test workflows.
public CreateImageRecipeRequest withWorkingDirectory(String workingDirectory)
The working directory used during build and test workflows.
workingDirectory - The working directory used during build and test workflows.public void setAdditionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)
Specify additional settings and launch scripts for your build instances.
additionalInstanceConfiguration - Specify additional settings and launch scripts for your build instances.public AdditionalInstanceConfiguration getAdditionalInstanceConfiguration()
Specify additional settings and launch scripts for your build instances.
public CreateImageRecipeRequest withAdditionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)
Specify additional settings and launch scripts for your build instances.
additionalInstanceConfiguration - Specify additional settings and launch scripts for your build instances.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 CreateImageRecipeRequest 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 ObjectObject.toString()public CreateImageRecipeRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()