software.amazon.awscdk.core

Class ContextProvider

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.ContextProvider

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.11.0 (build 1e9b8e1)",
           date="2020-09-03T17:04:05.320Z")
 @Stability(value=Experimental)
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.

EXPERIMENTAL

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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(Construct scope, GetContextKeyOptions options) EXPERIMENTAL
static GetContextValueResult	getValue(Construct scope, GetContextValueOptions options) EXPERIMENTAL

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, 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 Detail

ContextProvider

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

ContextProvider

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

Method Detail

getKey

@Stability(value=Experimental)
 @NotNull
public static GetContextKeyResult getKey(@NotNull
                                                                                  Construct scope,
                                                                                  @NotNull
                                                                                  GetContextKeyOptions options)

EXPERIMENTAL

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(value=Experimental)
 @NotNull
public static GetContextValueResult getValue(@NotNull
                                                                                      Construct scope,
                                                                                      @NotNull
                                                                                      GetContextValueOptions options)

EXPERIMENTAL

Parameters:

scope - This parameter is required.

options - This parameter is required.