com.amazonaws.services.imagebuilder.model

Class CreateImageRecipeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.imagebuilder.model.CreateImageRecipeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateImageRecipeRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateImageRecipeRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateImageRecipeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<InstanceBlockDeviceMapping>	getBlockDeviceMappings() The block device mappings of the image recipe.
String	getClientToken() The idempotency token used to make this request idempotent.
List<ComponentConfiguration>	getComponents() The components of the image recipe.
String	getDescription() The description of the image recipe.
String	getName() The name of the image recipe.
String	getParentImage() The parent image of the image recipe.
String	getSemanticVersion() The semantic version of the image recipe.
Map<String,String>	getTags() The tags of the image recipe.
int	hashCode()
void	setBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings) The block device mappings of the image recipe.
void	setClientToken(String clientToken) The idempotency token used to make this request idempotent.
void	setComponents(Collection<ComponentConfiguration> components) The components of the image recipe.
void	setDescription(String description) The description of the image recipe.
void	setName(String name) The name of the image recipe.
void	setParentImage(String parentImage) The parent image of the image recipe.
void	setSemanticVersion(String semanticVersion) The semantic version of the image recipe.
void	setTags(Map<String,String> tags) The tags of the image recipe.
String	toString() Returns a string representation of this object.
CreateImageRecipeRequest	withBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings) The block device mappings of the image recipe.
CreateImageRecipeRequest	withBlockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings) The block device mappings of the image recipe.
CreateImageRecipeRequest	withClientToken(String clientToken) The idempotency token used to make this request idempotent.
CreateImageRecipeRequest	withComponents(Collection<ComponentConfiguration> components) The components of the image recipe.
CreateImageRecipeRequest	withComponents(ComponentConfiguration... components) The components of the image recipe.
CreateImageRecipeRequest	withDescription(String description) The description of the image recipe.
CreateImageRecipeRequest	withName(String name) The name of the image recipe.
CreateImageRecipeRequest	withParentImage(String parentImage) The parent image of the image recipe.
CreateImageRecipeRequest	withSemanticVersion(String semanticVersion) The semantic version of the image recipe.
CreateImageRecipeRequest	withTags(Map<String,String> tags) The tags of the image recipe.

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

CreateImageRecipeRequest

public CreateImageRecipeRequest()

Method Detail

setName

public void setName(String name)

The name of the image recipe.

Parameters:

name - The name of the image recipe.

getName

public String getName()

The name of the image recipe.

Returns:

The name of the image recipe.

withName

public CreateImageRecipeRequest withName(String name)

The name of the image recipe.

Parameters:

name - The name of the image recipe.

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

Parameters:

description - The description of the image recipe.

getDescription

public String getDescription()

The description of the image recipe.

Returns:

The description of the image recipe.

withDescription

public CreateImageRecipeRequest withDescription(String description)

The description of the image recipe.

Parameters:

description - The description of the image recipe.

Returns:

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

setSemanticVersion

public void setSemanticVersion(String semanticVersion)

The semantic version of the image recipe.

Parameters:

semanticVersion - The semantic version of the image recipe.

getSemanticVersion

public String getSemanticVersion()

The semantic version of the image recipe.

Returns:

The semantic version of the image recipe.

withSemanticVersion

public CreateImageRecipeRequest withSemanticVersion(String semanticVersion)

The semantic version of the image recipe.

Parameters:

semanticVersion - The semantic version of the image recipe.

Returns:

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

getComponents

public List<ComponentConfiguration> getComponents()

The components of the image recipe.

Returns:

The components of the image recipe.

setComponents

public void setComponents(Collection<ComponentConfiguration> components)

The components of the image recipe.

Parameters:

components - The components of the image recipe.

withComponents

public CreateImageRecipeRequest withComponents(ComponentConfiguration... components)

The components of the image recipe.

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

Parameters:

components - The components of the image recipe.

Returns:

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

withComponents

public CreateImageRecipeRequest withComponents(Collection<ComponentConfiguration> components)

The components of the image recipe.

Parameters:

components - The components of the image recipe.

Returns:

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

setParentImage

public void setParentImage(String parentImage)

The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

Parameters:

parentImage - The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

getParentImage

public String getParentImage()

The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

Returns:

The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

withParentImage

public CreateImageRecipeRequest withParentImage(String parentImage)

The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

Parameters:

parentImage - The parent image of the image recipe. The value of the string can be the ARN of the parent image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/2019.x.x. The ARN ends with /20xx.x.x, which communicates to EC2 Image Builder that you want to use the latest AMI created in 20xx (year). You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

Returns:

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

getBlockDeviceMappings

public List<InstanceBlockDeviceMapping> getBlockDeviceMappings()

The block device mappings of the image recipe.

Returns:

The block device mappings of the image recipe.

setBlockDeviceMappings

public void setBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)

The block device mappings of the image recipe.

Parameters:

blockDeviceMappings - The block device mappings of the image recipe.

withBlockDeviceMappings

public CreateImageRecipeRequest withBlockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)

The block device mappings of the image recipe.

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

Parameters:

blockDeviceMappings - The block device mappings of the image recipe.

Returns:

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

withBlockDeviceMappings

public CreateImageRecipeRequest withBlockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)

The block device mappings of the image recipe.

Parameters:

blockDeviceMappings - The block device mappings of the image recipe.

Returns:

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

getTags

public Map<String,String> getTags()

The tags of the image recipe.

Returns:

The tags of the image recipe.

setTags

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

The tags of the image recipe.

Parameters:

tags - The tags of the image recipe.

withTags

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

The tags of the image recipe.

Parameters:

tags - The tags of the image recipe.

Returns:

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

addTagsEntry

public CreateImageRecipeRequest addTagsEntry(String key,
                                             String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

public CreateImageRecipeRequest 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)

The idempotency token used to make this request idempotent.

Parameters:

clientToken - The idempotency token used to make this request idempotent.

getClientToken

public String getClientToken()

The idempotency token used to make this request idempotent.

Returns:

The idempotency token used to make this request idempotent.

withClientToken

public CreateImageRecipeRequest withClientToken(String clientToken)

The idempotency token used to make this request idempotent.

Parameters:

clientToken - The idempotency token used to make this request idempotent.

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 CreateImageRecipeRequest 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()