interface FeatureFlag
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.cloud_assembly_schema.FeatureFlag |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#FeatureFlag |
 Java | software.amazon.awscdk.cloud_assembly_schema.FeatureFlag |
 Python | aws_cdk.cloud_assembly_schema.FeatureFlag |
 TypeScript (source) | aws-cdk-lib » cloud_assembly_schema » FeatureFlag |
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 { cloud_assembly_schema } from 'aws-cdk-lib';
declare const recommendedValue: any;
declare const userValue: any;
const featureFlag: cloud_assembly_schema.FeatureFlag = {
explanation: 'explanation',
recommendedValue: recommendedValue,
userValue: userValue,
};
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. |
| 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.
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.