Package software.amazon.awscdk

Class FeatureFlags

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.FeatureFlags
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:02.194Z") @Stability(Stable) public class FeatureFlags extends software.amazon.jsii.JsiiObject
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 software.amazon.awscdk.*;
 FeatureFlags featureFlags = FeatureFlags.of(this);

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    FeatureFlags(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    FeatureFlags(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    isEnabled(String featureFlag)
    Check whether a feature flag is enabled.
    static FeatureFlags
    of(software.constructs.IConstruct scope)
    Inspect feature flags on the construct node's context.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • FeatureFlags

      protected FeatureFlags(software.amazon.jsii.JsiiObjectRef objRef)

    • FeatureFlags

      protected FeatureFlags(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • of

      @Stability(Stable) @NotNull public static FeatureFlags of(@NotNull software.constructs.IConstruct scope)
      Inspect feature flags on the construct node's context.

      Parameters:
      scope - This parameter is required.

    • isEnabled

      @Stability(Stable) @Nullable public Boolean isEnabled(@NotNull String featureFlag)
      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.

      Parameters:
      featureFlag - This parameter is required.