Package software.amazon.awscdk

Interface GetContextKeyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

GetContextValueOptions

All Known Implementing Classes:

GetContextKeyOptions.Jsii$Proxy, GetContextValueOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:39:56.838Z")
@Stability(Stable)
public interface GetContextKeyOptions
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 Object props;
 GetContextKeyOptions getContextKeyOptions = GetContextKeyOptions.builder()
         .provider("provider")
         // the properties below are optional
         .additionalCacheKey("additionalCacheKey")
         .includeEnvironment(false)
         .props(Map.of(
                 "propsKey", props))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GetContextKeyOptions.Builder	A builder for GetContextKeyOptions
static final class	GetContextKeyOptions.Jsii$Proxy	An implementation for GetContextKeyOptions

Method Summary

Modifier and Type	Method	Description
static GetContextKeyOptions.Builder	builder()
default String	getAdditionalCacheKey()	Adds an additional discriminator to the cdk.context.json cache key.
default Boolean	getIncludeEnvironment()	Whether to include the stack's account and region automatically.
default Map<String,Object>	getProps()	Provider-specific properties.
String	getProvider()	The context provider to query.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProvider

@Stability(Stable)
@NotNull
String getProvider()

The context provider to query.

getAdditionalCacheKey

@Stability(Stable)
@Nullable
default String getAdditionalCacheKey()

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

Default: - no additional cache key

getIncludeEnvironment

@Stability(Stable)
@Nullable
default Boolean getIncludeEnvironment()

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

Default: true

getProps

@Stability(Stable)
@Nullable
default Map<String,Object> getProps()

Provider-specific properties.

builder

@Stability(Stable)
static GetContextKeyOptions.Builder builder()

Returns:

a GetContextKeyOptions.Builder of GetContextKeyOptions