GetContextValueOptions
- class aws_cdk.core.GetContextValueOptions(*, provider, include_environment=None, props=None, dummy_value)
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: trueprops (
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. This should be a dummy value that should preferably fail during deployment since it represents an invalid state.
- 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.core as cdk # dummy_value: Any # props: Any get_context_value_options = cdk.GetContextValueOptions( dummy_value=dummy_value, provider="provider", # the properties below are optional 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.
This should be a dummy value that should preferably fail during deployment since it represents an invalid state.
- include_environment
Whether to include the stack’s account and region automatically.
- Default:
true
- props
Provider-specific properties.
- provider
The context provider to query.