software.amazon.awscdk.core

Interface GetContextValueOptions

All Superinterfaces:

GetContextKeyOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GetContextValueOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:58.824Z")
 @Stability(value=Experimental)
public interface GetContextValueOptions
extends software.amazon.jsii.JsiiSerializable, GetContextKeyOptions

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 Object dummyValue;
 Object props;
 GetContextValueOptions getContextValueOptions = GetContextValueOptions.builder()
         .dummyValue(dummyValue)
         .provider("provider")
         // the properties below are optional
         .includeEnvironment(false)
         .props(Map.of(
                 "propsKey", props))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GetContextValueOptions.Builder A builder for GetContextValueOptions
static class	GetContextValueOptions.Jsii$Proxy An implementation for GetContextValueOptions

Method Summary

Modifier and Type	Method and Description
static GetContextValueOptions.Builder	builder()
Object	getDummyValue() (experimental) The value to return if the context value was not found and a missing context is reported.

Methods inherited from interface software.amazon.awscdk.core.GetContextKeyOptions

getIncludeEnvironment, getProps, getProvider

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDummyValue

@Stability(value=Experimental)
 @NotNull
Object getDummyValue()

(experimental) 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.

builder

@Stability(value=Experimental)
static GetContextValueOptions.Builder builder()

Specified by:

builder in interface GetContextKeyOptions

Returns:

a GetContextValueOptions.Builder of GetContextValueOptions