software.amazon.awssdk.services.imagebuilder.model

Class CreateImagePipelineRequest

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.CreateImagePipelineRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateImagePipelineRequest.Builder,CreateImagePipelineRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateImagePipelineRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateImagePipelineRequest.Builder	builder()
String	clientToken() The idempotency token used to make this request idempotent.
String	description() The description of the image pipeline.
String	distributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image 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 will be used to configure images created by this image pipeline.
ImageTestsConfiguration	imageTestsConfiguration() The image test configuration of the image pipeline.
String	infrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
String	name() The name of the image pipeline.
Schedule	schedule() The schedule of the image pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateImagePipelineRequest.Builder>	serializableBuilderClass()
PipelineStatus	status() The status of the image pipeline.
String	statusAsString() The status of the image pipeline.
Map<String,String>	tags() The tags of the image pipeline.
CreateImagePipelineRequest.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

name

public String name()

The name of the image pipeline.

Returns:

The name of the image pipeline.

description

public String description()

The description of the image pipeline.

Returns:

The description of the image pipeline.

imageRecipeArn

public String imageRecipeArn()

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

infrastructureConfigurationArn

public String infrastructureConfigurationArn()

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

distributionConfigurationArn

public String distributionConfigurationArn()

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

imageTestsConfiguration

public ImageTestsConfiguration imageTestsConfiguration()

The image test configuration of the image pipeline.

Returns:

The image test configuration of the image pipeline.

enhancedImageMetadataEnabled

public 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.

schedule

public Schedule schedule()

The schedule of the image pipeline.

Returns:

The schedule of the image pipeline.

status

public PipelineStatus status()

The status of the image pipeline.

If the service returns an enum value that is not available in the current SDK version, status will return PipelineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the image pipeline.

See Also:

PipelineStatus

statusAsString

public String statusAsString()

The status of the image pipeline.

If the service returns an enum value that is not available in the current SDK version, status will return PipelineStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the image pipeline.

See Also:

PipelineStatus

hasTags

public 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 Map<String,String> tags()

The tags of the image pipeline.

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 pipeline.

clientToken

public String clientToken()

The idempotency token used to make this request idempotent.

Returns:

The idempotency token used to make this request idempotent.

toBuilder

public CreateImagePipelineRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateImagePipelineRequest.Builder,CreateImagePipelineRequest>

Specified by:

toBuilder in class ImagebuilderRequest

builder

public static CreateImagePipelineRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateImagePipelineRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo