interface GetContextKeyOptions

Language	Type name
.NET	Amazon.CDK.GetContextKeyOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2#GetContextKeyOptions
Java	software.amazon.awscdk.GetContextKeyOptions
Python	aws_cdk.GetContextKeyOptions
TypeScript (source)	aws-cdk-lib » GetContextKeyOptions

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

Name	Type	Description
provider	string	The context provider to query.
additionalCacheKey?	string	Adds an additional discriminator to the cdk.context.json cache key.
includeEnvironment?	boolean	Whether to include the stack's account and region automatically.
props?	{ [string]: any }	Provider-specific properties.

---

provider

Type: string

The context provider to query.

---

additionalCacheKey?

Type: string (optional, default: no additional cache key)

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

---

includeEnvironment?

Type: boolean (optional, default: true)

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

---

props?

Type: { [string]: any } (optional)

Provider-specific properties.