Class GetContextValueOptions
Inheritance
System.Object
GetContextValueOptions
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class GetContextValueOptions : Object, IGetContextValueOptions, IGetContextKeyOptions
Syntax (vb)
Public Class GetContextValueOptions
Inherits Object
Implements IGetContextValueOptions, IGetContextKeyOptions
Remarks
ExampleMetadata: fixture=_generated
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 }
}
};
Synopsis
Constructors
GetContextValueOptions() |
Properties
DummyValue | The value to return if the context value was not found and a missing context is reported. |
IncludeEnvironment | Whether to include the stack's account and region automatically. |
Props | Provider-specific properties. |
Provider | The context provider to query. |
Constructors
GetContextValueOptions()
public GetContextValueOptions()
Properties
DummyValue
The value to return if the context value was not found and a missing context is reported.
public object DummyValue { get; set; }
Property Value
System.Object
Remarks
This should be a dummy value that should preferably fail during deployment since it represents an invalid state.
IncludeEnvironment
Whether to include the stack's account and region automatically.
public Nullable<bool> IncludeEnvironment { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Props
Provider-specific properties.
public IDictionary<string, object> Props { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Provider
The context provider to query.
public string Provider { get; set; }
Property Value
System.String