software.amazon.awssdk.services.imagebuilder.model

Class CreateImageRequest

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

Method Summary

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() For responses, this returns true if the service returned a value for the Tags property.
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()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

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.

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.

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