Skip to content
v2.274.0

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ComponentParameterValue Class ​

The parameter value for a component parameter.

Example ​

ts
const parameterizedComponent = imagebuilder.Component.fromComponentName(
  this,
  'ParameterizedComponent',
  'my-parameterized-component'
);

const imageRecipe = new imagebuilder.ImageRecipe(this, 'ParameterizedImageRecipe', {
  baseImage: imagebuilder.BaseImage.fromSsmParameterName(
    '/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64'
  ),
  components: [
    {
      component: parameterizedComponent,
      parameters: {
        environment: imagebuilder.ComponentParameterValue.fromString('production'),
        version: imagebuilder.ComponentParameterValue.fromString('1.0.0')
      }
    }
  ]
});

Properties ​

valuestring[]valuetyping.List[str]valueList<String>Valuestring[]Value*[]*string#
The rendered parameter value.

Methods ​

fromString(value: string): ComponentParameterValue // chainable@staticmethod def from_string(value: str) -> ComponentParameterValuepublic static ComponentParameterValue fromString(String value)public static ComponentParameterValue FromString(string value)func FromString(Value *string) ComponentParameterValuestatic#
The value of the parameter as a string.
1 parameter

Parameters

  • valuevaluevaluevalueValue — The string value of the parameter.