Parameter

class aws_cdk.aws_appconfig.Parameter(*args: Any, **kwargs)

Bases: object

Defines a parameter for an extension.

ExampleMetadata:: infused

Example:

# fn: lambda.Function


appconfig.Extension(self, "MyExtension",
    actions=[
        appconfig.Action(
            action_points=[appconfig.ActionPoint.ON_DEPLOYMENT_START],
            event_destination=appconfig.LambdaDestination(fn)
        )
    ],
    parameters=[
        appconfig.Parameter.required("testParam", "true"),
        appconfig.Parameter.not_required("testNotRequiredParam")
    ]
)

Attributes

description: The description of the parameter.

is_required: A boolean that indicates if the parameter is required or optional.

name: The name of the parameter.

value: The value of the parameter.

Static Methods

classmethod not_required(name, value=None, description=None)

An optional parameter for an extension.

Parameters:

name (str) – The name of the parameter.
value (Optional[str]) – The value of the parameter.
description (Optional[str]) – A description for the parameter.

Return type:

Parameter

classmethod required(name, value, description=None)

A required parameter for an extension.

Parameters:

name (str) – The name of the parameter.
value (str) – The value of the parameter.
description (Optional[str]) – A description for the parameter.

Return type:

Parameter