@aws-cdk/aws-imagebuilder-alpha.ComponentConfiguration

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.

Stability

Experimental

Source

lib/recipe-base.ts

Example

// 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,
  },
};

Properties

componentIComponentcomponentIComponentcomponentIComponentComponentIComponentComponentIComponentrequired#

The component to execute as part of the image build.

parameters{ [key: string]: ComponentParameterValue }parameterstyping.Mapping[str, ComponentParameterValue]parametersMap<String, ComponentParameterValue>ParametersIDictionary<string, ComponentParameterValue>Parameters*map[string]ComponentParameterValue= no parameters. if the component …#

The parameters to use when executing the component.

default

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