CfnExperimentDefinitionPropsMixin

class aws_cdk.cfn_property_mixins.aws_appconfig.CfnExperimentDefinitionPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::AppConfig::ExperimentDefinition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-experimentdefinition.html
CloudformationResource:: AWS::AppConfig::ExperimentDefinition
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_experiment_definition_props_mixin = appconfig.CfnExperimentDefinitionPropsMixin(appconfig.CfnExperimentDefinitionMixinProps(
    application_identifier="applicationIdentifier",
    audience_description="audienceDescription",
    audience_rule="audienceRule",
    configuration_profile_identifier="configurationProfileIdentifier",
    control=appconfig.CfnExperimentDefinitionPropsMixin.TreatmentProperty(
        attribute_values={
            "attribute_values_key": appconfig.CfnExperimentDefinitionPropsMixin.AttributeValueProperty(
                boolean_value=False,
                number_array=[123],
                number_value=123,
                string_array=["stringArray"],
                string_value="stringValue"
            )
        },
        description="description",
        enabled=False,
        key="key",
        weight=123
    ),
    environment_identifier="environmentIdentifier",
    flag_key="flagKey",
    hypothesis="hypothesis",
    launch_criteria="launchCriteria",
    name="name",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    treatments=[appconfig.CfnExperimentDefinitionPropsMixin.TreatmentProperty(
        attribute_values={
            "attribute_values_key": appconfig.CfnExperimentDefinitionPropsMixin.AttributeValueProperty(
                boolean_value=False,
                number_array=[123],
                number_value=123,
                string_array=["stringArray"],
                string_value="stringValue"
            )
        },
        description="description",
        enabled=False,
        key="key",
        weight=123
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::AppConfig::ExperimentDefinition.

Parameters:

props (Union[CfnExperimentDefinitionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationIdentifier', 'audienceDescription', 'audienceRule', 'configurationProfileIdentifier', 'control', 'environmentIdentifier', 'flagKey', 'hypothesis', 'launchCriteria', 'name', 'tags', 'treatments']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AttributeValueProperty

class CfnExperimentDefinitionPropsMixin.AttributeValueProperty(*, boolean_value=None, number_array=None, number_value=None, string_array=None, string_value=None)

Bases: object

A typed attribute value for a treatment flag.

Parameters:

boolean_value (Union[bool, IResolvable, None]) – A boolean value.
number_array (Union[Sequence[Union[int, float]], IResolvable, None]) – An array of numeric values.
number_value (Union[int, float, None]) – A numeric value.
string_array (Optional[Sequence[str]]) – An array of string values.
string_value (Optional[str]) – A string value.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

attribute_value_property = appconfig.CfnExperimentDefinitionPropsMixin.AttributeValueProperty(
    boolean_value=False,
    number_array=[123],
    number_value=123,
    string_array=["stringArray"],
    string_value="stringValue"
)

Attributes

boolean_value

A boolean value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-experimentdefinition-attributevalue.html#cfn-appconfig-experimentdefinition-attributevalue-booleanvalue

number_array

An array of numeric values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-experimentdefinition-attributevalue.html#cfn-appconfig-experimentdefinition-attributevalue-numberarray

number_value

A numeric value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-experimentdefinition-attributevalue.html#cfn-appconfig-experimentdefinition-attributevalue-numbervalue

string_array

An array of string values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-experimentdefinition-attributevalue.html#cfn-appconfig-experimentdefinition-attributevalue-stringarray

string_value

A string value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-experimentdefinition-attributevalue.html#cfn-appconfig-experimentdefinition-attributevalue-stringvalue

TreatmentProperty

class CfnExperimentDefinitionPropsMixin.TreatmentProperty(*, attribute_values=None, description=None, enabled=None, key=None, weight=None)

Bases: object

A treatment variant with weight and flag value.

The Key is auto-generated by the service.

Parameters:

attribute_values (Union[IResolvable, Mapping[str, Union[IResolvable, AttributeValueProperty, Dict[str, Any]]], None]) – Map of attribute name to attribute value.
description (Optional[str])
enabled (Union[bool, IResolvable, None]) – Whether the flag is enabled for this variant.
key (Optional[str]) – The treatment key (read-only, auto-generated by service).
weight (Union[int, float, None]) – Traffic weight percentage.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

treatment_property = appconfig.CfnExperimentDefinitionPropsMixin.TreatmentProperty(
    attribute_values={
        "attribute_values_key": appconfig.CfnExperimentDefinitionPropsMixin.AttributeValueProperty(
            boolean_value=False,
            number_array=[123],
            number_value=123,
            string_array=["stringArray"],
            string_value="stringValue"
        )
    },
    description="description",
    enabled=False,
    key="key",
    weight=123
)