software.amazon.awssdk.services.imagebuilder.model

Interface ComponentVersion.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ComponentVersion.Builder,ComponentVersion>, SdkBuilder<ComponentVersion.Builder,ComponentVersion>, SdkPojo

Enclosing class:

ComponentVersion

public static interface ComponentVersion.Builder
extends SdkPojo, CopyableBuilder<ComponentVersion.Builder,ComponentVersion>

Method Summary

Modifier and Type	Method and Description
ComponentVersion.Builder	arn(String arn) The Amazon Resource Name (ARN) of the component.
ComponentVersion.Builder	dateCreated(String dateCreated) The date that the component was created.
ComponentVersion.Builder	description(String description) The description of the component.
ComponentVersion.Builder	name(String name) The name of the component.
ComponentVersion.Builder	owner(String owner) The owner of the component.
ComponentVersion.Builder	platform(Platform platform) The platform of the component.
ComponentVersion.Builder	platform(String platform) The platform of the component.
ComponentVersion.Builder	supportedOsVersions(Collection<String> supportedOsVersions) he operating system (OS) version supported by the component.
ComponentVersion.Builder	supportedOsVersions(String... supportedOsVersions) he operating system (OS) version supported by the component.
ComponentVersion.Builder	type(ComponentType type) The type of the component denotes whether the component is used to build the image or only to test it.
ComponentVersion.Builder	type(String type) The type of the component denotes whether the component is used to build the image or only to test it.
ComponentVersion.Builder	version(String version) The semantic version of the component.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

arn

ComponentVersion.Builder arn(String arn)

The Amazon Resource Name (ARN) of the component.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Parameters:

arn - The Amazon Resource Name (ARN) of the component.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Returns:

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

name

ComponentVersion.Builder name(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.

version

ComponentVersion.Builder version(String version)

The semantic version of the component.

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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Parameters:

version - The semantic version of the component.

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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Returns:

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

description

ComponentVersion.Builder description(String description)

The description of the component.

Parameters:

description - The description of the component.

Returns:

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

platform

ComponentVersion.Builder platform(String platform)

The platform of the component.

Parameters:

platform - The platform of the component.

Returns:

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

See Also:

Platform, Platform

platform

ComponentVersion.Builder platform(Platform platform)

The platform of the component.

Parameters:

platform - The platform of the component.

Returns:

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

See Also:

Platform, Platform

supportedOsVersions

ComponentVersion.Builder supportedOsVersions(Collection<String> supportedOsVersions)

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

supportedOsVersions

ComponentVersion.Builder supportedOsVersions(String... supportedOsVersions)

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

type

ComponentVersion.Builder type(String type)

The type of the component denotes whether the component is used to build the image or only to test it.

Parameters:

type - The type of the component denotes whether the component is used to build the image or only to test it.

Returns:

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

See Also:

ComponentType, ComponentType

type

ComponentVersion.Builder type(ComponentType type)

The type of the component denotes whether the component is used to build the image or only to test it.

Parameters:

type - The type of the component denotes whether the component is used to build the image or only to test it.

Returns:

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

See Also:

ComponentType, ComponentType

owner

ComponentVersion.Builder owner(String owner)

The owner of the component.

Parameters:

owner - The owner of the component.

Returns:

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

dateCreated

ComponentVersion.Builder dateCreated(String dateCreated)

The date that the component was created.

Parameters:

dateCreated - The date that the component was created.

Returns:

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