Package software.amazon.awscdk

Interface GetContextValueOptions

All Superinterfaces:

GetContextKeyOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GetContextValueOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:55.798Z")
@Stability(Stable)
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.*;
 Object dummyValue;
 Object props;
 GetContextValueOptions getContextValueOptions = GetContextValueOptions.builder()
         .dummyValue(dummyValue)
         .provider("provider")
         // the properties below are optional
         .ignoreErrorOnMissingContext(false)
         .includeEnvironment(false)
         .props(Map.of(
                 "propsKey", props))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GetContextValueOptions.Builder	builder()
Object	getDummyValue()	The value to return if the context value was not found and a missing context is reported.
default Boolean	getIgnoreErrorOnMissingContext()	When True, the context provider will not throw an error if missing context is reported.

Methods inherited from interface software.amazon.awscdk.GetContextKeyOptions

getIncludeEnvironment, getProps, getProvider

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDummyValue

@Stability(Stable)
@NotNull
Object getDummyValue()

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

getIgnoreErrorOnMissingContext

@Stability(Stable)
@Nullable
default Boolean getIgnoreErrorOnMissingContext()

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

Default: false

builder

@Stability(Stable)
static GetContextValueOptions.Builder builder()

Returns:

a GetContextValueOptions.Builder of GetContextValueOptions