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("software.amazon.awssdk:codegen")
public final class CreateImagePipelineRequest
extends ImagebuilderRequest
implements ToCopyableBuilder<CreateImagePipelineRequest.Builder,CreateImagePipelineRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateImagePipelineRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateImagePipelineRequest.Builder`	`builder()`
`String`	`clientToken()`	Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`String`	`containerRecipeArn()`	The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
`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)`
`String`	`executionRole()`	The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
`<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.
`boolean`	`hasWorkflows()`	For responses, this returns true if the service returned a value for the Workflows property.
`String`	`imageRecipeArn()`	The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
`ImageScanningConfiguration`	`imageScanningConfiguration()`	Contains settings for vulnerability scans.
`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.
`List<WorkflowConfiguration>`	`workflows()`	Contains an array of workflow configuration objects.

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 pipeline.
    
    Returns:
    
    The name of the image pipeline.
  - description
```
public final String description()
```
    The description of the image pipeline.
    
    Returns:
    
    The description of the image pipeline.
  - imageRecipeArn
```
public final 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.
  - containerRecipeArn
```
public final String containerRecipeArn()
```
    The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
  - infrastructureConfigurationArn
```
public final 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 final 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 final ImageTestsConfiguration imageTestsConfiguration()
```
    The image test configuration of the image pipeline.
    
    Returns:
    
    The image test configuration of the image pipeline.
  - 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.
  - schedule
```
public final Schedule schedule()
```
    The schedule of the image pipeline.
    
    Returns:
    
    The schedule of the image pipeline.
  - status
```
public final 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 final 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 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 pipeline.
    
    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 pipeline.
  - clientToken
```
public final String clientToken()
```
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
    
    Returns:
    
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
  - imageScanningConfiguration
```
public final ImageScanningConfiguration imageScanningConfiguration()
```
    Contains settings for vulnerability scans.
    
    Returns:
    
    Contains settings for vulnerability scans.
  - hasWorkflows
```
public final boolean hasWorkflows()
```
    For responses, this returns true if the service returned a value for the Workflows 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.
  - workflows
```
public final List<WorkflowConfiguration> workflows()
```
    Contains an array of workflow configuration objects.
    
    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 hasWorkflows() method.
    
    Returns:
    
    Contains an array of workflow configuration objects.
  - executionRole
```
public final String executionRole()
```
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
  - 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 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 CreateImagePipelineRequest

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

imageRecipeArn

containerRecipeArn

infrastructureConfigurationArn

distributionConfigurationArn

imageTestsConfiguration

enhancedImageMetadataEnabled

schedule

status

statusAsString

hasTags

tags

clientToken

imageScanningConfiguration

hasWorkflows

workflows

executionRole

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields