Interface IGetContextValueOptions

Namespace

Amazon.CDK

Assembly

Amazon.CDK.dll

public interface IGetContextValueOptions : IGetContextKeyOptions

Inherited Members

IGetContextKeyOptions.Provider

IGetContextKeyOptions.IncludeEnvironment

IGetContextKeyOptions.Props

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;

            var dummyValue;
            var props;
            var getContextValueOptions = new GetContextValueOptions {
                DummyValue = dummyValue,
                Provider = "provider",

                // the properties below are optional
                IncludeEnvironment = false,
                Props = new Dictionary<string, object> {
                    { "propsKey", props }
                }
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

DummyValue

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

object DummyValue { get; }

Property Value

object

Remarks

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