GetContextValueOptions

class aws_cdk.core.GetContextValueOptions(*, props=None, provider, dummy_value)

Bases: aws_cdk.core.GetContextKeyOptions

Parameters
  • props (Optional[Mapping[str, Any]]) – Provider-specific properties.

  • provider (str) – The context provider to query.

  • dummy_value (Any) – The value to return if the context value was not found and a missing context is reported. This should be a dummy value that should preferably fail during deployment since it represents an invalid state.

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.core as cdk

# dummy_value is of type object
# props is of type object

get_context_value_options = cdk.GetContextValueOptions(
    dummy_value=dummy_value,
    provider="provider",

    # the properties below are optional
    props={
        "props_key": props
    }
)

Attributes

dummy_value

The value to return if the context value was not found and a missing context is reported.

This should be a dummy value that should preferably fail during deployment since it represents an invalid state.

Return type

Any

props

Provider-specific properties.

Return type

Optional[Mapping[str, Any]]

provider

The context provider to query.

Return type

str