Package software.amazon.awscdk.cloud_assembly_schema

Interface FeatureFlag

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FeatureFlag.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:19.701Z")
@Stability(Stable)
public interface FeatureFlag
extends software.amazon.jsii.JsiiSerializable

A single feature flag.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 Object recommendedValue;
 Object userValue;
 Object v1;
 Object v2;
 FeatureFlag featureFlag = FeatureFlag.builder()
         .explanation("explanation")
         .recommendedValue(recommendedValue)
         .unconfiguredBehavesLike(UnconfiguredBehavesLike.builder()
                 .v1(v1)
                 .v2(v2)
                 .build())
         .userValue(userValue)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FeatureFlag.Builder	builder()
default String	getExplanation()	Explanation about the purpose of this flag that can be shown to the user.
default Object	getRecommendedValue()	The library-recommended value for this flag, if any.
default UnconfiguredBehavesLike	getUnconfiguredBehavesLike()	The value of the flag that produces the same behavior as when the flag is not configured at all.
default Object	getUserValue()	The value configured by the user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExplanation

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

Explanation about the purpose of this flag that can be shown to the user.

Default: - No description

getRecommendedValue

@Stability(Stable)
@Nullable
default Object getRecommendedValue()

The library-recommended value for this flag, if any.

It is possible that there is no recommended value.

Default: - No recommended value.

getUnconfiguredBehavesLike

@Stability(Stable)
@Nullable
default UnconfiguredBehavesLike getUnconfiguredBehavesLike()

The value of the flag that produces the same behavior as when the flag is not configured at all.

The structure of this field is a historical accident. The type of this field should have been boolean, which should have contained the default value for the flag appropriate for the current version of the CDK library. We are not rectifying this accident because doing so

Instead, the canonical way to access this value is by evaluating unconfiguredBehavesLike?.v2 ?? false.

Default: false

getUserValue

@Stability(Stable)
@Nullable
default Object getUserValue()

The value configured by the user.

This is the value configured at the root of the tree. Users may also have configured values at specific locations in the tree; we don't report on those.

Default: - Not configured by the user

builder

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

Returns:

a FeatureFlag.Builder of FeatureFlag