GetContextValueOptions

class aws_cdk.GetContextValueOptions(*, provider, include_environment=None, props=None, dummy_value, ignore_error_on_missing_context=None)

Bases: GetContextKeyOptions

Parameters:

provider (str) – The context provider to query.
include_environment (Optional[bool]) – Whether to include the stack’s account and region automatically. Default: true
props (Optional[Mapping[str, Any]]) – Provider-specific properties.
dummy_value (Any) – The value to return if the context value was not found and a missing context is reported.
ignore_error_on_missing_context (Optional[bool]) – When True, the context provider will not throw an error if missing context is reported. Default: false

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 as cdk

# dummy_value: Any
# props: Any

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

    # the properties below are optional
    ignore_error_on_missing_context=False,
    include_environment=False,
    props={
        "props_key": props
    }
)

Attributes

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

ignore_error_on_missing_context

When True, the context provider will not throw an error if missing context is reported.

Default:: false

include_environment

Whether to include the stack’s account and region automatically.

Default:: true

props: Provider-specific properties.

provider: The context provider to query.