interface ComponentDocumentParameterDefinition 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.ComponentDocumentParameterDefinition
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#ComponentDocumentParameterDefinition
Java	software.amazon.awscdk.services.imagebuilder.alpha.ComponentDocumentParameterDefinition
Python	aws_cdk.aws_imagebuilder_alpha.ComponentDocumentParameterDefinition
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » ComponentDocumentParameterDefinition

The definition of the parameter.

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

Name	Type	Description
type🔹	ComponentParameterType	The type of the parameter.
default?🔹	any	The default value of the parameter.
description?🔹	string	The description of the parameter.

---

type🔹

Type: ComponentParameterType

The type of the parameter.

---

default?🔹

Type: any (optional, default: none, indicating the parameter is required)

The default value of the parameter.

---

description?🔹

Type: string (optional, default: None)

The description of the parameter.