@Generated(value="software.amazon.awssdk:codegen") public final class CreateImageRecipeRequest extends ImagebuilderRequest implements ToCopyableBuilder<CreateImageRecipeRequest.Builder,CreateImageRecipeRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateImageRecipeRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
AdditionalInstanceConfiguration |
additionalInstanceConfiguration()
Specify additional settings and launch scripts for your build instances.
|
List<InstanceBlockDeviceMapping> |
blockDeviceMappings()
The block device mappings of the image recipe.
|
static CreateImageRecipeRequest.Builder |
builder() |
String |
clientToken()
The idempotency token used to make this request idempotent.
|
List<ComponentConfiguration> |
components()
The components included in the image recipe.
|
String |
description()
The description of the image recipe.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasBlockDeviceMappings()
For responses, this returns true if the service returned a value for the BlockDeviceMappings property.
|
boolean |
hasComponents()
For responses, this returns true if the service returned a value for the Components property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
name()
The name of the image recipe.
|
String |
parentImage()
The base image of the image recipe.
|
List<SdkField<?>> |
sdkFields() |
String |
semanticVersion()
The semantic version of the image recipe.
|
static Class<? extends CreateImageRecipeRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
The tags of the image recipe.
|
CreateImageRecipeRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
workingDirectory()
The working directory used during build and test workflows.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
The name of the image recipe.
public final String description()
The description of the image recipe.
public final 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.
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 final boolean hasComponents()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<ComponentConfiguration> components()
The components included in the image recipe.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasComponents() method.
public final 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.
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 final boolean hasBlockDeviceMappings()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<InstanceBlockDeviceMapping> blockDeviceMappings()
The block device mappings of the image recipe.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final Map<String,String> tags()
The tags of the image recipe.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final String workingDirectory()
The working directory used during build and test workflows.
public final AdditionalInstanceConfiguration additionalInstanceConfiguration()
Specify additional settings and launch scripts for your build instances.
public final String clientToken()
The idempotency token used to make this request idempotent.
public CreateImageRecipeRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateImageRecipeRequest.Builder,CreateImageRecipeRequest>toBuilder in class ImagebuilderRequestpublic static CreateImageRecipeRequest.Builder builder()
public static Class<? extends CreateImageRecipeRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.