com.amazonaws.services.imagebuilder.model

Class CreateComponentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.imagebuilder.model.CreateComponentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateComponentRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateComponentRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateComponentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChangeDescription() The change description of the component.
String	getClientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	getData() Component data contains inline YAML document content for the component.
String	getDescription() Describes the contents of the component.
String	getKmsKeyId() The ID of the KMS key that is used to encrypt this component.
String	getName() The name of the component.
String	getPlatform() The operating system platform of the component.
String	getSemanticVersion() The semantic version of the component.
List<String>	getSupportedOsVersions() The operating system (OS) version supported by the component.
Map<String,String>	getTags() The tags that apply to the component.
String	getUri() The uri of a YAML component document file.
int	hashCode()
void	setChangeDescription(String changeDescription) The change description of the component.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
void	setData(String data) Component data contains inline YAML document content for the component.
void	setDescription(String description) Describes the contents of the component.
void	setKmsKeyId(String kmsKeyId) The ID of the KMS key that is used to encrypt this component.
void	setName(String name) The name of the component.
void	setPlatform(String platform) The operating system platform of the component.
void	setSemanticVersion(String semanticVersion) The semantic version of the component.
void	setSupportedOsVersions(Collection<String> supportedOsVersions) The operating system (OS) version supported by the component.
void	setTags(Map<String,String> tags) The tags that apply to the component.
void	setUri(String uri) The uri of a YAML component document file.
String	toString() Returns a string representation of this object.
CreateComponentRequest	withChangeDescription(String changeDescription) The change description of the component.
CreateComponentRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
CreateComponentRequest	withData(String data) Component data contains inline YAML document content for the component.
CreateComponentRequest	withDescription(String description) Describes the contents of the component.
CreateComponentRequest	withKmsKeyId(String kmsKeyId) The ID of the KMS key that is used to encrypt this component.
CreateComponentRequest	withName(String name) The name of the component.
CreateComponentRequest	withPlatform(Platform platform) The operating system platform of the component.
CreateComponentRequest	withPlatform(String platform) The operating system platform of the component.
CreateComponentRequest	withSemanticVersion(String semanticVersion) The semantic version of the component.
CreateComponentRequest	withSupportedOsVersions(Collection<String> supportedOsVersions) The operating system (OS) version supported by the component.
CreateComponentRequest	withSupportedOsVersions(String... supportedOsVersions) The operating system (OS) version supported by the component.
CreateComponentRequest	withTags(Map<String,String> tags) The tags that apply to the component.
CreateComponentRequest	withUri(String uri) The uri of a YAML component document file.

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

CreateComponentRequest

public CreateComponentRequest()

Method Detail

setName

public void setName(String name)

The name of the component.

Parameters:

name - The name of the component.

getName

public String getName()

The name of the component.

Returns:

The name of the component.

withName

public CreateComponentRequest withName(String name)

The name of the component.

Parameters:

name - The name of the component.

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 component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Parameters:

semanticVersion - The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

getSemanticVersion

public String getSemanticVersion()

The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Returns:

The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

withSemanticVersion

public CreateComponentRequest withSemanticVersion(String semanticVersion)

The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Parameters:

semanticVersion - The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Returns:

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

setDescription

public void setDescription(String description)

Describes the contents of the component.

Parameters:

description - Describes the contents of the component.

getDescription

public String getDescription()

Describes the contents of the component.

Returns:

Describes the contents of the component.

withDescription

public CreateComponentRequest withDescription(String description)

Describes the contents of the component.

Parameters:

description - Describes the contents of the component.

Returns:

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

setChangeDescription

public void setChangeDescription(String changeDescription)

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

Parameters:

changeDescription - The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

getChangeDescription

public String getChangeDescription()

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

Returns:

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

withChangeDescription

public CreateComponentRequest withChangeDescription(String changeDescription)

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

Parameters:

changeDescription - The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

Returns:

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

setPlatform

public void setPlatform(String platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component.

See Also:

Platform

getPlatform

public String getPlatform()

The operating system platform of the component.

Returns:

The operating system platform of the component.

See Also:

Platform

withPlatform

public CreateComponentRequest withPlatform(String platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component.

Returns:

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

See Also:

Platform

withPlatform

public CreateComponentRequest withPlatform(Platform platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component.

Returns:

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

See Also:

Platform

getSupportedOsVersions

public List<String> getSupportedOsVersions()

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

Returns:

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

setSupportedOsVersions

public void setSupportedOsVersions(Collection<String> supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

withSupportedOsVersions

public CreateComponentRequest withSupportedOsVersions(String... supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

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

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

Returns:

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

withSupportedOsVersions

public CreateComponentRequest withSupportedOsVersions(Collection<String> supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

Returns:

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

setData

public void setData(String data)

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

Parameters:

data - Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

getData

public String getData()

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

Returns:

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

withData

public CreateComponentRequest withData(String data)

Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

Parameters:

data - Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

Returns:

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

setUri

public void setUri(String uri)

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

Parameters:

uri - The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

getUri

public String getUri()

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

Returns:

The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

withUri

public CreateComponentRequest withUri(String uri)

The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

Parameters:

uri - The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The ID of the KMS key that is used to encrypt this component.

Parameters:

kmsKeyId - The ID of the KMS key that is used to encrypt this component.

getKmsKeyId

public String getKmsKeyId()

The ID of the KMS key that is used to encrypt this component.

Returns:

The ID of the KMS key that is used to encrypt this component.

withKmsKeyId

public CreateComponentRequest withKmsKeyId(String kmsKeyId)

The ID of the KMS key that is used to encrypt this component.

Parameters:

kmsKeyId - The ID of the KMS key that is used to encrypt this component.

Returns:

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

getTags

public Map<String,String> getTags()

The tags that apply to the component.

Returns:

The tags that apply to the component.

setTags

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

The tags that apply to the component.

Parameters:

tags - The tags that apply to the component.

withTags

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

The tags that apply to the component.

Parameters:

tags - The tags that apply to the component.

Returns:

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

addTagsEntry

public CreateComponentRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

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

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