CreateImageRequest (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.CreateImageRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateImageRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateImageRequest.Builder`	`builder()`
`String`	`clientToken()` The idempotency token used to make this request idempotent.
`String`	`containerRecipeArn()` The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
`String`	`distributionConfigurationArn()` The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
`Boolean`	`enhancedImageMetadataEnabled()` Collects additional information about the image being created, including the operating system (OS) version and package list.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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`	`imageRecipeArn()` The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
`ImageTestsConfiguration`	`imageTestsConfiguration()` The image tests configuration of the image.
`String`	`infrastructureConfigurationArn()` The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateImageRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags of the image.
`CreateImageRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - imageRecipeArn
```
public final String imageRecipeArn()
```
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
  - containerRecipeArn
```
public final String containerRecipeArn()
```
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
  - distributionConfigurationArn
```
public final String distributionConfigurationArn()
```
    The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
  - infrastructureConfigurationArn
```
public final String infrastructureConfigurationArn()
```
    The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
  - imageTestsConfiguration
```
public final ImageTestsConfiguration imageTestsConfiguration()
```
    The image tests configuration of the image.
    
    Returns:
    
    The image tests configuration of the image.
  - enhancedImageMetadataEnabled
```
public final Boolean enhancedImageMetadataEnabled()
```
    Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
    
    Returns:
    
    Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
  - 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.
    
    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.
  - 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 CreateImageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>
    
    Specified by:
    
    toBuilder in class ImagebuilderRequest
  - builder
```
public static CreateImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateImageRequest.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 CreateImageRequest

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

imageRecipeArn

containerRecipeArn

distributionConfigurationArn

infrastructureConfigurationArn

imageTestsConfiguration

enhancedImageMetadataEnabled

hasTags

tags

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields