Interface ComponentSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ComponentSummary.Builder,
,ComponentSummary> SdkBuilder<ComponentSummary.Builder,
,ComponentSummary> SdkPojo
- Enclosing class:
ComponentSummary
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the component.changeDescription
(String changeDescription) The change description for the current version of the component.dateCreated
(String dateCreated) The original creation date of the component.description
(String description) The description of the component.The name of the component.Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.The owner of the component.The operating system platform of the component.The operating system platform of the component.Contains the name of the publisher if this is a third-party component.default ComponentSummary.Builder
state
(Consumer<ComponentState.Builder> state) Describes the current status of the component.state
(ComponentState state) Describes the current status of the component.supportedOsVersions
(String... supportedOsVersions) The operating system (OS) version that the component supports.supportedOsVersions
(Collection<String> supportedOsVersions) The operating system (OS) version that the component supports.The tags that apply to the component.The component type specifies whether Image Builder uses the component to build the image or only to test it.type
(ComponentType type) The component type specifies whether Image Builder uses the component to build the image or only to test it.The version of the component.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the component.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The version of the component.
- Parameters:
version
- The version of the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
supportedOsVersions
The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
- Parameters:
supportedOsVersions
- The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match 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
The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.
- Parameters:
supportedOsVersions
- The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match 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.
-
state
Describes the current status of the component.
- Parameters:
state
- Describes the current status of the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
Describes the current status of the component.
This is a convenience method that creates an instance of theComponentState.Builder
avoiding the need to create one manually viaComponentState.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostate(ComponentState)
.- Parameters:
state
- a consumer that will call methods onComponentState.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The component type specifies whether Image Builder uses the component to build the image or only to test it.
- Parameters:
type
- The component type specifies whether Image Builder uses the component 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:
-
type
The component type specifies whether Image Builder uses the component to build the image or only to test it.
- Parameters:
type
- The component type specifies whether Image Builder uses the component 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:
-
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.
-
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.
-
changeDescription
The change description for the current version of the component.
- Parameters:
changeDescription
- The change description for the current version of the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dateCreated
The original creation date of the component.
- Parameters:
dateCreated
- The original creation date of the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
publisher
Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
- Parameters:
publisher
- Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
obfuscate
Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
- Parameters:
obfuscate
- Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-