Skip to content
v2.277.0

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.

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_imagebuilder_alpha as imagebuilder_alpha

# default_: Any

component_document_parameter_definition = imagebuilder_alpha.ComponentDocumentParameterDefinition(
    type=imagebuilder_alpha.ComponentParameterType.STRING,

    # the properties below are optional
    default=default_,
    description="description"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
// 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;

var default_;

var componentDocumentParameterDefinition = new ComponentDocumentParameterDefinition {
    Type = ComponentParameterType.STRING,

    // the properties below are optional
    Default = default_,
    Description = "description"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import imagebuilder_alpha "github.com/aws/aws-cdk-go/awsimagebuilderalpha"

var default_ interface{}

componentDocumentParameterDefinition := &ComponentDocumentParameterDefinition{
	Type: imagebuilder_alpha.ComponentParameterType_STRING,

	// the properties below are optional
	Default: default_,
	Description: jsii.String("description"),
}

Properties ​

defaultoptionalanydefaultoptionalAnydefaultoptionalObjectDefaultoptionalobjectDefaultoptionalinterface{} #
The default value of the parameter.

Default: none, indicating the parameter is required

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string = None #
The description of the parameter.