runway.cfngin.blueprints.type_defs module

CFNgin Blueprint type definitions.

class runway.cfngin.blueprints.type_defs.BlueprintVariableTypeDef[source]

Bases: runway.cfngin.blueprints.type_defs._RequiredBlueprintVariableTypeDef, runway.cfngin.blueprints.type_defs._OptionalBlueprintVariableTypeDef

Type definition for runway.cfngin.blueprints.base.Blueprint.VARIABLES items.

allowed_pattern

Only valid for variables whose type subclasses CFNType. A regular expression that represents the patterns you want to allow for the Cloudformation Parameter.

Type: str

allowed_values

Only valid for variables whose type subclasses CFNType. The values that should be allowed for the CloudFormation Parameter.

Type: List[Any]

constraint_description

Only valid for variables whose type subclasses CFNType. A string that explains the constraint when the constraint is violated for the CloudFormation Parameter.

Type: str

default

The default value that should be used for the variable if none is provided in the config.

Type: Any

description

A string that describes the purpose of the variable.

Type: str

max_length

Only valid for variables whose type subclasses CFNType. The maximum length of the value for the CloudFormation Parameter.

Type: int

max_value

Only valid for variables whose type subclasses CFNType. The max value for the CloudFormation Parameter.

Type: int

min_length

Only valid for variables whose type subclasses CFNType. The minimum length of the value for the CloudFormation Parameter.

Type: int

min_value

Only valid for variables whose type subclasses CFNType. The minimum value for the CloudFormation Parameter.

Type: int

no_echo

Only valid for variables whose type subclasses CFNType. Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*).

Type: bool

type

The type for the variable value. This can either be a native python type or one of the CFNgin variable types.

Type: Any

validator

An optional function that can do custom validation of the variable. A validator function should take a single argument, the value being validated, and should return the value if validation is successful. If there is an issue validating the value, an exception (ValueError, TypeError, etc) should be raised by the function.

Type: Callable[[Any], Any]