Skip to content
v2.274.0

CfnExperimentDefinitionProps Struct ​

Properties for defining a CfnExperimentDefinition.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appconfig as appconfig } from 'aws-cdk-lib';
const cfnExperimentDefinitionProps: appconfig.CfnExperimentDefinitionProps = {
  applicationIdentifier: 'applicationIdentifier',
  audienceRule: 'audienceRule',
  configurationProfileIdentifier: 'configurationProfileIdentifier',
  control: {
    enabled: false,
    weight: 123,

    // the properties below are optional
    attributeValues: {
      attributeValuesKey: {
        booleanValue: false,
        numberArray: [123],
        numberValue: 123,
        stringArray: ['stringArray'],
        stringValue: 'stringValue',
      },
    },
    description: 'description',
    key: 'key',
  },
  environmentIdentifier: 'environmentIdentifier',
  flagKey: 'flagKey',
  name: 'name',
  treatments: [{
    enabled: false,
    weight: 123,

    // the properties below are optional
    attributeValues: {
      attributeValuesKey: {
        booleanValue: false,
        numberArray: [123],
        numberValue: 123,
        stringArray: ['stringArray'],
        stringValue: 'stringValue',
      },
    },
    description: 'description',
    key: 'key',
  }],

  // the properties below are optional
  audienceDescription: 'audienceDescription',
  hypothesis: 'hypothesis',
  launchCriteria: 'launchCriteria',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

applicationIdentifierstringapplication_identifierstrapplicationIdentifierStringApplicationIdentifierstringApplicationIdentifier*stringrequired#
The application ID, name, or ARN.
audienceDescriptionstringaudience_descriptionstraudienceDescriptionStringAudienceDescriptionstringAudienceDescription*string#
Human-readable description of the audience.
audienceRulestringaudience_rulestraudienceRuleStringAudienceRulestringAudienceRule*stringrequired#
Rule expression defining the experiment audience.
configurationProfileIdentifierstringconfiguration_profile_identifierstrconfigurationProfileIdentifierStringConfigurationProfileIdentifierstringConfigurationProfileIdentifier*stringrequired#
The configuration profile ID, name, or ARN.
controlIResolvable | CfnExperimentDefinition.TreatmentPropertycontroltyping.Union[IResolvable, TreatmentProperty]controlIResolvableControlIResolvableControlinterface{}required#
A treatment variant with weight and flag value.

The Key is auto-generated by the service.

environmentIdentifierstringenvironment_identifierstrenvironmentIdentifierStringEnvironmentIdentifierstringEnvironmentIdentifier*stringrequired#
The environment ID, name, or ARN.
flagKeystringflag_keystrflagKeyStringFlagKeystringFlagKey*stringrequired#
The key of the existing flag in the configuration profile to experiment on.
hypothesisstringhypothesisstrhypothesisStringHypothesisstringHypothesis*string#
The hypothesis of the experiment.
launchCriteriastringlaunch_criteriastrlaunchCriteriaStringLaunchCriteriastringLaunchCriteria*string#
Criteria for launching the experiment.
namestringnamestrnameStringNamestringName*stringrequired#
A name for the experiment definition.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Tags to associate with the experiment definition.
treatmentsIResolvable | IResolvable | CfnExperimentDefinition.TreatmentProperty[]treatmentstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TreatmentProperty]]]treatmentsIResolvableTreatmentsIResolvableTreatmentsinterface{}required#
Treatment variants (1-5).

Used as props by ​