Class ComponentConfiguration

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

Inheritance

object

ComponentConfiguration

Implements

IComponentConfiguration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ImageBuilder.Alpha

Assembly: Amazon.CDK.AWS.ImageBuilder.Alpha.dll

Syntax (csharp)

public class ComponentConfiguration : IComponentConfiguration

Syntax (vb)

Public Class ComponentConfiguration Implements IComponentConfiguration

Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

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

Synopsis

Constructors

ComponentConfiguration()

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

Properties

Component	(experimental) The component to execute as part of the image build.
Parameters	(experimental) The parameters to use when executing the component.

Constructors

ComponentConfiguration()

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

public ComponentConfiguration()

Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples

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

Properties

Component

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

public IComponent Component { get; set; }

Property Value

IComponent

Remarks

Stability: Experimental

Parameters

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

public IDictionary<string, ComponentParameterValue>? Parameters { get; set; }

Property Value

IDictionary<string, ComponentParameterValue>

Remarks

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

Stability: Experimental

Implements

IComponentConfiguration