software.amazon.awscdk.core

Class ContextProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.ContextProvider

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:53.034Z")
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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ContextProvider(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static GetContextKeyResult	getKey(software.constructs.Construct scope, GetContextKeyOptions options)
static GetContextValueResult	getValue(software.constructs.Construct scope, GetContextValueOptions options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextProvider

protected ContextProvider(software.amazon.jsii.JsiiObjectRef objRef)

ContextProvider

protected ContextProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

getKey

public static GetContextKeyResult getKey(software.constructs.Construct scope,
                                         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

public static GetContextValueResult getValue(software.constructs.Construct scope,
                                             GetContextValueOptions options)

Parameters:

scope - This parameter is required.

options - This parameter is required.