ComponentDocumentParameterDefinition

class aws_cdk.aws_imagebuilder_alpha.ComponentDocumentParameterDefinition(*, type, default=None, description=None)

Bases: object

(experimental) The definition of the parameter.

Parameters:
  • type (ComponentParameterType) – (experimental) The type of the parameter.

  • default (Any) – (experimental) The default value of the parameter. Default: - none, indicating the parameter is required

  • description (Optional[str]) – (experimental) The description of the parameter. Default: None

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# 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"
)

Attributes

default

(experimental) The default value of the parameter.

Default:
  • none, indicating the parameter is required

Stability:

experimental

description

(experimental) The description of the parameter.

Default:

None

Stability:

experimental

type

(experimental) The type of the parameter.

Stability:

experimental