Package software.amazon.awscdk
Class ContextProvider
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.ContextProvider
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2025-01-15T21:09:13.239Z")
@Stability(Stable)
public class ContextProvider
extends software.amazon.jsii.JsiiObject
Base class for the model side of context providers.
Instances of this class communicate with context provider plugins in the 'cdk toolkit' via context variables (input), outputting specialized queries for more context variables (output).
ContextProvider needs access to a Construct to hook into the context mechanism.
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Constructor Summary
ModifierConstructorDescriptionprotected
ContextProvider
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
ContextProvider
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionstatic GetContextKeyResult
getKey
(software.constructs.Construct scope, GetContextKeyOptions options) static GetContextValueResult
getValue
(software.constructs.Construct scope, GetContextValueOptions options) Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
ContextProvider
protected ContextProvider(software.amazon.jsii.JsiiObjectRef objRef) -
ContextProvider
protected ContextProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
-
-
Method Details
-
getKey
@Stability(Stable) @NotNull public static GetContextKeyResult getKey(@NotNull software.constructs.Construct scope, @NotNull GetContextKeyOptions options) - Parameters:
scope
- This parameter is required.options
- This parameter is required.- Returns:
- the context key or undefined if a key cannot be rendered (due to tokens used in any of the props)
-
getValue
@Stability(Stable) @NotNull public static GetContextValueResult getValue(@NotNull software.constructs.Construct scope, @NotNull GetContextValueOptions options) - Parameters:
scope
- This parameter is required.options
- This parameter is required.
-