FeatureFlag

class aws_cdk.cloud_assembly_schema.FeatureFlag(*, explanation=None, recommended_value=None, unconfigured_behaves_like=None, user_value=None)

Bases: object

A single feature flag.

Parameters:

  • explanation (Optional[str]) – Explanation about the purpose of this flag that can be shown to the user. Default: - No description

  • recommended_value (Any) – The library-recommended value for this flag, if any. It is possible that there is no recommended value. Default: - No recommended value.

  • unconfigured_behaves_like (Union[UnconfiguredBehavesLike, Dict[str, Any], None]) – 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

  • user_value (Any) – 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

Attributes

explanation

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

Default:

  • No description

recommended_value

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

It is possible that there is no recommended value.

Default:

  • No recommended value.

unconfigured_behaves_like

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

user_value

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