Class CreateComponentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateComponentRequest.Builder,
CreateComponentRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The change description of the component.final String
Unique, case-sensitive identifier you provide to ensure idempotency of the request.final String
data()
Componentdata
contains inline YAML document content for the component.final String
Describes the contents of the component.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedOsVersions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKeyId()
The ID of the KMS key that is used to encrypt this component.final String
name()
The name of the component.final Platform
platform()
The operating system platform of the component.final String
The operating system platform of the component.final String
The semantic version of the component.static Class
<? extends CreateComponentRequest.Builder> The operating system (OS) version supported by the component.tags()
The tags that apply to the component.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
uri()
Theuri
of a YAML component document file.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the component.
- Returns:
- The name of the component.
-
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:
- 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.
-
description
Describes the contents of the component.
- Returns:
- Describes the contents of the component.
-
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:
- 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.
-
platform
The operating system platform of the component.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the component.
- See Also:
-
platformAsString
The operating system platform of the component.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the component.
- See Also:
-
hasSupportedOsVersions
public final boolean hasSupportedOsVersions()For responses, this returns true if the service returned a value for the SupportedOsVersions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasSupportedOsVersions()
method.- 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.
-
data
Component
data
contains inline YAML document content for the component. Alternatively, you can specify theuri
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 theuri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
-
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:
- 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.
-
kmsKeyId
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.
-
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 theisEmpty()
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
The tags that apply to the component.
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 that apply to the component.
-
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateComponentRequest.Builder,
CreateComponentRequest> - Specified by:
toBuilder
in classImagebuilderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-