Experimental
@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ComponentConfiguration Struct
Configuration details for a component, to include in a recipe.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as imagebuilder_alpha from '@aws-cdk/aws-imagebuilder-alpha';
declare const component: imagebuilder_alpha.Component;
declare const componentParameterValue: imagebuilder_alpha.ComponentParameterValue;
const componentConfiguration: imagebuilder_alpha.ComponentConfiguration = {
component: component,
// the properties below are optional
parameters: {
parametersKey: componentParameterValue,
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_imagebuilder_alpha as imagebuilder_alpha
# component: imagebuilder_alpha.Component
# component_parameter_value: imagebuilder_alpha.ComponentParameterValue
component_configuration = imagebuilder_alpha.ComponentConfiguration(
component=component,
# the properties below are optional
parameters={
"parameters_key": component_parameter_value
}
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder.Alpha;
Component component;
ComponentParameterValue componentParameterValue;
var componentConfiguration = new ComponentConfiguration {
Component = component,
// the properties below are optional
Parameters = new Dictionary<string, ComponentParameterValue> {
{ "parametersKey", componentParameterValue }
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import imagebuilder_alpha "github.com/aws/aws-cdk-go/awsimagebuilderalpha"
var component Component
var componentParameterValue ComponentParameterValue
componentConfiguration := &ComponentConfiguration{
Component: component,
// the properties below are optional
Parameters: map[string]ComponentParameterValue{
"parametersKey": componentParameterValue,
},
}
Properties
componentIComponentcomponentIComponentcomponentIComponentComponentIComponentComponentIComponentrequired#The component to execute as part of the image build.
parametersoptional{ [key: string]: ComponentParameterValue }parametersoptionaltyping.Mapping[str, ComponentParameterValue]parametersoptionalMap<String, ComponentParameterValue>ParametersoptionalIDictionary<string, ComponentParameterValue>Parametersoptional*map[string]ComponentParameterValue#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