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

Experimental

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

ComponentDocumentParameterDefinition Struct

The definition of the parameter.

Stability

Experimental

Source

lib/component.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 default_: any;
const componentDocumentParameterDefinition: imagebuilder_alpha.ComponentDocumentParameterDefinition = {
  type: imagebuilder_alpha.ComponentParameterType.STRING,

  // the properties below are optional
  default: default_,
  description: 'description',
};

Properties

defaultanydefaultAnydefaultObjectDefaultobjectDefaultinterface{}#

The default value of the parameter.

Default: none, indicating the parameter is required

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= None#

The description of the parameter.

typeComponentParameterTypetypeComponentParameterTypetypeComponentParameterTypeTypeComponentParameterTypeTypeComponentParameterTyperequired#

The type of the parameter.