aws-cdk-lib.FeatureFlags

class FeatureFlags

LanguageType name
.NETAmazon.CDK.FeatureFlags
Gogithub.com/aws/aws-cdk-go/awscdk/v2#FeatureFlags
Javasoftware.amazon.awscdk.FeatureFlags
Pythonaws_cdk.FeatureFlags
TypeScript (source)aws-cdk-lib » FeatureFlags

Features that are implemented behind a flag in order to preserve backwards compatibility for existing apps.

The list of flags are available in the aws-cdk-lib/cx-api module.

The state of the flag for this application is stored as a CDK context variable.

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';
const featureFlags = cdk.FeatureFlags.of(this);

Methods

NameDescription
isEnabled(featureFlag)Check whether a feature flag is enabled.
static of(scope)Inspect feature flags on the construct node's context.

isEnabled(featureFlag)

public isEnabled(featureFlag: string): boolean

Parameters

  • featureFlag string

Returns

  • boolean

Check whether a feature flag is enabled.

If configured, the flag is present in the construct node context. Falls back to the defaults defined in the cx-api module.


static of(scope)

public static of(scope: IConstruct): FeatureFlags

Parameters

  • scope IConstruct

Returns

  • FeatureFlags

Inspect feature flags on the construct node's context.