Class ContextProvider

Base class for the model side of context providers.

Inheritance

object

ContextProvider

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ContextProvider : DeputyBase

Syntax (vb)

Public Class ContextProvider Inherits DeputyBase

Remarks

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.

Synopsis

Methods

GetKey(Construct, IGetContextKeyOptions)	Base class for the model side of context providers.
GetValue(Construct, IGetContextValueOptions)	Base class for the model side of context providers.

Methods

GetKey(Construct, IGetContextKeyOptions)

Base class for the model side of context providers.

public static IGetContextKeyResult GetKey(Construct scope, IGetContextKeyOptions options)

Parameters

scope Construct

options IGetContextKeyOptions

Returns

IGetContextKeyResult

the context key or undefined if a key cannot be rendered (due to tokens used in any of the props)

Remarks

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.

GetValue(Construct, IGetContextValueOptions)

Base class for the model side of context providers.

public static IGetContextValueResult GetValue(Construct scope, IGetContextValueOptions options)

Parameters

scope Construct

options IGetContextValueOptions

Returns

IGetContextValueResult

Remarks

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.