aws-cdk-lib.GetContextKeyOptions

GetContextKeyOptions Struct

Source

core/lib/context-provider.ts

Type last changed

v2.201.0 · 13 Jun 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';

declare const props: any;
const getContextKeyOptions: cdk.GetContextKeyOptions = {
  provider: 'provider',

  // the properties below are optional
  additionalCacheKey: 'additionalCacheKey',
  includeEnvironment: false,
  props: {
    propsKey: props,
  },
};

Properties

additionalCacheKey?optionalstringadditional_cache_key?optionalstradditionalCacheKey?optionalStringAdditionalCacheKey?optionalstringAdditionalCacheKey?optional*string#

Adds an additional discriminator to the `cdk.context.json` cache key.

Default: no additional cache key

includeEnvironment?optionalbooleaninclude_environment?optionalboolincludeEnvironment?optionalBooleanIncludeEnvironment?optionalboolIncludeEnvironment?optional*bool= true#

Whether to include the stack's account and region automatically.

props?optional{ [key: string]: any }props?optionaltyping.Mapping[str, Any]props?optionalMap<String, Object>Props?optionalIDictionary<string, object>Props?optional*map[string]interface{}#

Provider-specific properties.

providerstringproviderstrproviderStringProviderstringProvider*stringrequired#

The context provider to query.