interface FeatureFlag
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CloudAssembly.Schema.FeatureFlag |
 Java | software.amazon.awscdk.cloudassembly.schema.FeatureFlag |
 Python | aws_cdk.cloud_assembly_schema.FeatureFlag |
 TypeScript | @aws-cdk/cloud-assembly-schema » FeatureFlag |
A single feature flag.
Properties
| Name | Type | Description |
|---|---|---|
| explanation? | string | Explanation about the purpose of this flag that can be shown to the user. |
| recommended | any | The library-recommended value for this flag, if any. |
| unconfigured | Unconfigured | The value of the flag that produces the same behavior as when the flag is not configured at all. |
| user | any | The value configured by the user. |
explanation?
Type:
string
(optional, default: No description)
Explanation about the purpose of this flag that can be shown to the user.
recommendedValue?
Type:
any
(optional, default: No recommended value.)
The library-recommended value for this flag, if any.
It is possible that there is no recommended value.
unconfiguredBehavesLike?
Type:
Unconfigured
(optional, default: false)
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.
userValue?
Type:
any
(optional, default: Not configured by the user)
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.