com.amazonaws.services.imagebuilder.model

Class CreateImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.imagebuilder.model.CreateImageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateImageRequest
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
CreateImageRequest()

Method Summary

Modifier and Type	Method and Description
CreateImageRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateImageRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateImageRequest	clone()
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 recipe that defines how images are configured and tested.
String	getDistributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
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	getImageRecipeArn() The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
ImageScanningConfiguration	getImageScanningConfiguration() Contains settings for vulnerability scans.
ImageTestsConfiguration	getImageTestsConfiguration() The image tests configuration of the image.
String	getInfrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
Map<String,String>	getTags() The tags of the image.
List<WorkflowConfiguration>	getWorkflows() Contains an array of workflow configuration objects.
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 recipe that defines how images are configured and tested.
void	setDistributionConfigurationArn(String distributionConfigurationArn) The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
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	setImageRecipeArn(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
void	setImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration) Contains settings for vulnerability scans.
void	setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration) The image tests configuration of the image.
void	setInfrastructureConfigurationArn(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
void	setTags(Map<String,String> tags) The tags of the image.
void	setWorkflows(Collection<WorkflowConfiguration> workflows) Contains an array of workflow configuration objects.
String	toString() Returns a string representation of this object.
CreateImageRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
CreateImageRequest	withContainerRecipeArn(String containerRecipeArn) The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
CreateImageRequest	withDistributionConfigurationArn(String distributionConfigurationArn) The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
CreateImageRequest	withEnhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.
CreateImageRequest	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.
CreateImageRequest	withImageRecipeArn(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
CreateImageRequest	withImageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration) Contains settings for vulnerability scans.
CreateImageRequest	withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration) The image tests configuration of the image.
CreateImageRequest	withInfrastructureConfigurationArn(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
CreateImageRequest	withTags(Map<String,String> tags) The tags of the image.
CreateImageRequest	withWorkflows(Collection<WorkflowConfiguration> workflows) Contains an array of workflow configuration objects.
CreateImageRequest	withWorkflows(WorkflowConfiguration... workflows) Contains an array of workflow configuration objects.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateImageRequest

public CreateImageRequest()

Method Detail

setImageRecipeArn

public void setImageRecipeArn(String imageRecipeArn)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Parameters:

imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

getImageRecipeArn

public String getImageRecipeArn()

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.

withImageRecipeArn

public CreateImageRequest withImageRecipeArn(String imageRecipeArn)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Parameters:

imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

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 recipe that defines how images are configured and tested.

Parameters:

containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

getContainerRecipeArn

public String getContainerRecipeArn()

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.

withContainerRecipeArn

public CreateImageRequest withContainerRecipeArn(String containerRecipeArn)

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

Parameters:

containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

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 defines and configures the outputs of your pipeline.

Parameters:

distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

getDistributionConfigurationArn

public String getDistributionConfigurationArn()

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.

withDistributionConfigurationArn

public CreateImageRequest withDistributionConfigurationArn(String distributionConfigurationArn)

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

Parameters:

distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

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 defines the environment in which your image will be built and tested.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

getInfrastructureConfigurationArn

public String getInfrastructureConfigurationArn()

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.

withInfrastructureConfigurationArn

public CreateImageRequest withInfrastructureConfigurationArn(String infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Returns:

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

setImageTestsConfiguration

public void setImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

The image tests configuration of the image.

Parameters:

imageTestsConfiguration - The image tests configuration of the image.

getImageTestsConfiguration

public ImageTestsConfiguration getImageTestsConfiguration()

The image tests configuration of the image.

Returns:

The image tests configuration of the image.

withImageTestsConfiguration

public CreateImageRequest withImageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

The image tests configuration of the image.

Parameters:

imageTestsConfiguration - The image tests configuration of the image.

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

getTags

public Map<String,String> getTags()

The tags of the image.

Returns:

The tags of the image.

setTags

public void setTags(Map<String,String> tags)

The tags of the image.

Parameters:

tags - The tags of the image.

withTags

public CreateImageRequest withTags(Map<String,String> tags)

The tags of the image.

Parameters:

tags - The tags of the image.

Returns:

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

addTagsEntry

public CreateImageRequest addTagsEntry(String key,
                                       String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateImageRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

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 CreateImageRequest 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 CreateImageRequest 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 an array of workflow configuration objects.

Returns:

Contains an array of workflow configuration objects.

setWorkflows

public void setWorkflows(Collection<WorkflowConfiguration> workflows)

Contains an array of workflow configuration objects.

Parameters:

workflows - Contains an array of workflow configuration objects.

withWorkflows

public CreateImageRequest withWorkflows(WorkflowConfiguration... workflows)

Contains an array of workflow configuration objects.

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 an array of workflow configuration objects.

Returns:

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

withWorkflows

public CreateImageRequest withWorkflows(Collection<WorkflowConfiguration> workflows)

Contains an array of workflow configuration objects.

Parameters:

workflows - Contains an array of workflow configuration objects.

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 CreateImageRequest 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 CreateImageRequest clone()

Overrides:

clone in class AmazonWebServiceRequest