com.amazonaws.services.imagebuilder.model

Class UpdateImagePipelineRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.imagebuilder.model.UpdateImagePipelineRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateImagePipelineRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateImagePipelineRequest()

Method Summary

Modifier and Type	Method and Description
UpdateImagePipelineRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	getContainerRecipeArn() The Amazon Resource Name (ARN) of the container pipeline to update.
String	getDescription() The description of the image pipeline.
String	getDistributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
Boolean	getEnhancedImageMetadataEnabled() Collects additional information about the image being created, including the operating system (OS) version and package list.
String	getExecutionRole() The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
String	getImagePipelineArn() The Amazon Resource Name (ARN) of the image pipeline that you want to update.
String	getImageRecipeArn() The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
ImageScanningConfiguration	getImageScanningConfiguration() Contains settings for vulnerability scans.
ImageTestsConfiguration	getImageTestsConfiguration() The image test configuration of the image pipeline.
String	getInfrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
Schedule	getSchedule() The schedule of the image pipeline.
String	getStatus() The status of the image pipeline.
List<WorkflowConfiguration>	getWorkflows() Contains the workflows to run for the pipeline.
int	hashCode()
Boolean	isEnhancedImageMetadataEnabled() Collects additional information about the image being created, including the operating system (OS) version and package list.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
void	setContainerRecipeArn(String containerRecipeArn) The Amazon Resource Name (ARN) of the container pipeline to update.
void	setDescription(String description) The description of the image pipeline.
void	setDistributionConfigurationArn(String distributionConfigurationArn) The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
void	setEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.
void	setExecutionRole(String executionRole) The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
void	setImagePipelineArn(String imagePipelineArn) The Amazon Resource Name (ARN) of the image pipeline that you want to update.
void	setImageRecipeArn(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
void	setImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration) Contains settings for vulnerability scans.
void	setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration) The image test configuration of the image pipeline.
void	setInfrastructureConfigurationArn(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
void	setSchedule(Schedule schedule) The schedule of the image pipeline.
void	setStatus(String status) The status of the image pipeline.
void	setWorkflows(Collection<WorkflowConfiguration> workflows) Contains the workflows to run for the pipeline.
String	toString() Returns a string representation of this object.
UpdateImagePipelineRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
UpdateImagePipelineRequest	withContainerRecipeArn(String containerRecipeArn) The Amazon Resource Name (ARN) of the container pipeline to update.
UpdateImagePipelineRequest	withDescription(String description) The description of the image pipeline.
UpdateImagePipelineRequest	withDistributionConfigurationArn(String distributionConfigurationArn) The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
UpdateImagePipelineRequest	withEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.
UpdateImagePipelineRequest	withExecutionRole(String executionRole) The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
UpdateImagePipelineRequest	withImagePipelineArn(String imagePipelineArn) The Amazon Resource Name (ARN) of the image pipeline that you want to update.
UpdateImagePipelineRequest	withImageRecipeArn(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
UpdateImagePipelineRequest	withImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration) Contains settings for vulnerability scans.
UpdateImagePipelineRequest	withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration) The image test configuration of the image pipeline.
UpdateImagePipelineRequest	withInfrastructureConfigurationArn(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
UpdateImagePipelineRequest	withSchedule(Schedule schedule) The schedule of the image pipeline.
UpdateImagePipelineRequest	withStatus(PipelineStatus status) The status of the image pipeline.
UpdateImagePipelineRequest	withStatus(String status) The status of the image pipeline.
UpdateImagePipelineRequest	withWorkflows(Collection<WorkflowConfiguration> workflows) Contains the workflows to run for the pipeline.
UpdateImagePipelineRequest	withWorkflows(WorkflowConfiguration... workflows) Contains the workflows to run for the pipeline.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateImagePipelineRequest

public UpdateImagePipelineRequest()

Method Detail

setImagePipelineArn

public void setImagePipelineArn(String imagePipelineArn)

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Parameters:

imagePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that you want to update.

getImagePipelineArn

public String getImagePipelineArn()

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Returns:

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

withImagePipelineArn

public UpdateImagePipelineRequest withImagePipelineArn(String imagePipelineArn)

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Parameters:

imagePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the image pipeline.

Parameters:

description - The description of the image pipeline.

getDescription

public String getDescription()

The description of the image pipeline.

Returns:

The description of the image pipeline.

withDescription

public UpdateImagePipelineRequest withDescription(String description)

The description of the image pipeline.

Parameters:

description - The description of the image pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

setImageRecipeArn

public void setImageRecipeArn(String imageRecipeArn)

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

Parameters:

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

getImageRecipeArn

public String getImageRecipeArn()

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

Returns:

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

withImageRecipeArn

public UpdateImagePipelineRequest withImageRecipeArn(String imageRecipeArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setContainerRecipeArn

public void setContainerRecipeArn(String containerRecipeArn)

The Amazon Resource Name (ARN) of the container pipeline to update.

Parameters:

containerRecipeArn - The Amazon Resource Name (ARN) of the container pipeline to update.

getContainerRecipeArn

public String getContainerRecipeArn()

The Amazon Resource Name (ARN) of the container pipeline to update.

Returns:

The Amazon Resource Name (ARN) of the container pipeline to update.

withContainerRecipeArn

public UpdateImagePipelineRequest withContainerRecipeArn(String containerRecipeArn)

The Amazon Resource Name (ARN) of the container pipeline to update.

Parameters:

containerRecipeArn - The Amazon Resource Name (ARN) of the container pipeline to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInfrastructureConfigurationArn

public void setInfrastructureConfigurationArn(String infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

getInfrastructureConfigurationArn

public String getInfrastructureConfigurationArn()

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

Returns:

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

withInfrastructureConfigurationArn

public UpdateImagePipelineRequest withInfrastructureConfigurationArn(String infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDistributionConfigurationArn

public void setDistributionConfigurationArn(String distributionConfigurationArn)

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

Parameters:

distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

getDistributionConfigurationArn

public String getDistributionConfigurationArn()

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

Returns:

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

withDistributionConfigurationArn

public UpdateImagePipelineRequest withDistributionConfigurationArn(String distributionConfigurationArn)

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

Parameters:

distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

setImageTestsConfiguration

public void setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

The image test configuration of the image pipeline.

Parameters:

imageTestsConfiguration - The image test configuration of the image pipeline.

getImageTestsConfiguration

public ImageTestsConfiguration getImageTestsConfiguration()

The image test configuration of the image pipeline.

Returns:

The image test configuration of the image pipeline.

withImageTestsConfiguration

public UpdateImagePipelineRequest withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

The image test configuration of the image pipeline.

Parameters:

imageTestsConfiguration - The image test configuration of the image pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnhancedImageMetadataEnabled

public void setEnhancedImageMetadataEnabled(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.

Parameters:

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.

getEnhancedImageMetadataEnabled

public Boolean getEnhancedImageMetadataEnabled()

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.

withEnhancedImageMetadataEnabled

public UpdateImagePipelineRequest withEnhancedImageMetadataEnabled(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isEnhancedImageMetadataEnabled

public Boolean isEnhancedImageMetadataEnabled()

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.

setSchedule

public void setSchedule(Schedule schedule)

The schedule of the image pipeline.

Parameters:

schedule - The schedule of the image pipeline.

getSchedule

public Schedule getSchedule()

The schedule of the image pipeline.

Returns:

The schedule of the image pipeline.

withSchedule

public UpdateImagePipelineRequest withSchedule(Schedule schedule)

The schedule of the image pipeline.

Parameters:

schedule - The schedule of the image pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String status)

The status of the image pipeline.

Parameters:

status - The status of the image pipeline.

See Also:

PipelineStatus

getStatus

public String getStatus()

The status of the image pipeline.

Returns:

The status of the image pipeline.

See Also:

PipelineStatus

withStatus

public UpdateImagePipelineRequest withStatus(String status)

The status of the image pipeline.

Parameters:

status - The status of the image pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PipelineStatus

withStatus

public UpdateImagePipelineRequest withStatus(PipelineStatus status)

The status of the image pipeline.

Parameters:

status - The status of the image pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PipelineStatus

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public UpdateImagePipelineRequest withClientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setImageScanningConfiguration

public void setImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)

Contains settings for vulnerability scans.

Parameters:

imageScanningConfiguration - Contains settings for vulnerability scans.

getImageScanningConfiguration

public ImageScanningConfiguration getImageScanningConfiguration()

Contains settings for vulnerability scans.

Returns:

Contains settings for vulnerability scans.

withImageScanningConfiguration

public UpdateImagePipelineRequest withImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)

Contains settings for vulnerability scans.

Parameters:

imageScanningConfiguration - Contains settings for vulnerability scans.

Returns:

Returns a reference to this object so that method calls can be chained together.

getWorkflows

public List<WorkflowConfiguration> getWorkflows()

Contains the workflows to run for the pipeline.

Returns:

Contains the workflows to run for the pipeline.

setWorkflows

public void setWorkflows(Collection<WorkflowConfiguration> workflows)

Contains the workflows to run for the pipeline.

Parameters:

workflows - Contains the workflows to run for the pipeline.

withWorkflows

public UpdateImagePipelineRequest withWorkflows(WorkflowConfiguration... workflows)

Contains the workflows to run for the pipeline.

NOTE: This method appends the values to the existing list (if any). Use setWorkflows(java.util.Collection) or withWorkflows(java.util.Collection) if you want to override the existing values.

Parameters:

workflows - Contains the workflows to run for the pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

withWorkflows

public UpdateImagePipelineRequest withWorkflows(Collection<WorkflowConfiguration> workflows)

Contains the workflows to run for the pipeline.

Parameters:

workflows - Contains the workflows to run for the pipeline.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExecutionRole

public void setExecutionRole(String executionRole)

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Parameters:

executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

getExecutionRole

public String getExecutionRole()

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.

withExecutionRole

public UpdateImagePipelineRequest withExecutionRole(String executionRole)

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Parameters:

executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateImagePipelineRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()