Package software.amazon.awscdk.services.imagebuilder.alpha

Interface ComponentDocumentParameterDefinition

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ComponentDocumentParameterDefinition.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:34.441Z")
@Stability(Experimental)
public interface ComponentDocumentParameterDefinition
extends software.amazon.jsii.JsiiSerializable

(experimental) 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 software.amazon.awscdk.services.imagebuilder.alpha.*;
 Object default_;
 ComponentDocumentParameterDefinition componentDocumentParameterDefinition = ComponentDocumentParameterDefinition.builder()
         .type(ComponentParameterType.STRING)
         // the properties below are optional
         .default(default_)
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ComponentDocumentParameterDefinition.Builder	A builder for ComponentDocumentParameterDefinition
static final class	ComponentDocumentParameterDefinition.Jsii$Proxy	An implementation for ComponentDocumentParameterDefinition

Method Summary

Modifier and Type	Method	Description
static ComponentDocumentParameterDefinition.Builder	builder()
default Object	getDefaultValue()	(experimental) The default value of the parameter.
default String	getDescription()	(experimental) The description of the parameter.
ComponentParameterType	getType()	(experimental) The type of the parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Experimental)
@NotNull
ComponentParameterType getType()

(experimental) The type of the parameter.

getDefaultValue

@Stability(Experimental)
@Nullable
default Object getDefaultValue()

(experimental) The default value of the parameter.

Default: - none, indicating the parameter is required

getDescription

@Stability(Experimental)
@Nullable
default String getDescription()

(experimental) The description of the parameter.

Default: None

builder

@Stability(Experimental)
static ComponentDocumentParameterDefinition.Builder builder()

Returns:

a ComponentDocumentParameterDefinition.Builder of ComponentDocumentParameterDefinition