Interface Component.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Component.Builder,
,Component> SdkBuilder<Component.Builder,
,Component> SdkPojo
- Enclosing class:
Component
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the component.changeDescription
(String changeDescription) Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.Component data contains the YAML document content for the component.dateCreated
(String dateCreated) The date that Image Builder created the component.description
(String description) The description of the component.The encryption status of the component.The KMS key identifier used to encrypt 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.parameters
(Collection<ComponentParameterDetail> parameters) Contains parameter details for each of the parameters that the component document defined for the component.parameters
(Consumer<ComponentParameterDetail.Builder>... parameters) Contains parameter details for each of the parameters that the component document defined for the component.parameters
(ComponentParameterDetail... parameters) Contains parameter details for each of the parameters that the component document defined for 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 Component.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 supported by the component.supportedOsVersions
(Collection<String> supportedOsVersions) The operating system (OS) version supported by the component.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.
-
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
Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.
- Parameters:
changeDescription
- Describes what change has been made in this version of the component, 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.
-
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:
-
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 supported by the component. 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 supported by the component. 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 supported by the component. 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 supported by the component. 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. This is used for components that are no longer active.
- Parameters:
state
- Describes the current status of the component. This is used for components that are no longer active.- 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 used for components that are no longer active.
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:
-
parameters
Contains parameter details for each of the parameters that the component document defined for the component.
- Parameters:
parameters
- Contains parameter details for each of the parameters that the component document defined for the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
Contains parameter details for each of the parameters that the component document defined for the component.
- Parameters:
parameters
- Contains parameter details for each of the parameters that the component document defined for the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
Contains parameter details for each of the parameters that the component document defined for the component.
This is a convenience method that creates an instance of theComponentParameterDetail.Builder
avoiding the need to create one manually viaComponentParameterDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameters(List<ComponentParameterDetail>)
.- Parameters:
parameters
- a consumer that will call methods onComponentParameterDetail.Builder
- 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.
-
data
Component data contains the YAML document content for the component.
- Parameters:
data
- Component data contains the YAML document content for the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The KMS key identifier used to encrypt the component.
- Parameters:
kmsKeyId
- The KMS key identifier used to encrypt the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encrypted
The encryption status of the component.
- Parameters:
encrypted
- The encryption status of the component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dateCreated
The date that Image Builder created the component.
- Parameters:
dateCreated
- The date that Image Builder created 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.
-