CfnExperimentDefinitionProps

class aws_cdk.aws_appconfig.CfnExperimentDefinitionProps(*, application_identifier, audience_rule, configuration_profile_identifier, control, environment_identifier, flag_key, name, treatments, audience_description=None, hypothesis=None, launch_criteria=None, tags=None)

Bases: object

Properties for defining a CfnExperimentDefinition.

Parameters:
  • application_identifier (str) – The application ID, name, or ARN.

  • audience_rule (str) – Rule expression defining the experiment audience.

  • configuration_profile_identifier (str) – The configuration profile ID, name, or ARN.

  • control (Union[IResolvable, TreatmentProperty, Dict[str, Any]]) – A treatment variant with weight and flag value. The Key is auto-generated by the service.

  • environment_identifier (str) – The environment ID, name, or ARN.

  • flag_key (str) – The key of the existing flag in the configuration profile to experiment on.

  • name (str) – A name for the experiment definition.

  • treatments (Union[IResolvable, Sequence[Union[IResolvable, TreatmentProperty, Dict[str, Any]]]]) – Treatment variants (1-5).

  • audience_description (Optional[str]) – Human-readable description of the audience.

  • hypothesis (Optional[str]) – The hypothesis of the experiment.

  • launch_criteria (Optional[str]) – Criteria for launching the experiment.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to associate with the experiment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appconfig as appconfig

cfn_experiment_definition_props = appconfig.CfnExperimentDefinitionProps(
    application_identifier="applicationIdentifier",
    audience_rule="audienceRule",
    configuration_profile_identifier="configurationProfileIdentifier",
    control=appconfig.CfnExperimentDefinition.TreatmentProperty(
        enabled=False,
        weight=123,

        # the properties below are optional
        attribute_values={
            "attribute_values_key": appconfig.CfnExperimentDefinition.AttributeValueProperty(
                boolean_value=False,
                number_array=[123],
                number_value=123,
                string_array=["stringArray"],
                string_value="stringValue"
            )
        },
        description="description",
        key="key"
    ),
    environment_identifier="environmentIdentifier",
    flag_key="flagKey",
    name="name",
    treatments=[appconfig.CfnExperimentDefinition.TreatmentProperty(
        enabled=False,
        weight=123,

        # the properties below are optional
        attribute_values={
            "attribute_values_key": appconfig.CfnExperimentDefinition.AttributeValueProperty(
                boolean_value=False,
                number_array=[123],
                number_value=123,
                string_array=["stringArray"],
                string_value="stringValue"
            )
        },
        description="description",
        key="key"
    )],

    # the properties below are optional
    audience_description="audienceDescription",
    hypothesis="hypothesis",
    launch_criteria="launchCriteria",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

application_identifier

The application ID, name, or ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-applicationidentifier

audience_description

Human-readable description of the audience.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-audiencedescription

audience_rule

Rule expression defining the experiment audience.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-audiencerule

configuration_profile_identifier

The configuration profile ID, name, or ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-configurationprofileidentifier

control

A treatment variant with weight and flag value.

The Key is auto-generated by the service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-control

environment_identifier

The environment ID, name, or ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-environmentidentifier

flag_key

The key of the existing flag in the configuration profile to experiment on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-flagkey

hypothesis

The hypothesis of the experiment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-hypothesis

launch_criteria

Criteria for launching the experiment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-launchcriteria

name

A name for the experiment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-name

tags

Tags to associate with the experiment definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-tags

treatments

Treatment variants (1-5).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html#cfn-appconfig-experimentdefinition-treatments