Package software.amazon.awscdk.services.imagebuilder.alpha

Interface ComponentConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComponentConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:50.012Z")
@Stability(Experimental)
public interface ComponentConfiguration
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration details for a component, to include in a recipe.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.alpha.*;
 Component component;
 ComponentParameterValue componentParameterValue;
 ComponentConfiguration componentConfiguration = ComponentConfiguration.builder()
         .component(component)
         // the properties below are optional
         .parameters(Map.of(
                 "parametersKey", componentParameterValue))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ComponentConfiguration.Builder	A builder for ComponentConfiguration
static final class	ComponentConfiguration.Jsii$Proxy	An implementation for ComponentConfiguration

Method Summary

Modifier and Type	Method	Description
static ComponentConfiguration.Builder	builder()
IComponent	getComponent()	(experimental) The component to execute as part of the image build.
default Map<String,ComponentParameterValue>	getParameters()	(experimental) The parameters to use when executing the component.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComponent

@Stability(Experimental)
@NotNull
IComponent getComponent()

(experimental) The component to execute as part of the image build.

getParameters

@Stability(Experimental)
@Nullable
default Map<String,ComponentParameterValue> getParameters()

(experimental) The parameters to use when executing the component.

Default: - no parameters. if the component contains parameters, their default values will be used. otherwise, any required parameters that are not included will result in a build failure

builder

@Stability(Experimental)
static ComponentConfiguration.Builder builder()

Returns:

a ComponentConfiguration.Builder of ComponentConfiguration