CreateImageRecipeRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest
    - - software.amazon.awssdk.services.imagebuilder.model.CreateImageRecipeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateImageRecipeRequest.Builder,CreateImageRecipeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateImageRecipeRequest
extends ImagebuilderRequest
implements ToCopyableBuilder<CreateImageRecipeRequest.Builder,CreateImageRecipeRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateImageRecipeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateImageRecipeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 of 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()` Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasComponents()` Returns true if the Components property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`name()` The name of the image recipe.
`String`	`parentImage()` The parent 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 to be used during build and test workflows.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the image recipe.
    
    Returns:
    
    The name of the image recipe.
  - description
```
public final String description()
```
    The description of the image recipe.
    
    Returns:
    
    The description of the image recipe.
  - semanticVersion
```
public final String semanticVersion()
```
    The semantic version of the image recipe.
    
    Returns:
    
    The semantic version of the image recipe.
  - hasComponents
```
public final boolean hasComponents()
```
    Returns true if the Components property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - components
```
public final List<ComponentConfiguration> components()
```
    The components of the image recipe.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasComponents() to see if a value was sent in this field.
    
    Returns:
    
    The components of the image recipe.
  - parentImage
```
public final String parentImage()
```
    The parent image of the image recipe. The value of the string can be the ARN of the parent 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/xxxx.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.
    
    Returns:
    
    The parent image of the image recipe. The value of the string can be the ARN of the parent 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/xxxx.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.
  - hasBlockDeviceMappings
```
public final boolean hasBlockDeviceMappings()
```
    Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - blockDeviceMappings
```
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.
    
    You can use hasBlockDeviceMappings() to see if a value was sent in this field.
    
    Returns:
    
    The block device mappings of the image recipe.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags of the image recipe.
  - workingDirectory
```
public final String workingDirectory()
```
    The working directory to be used during build and test workflows.
    
    Returns:
    
    The working directory to be used during build and test workflows.
  - clientToken
```
public final String clientToken()
```
    The idempotency token used to make this request idempotent.
    
    Returns:
    
    The idempotency token used to make this request idempotent.
  - toBuilder
```
public CreateImageRecipeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateImageRecipeRequest.Builder,CreateImageRecipeRequest>
    
    Specified by:
    
    toBuilder in class ImagebuilderRequest
  - builder
```
public static CreateImageRecipeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateImageRecipeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateImageRecipeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

semanticVersion

hasComponents

components

parentImage

hasBlockDeviceMappings

blockDeviceMappings

hasTags

tags

workingDirectory

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields