awsevidently

package
v1.148.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 10, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnExperiment_CFN_RESOURCE_TYPE_NAME 

func CfnExperiment_CFN_RESOURCE_TYPE_NAME() *string

func CfnExperiment_IsCfnElement 

func CfnExperiment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnExperiment_IsCfnResource 

func CfnExperiment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnExperiment_IsConstruct 

func CfnExperiment_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnFeature_CFN_RESOURCE_TYPE_NAME 

func CfnFeature_CFN_RESOURCE_TYPE_NAME() *string

func CfnFeature_IsCfnElement 

func CfnFeature_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnFeature_IsCfnResource 

func CfnFeature_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFeature_IsConstruct 

func CfnFeature_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnLaunch_CFN_RESOURCE_TYPE_NAME 

func CfnLaunch_CFN_RESOURCE_TYPE_NAME() *string

func CfnLaunch_IsCfnElement 

func CfnLaunch_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnLaunch_IsCfnResource 

func CfnLaunch_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnLaunch_IsConstruct 

func CfnLaunch_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnProject_CFN_RESOURCE_TYPE_NAME 

func CfnProject_CFN_RESOURCE_TYPE_NAME() *string

func CfnProject_IsCfnElement 

func CfnProject_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnProject_IsCfnResource 

func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnProject_IsConstruct 

func CfnProject_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnExperiment_Override 

func NewCfnExperiment_Override(c CfnExperiment, scope awscdk.Construct, id *string, props *CfnExperimentProps)

Create a new `AWS::Evidently::Experiment`.

func NewCfnFeature_Override 

func NewCfnFeature_Override(c CfnFeature, scope awscdk.Construct, id *string, props *CfnFeatureProps)

Create a new `AWS::Evidently::Feature`.

func NewCfnLaunch_Override 

func NewCfnLaunch_Override(c CfnLaunch, scope awscdk.Construct, id *string, props *CfnLaunchProps)

Create a new `AWS::Evidently::Launch`.

func NewCfnProject_Override 

func NewCfnProject_Override(c CfnProject, scope awscdk.Construct, id *string, props *CfnProjectProps)

Create a new `AWS::Evidently::Project`.

Types

type CfnExperiment 

type CfnExperiment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	MetricGoals() interface{}
	SetMetricGoals(val interface{})
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	OnlineAbConfig() interface{}
	SetOnlineAbConfig(val interface{})
	Project() *string
	SetProject(val *string)
	RandomizationSalt() *string
	SetRandomizationSalt(val *string)
	Ref() *string
	SamplingRate() *float64
	SetSamplingRate(val *float64)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Treatments() interface{}
	SetTreatments(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Evidently::Experiment`.

Creates or updates an Evidently *experiment* . Before you create an experiment, you must create the feature to use for the experiment.

An experiment helps you make feature design decisions based on evidence and data. An experiment can test as many as five variations at once. Evidently collects experiment data and analyzes it by statistical methods, and provides clear recommendations about which variations perform better.

TODO: EXAMPLE

func NewCfnExperiment 

func NewCfnExperiment(scope awscdk.Construct, id *string, props *CfnExperimentProps) CfnExperiment

Create a new `AWS::Evidently::Experiment`.

type CfnExperimentProps 

type CfnExperimentProps struct {
	// An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
	//
	// You can use up to three metrics in an experiment.
	MetricGoals interface{} `json:"metricGoals" yaml:"metricGoals"`
	// A name for the new experiment.
	Name *string `json:"name" yaml:"name"`
	// A structure that contains the configuration of which variation to use as the "control" version.
	//
	// The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
	OnlineAbConfig interface{} `json:"onlineAbConfig" yaml:"onlineAbConfig"`
	// The name or the ARN of the project where this experiment is to be created.
	Project *string `json:"project" yaml:"project"`
	// An array of structures that describe the configuration of each feature variation used in the experiment.
	Treatments interface{} `json:"treatments" yaml:"treatments"`
	// An optional description of the experiment.
	Description *string `json:"description" yaml:"description"`
	// When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served.
	//
	// This randomization ID is a combination of the entity ID and `randomizationSalt` . If you omit `randomizationSalt` , Evidently uses the experiment name as the `randomizationSalt` .
	RandomizationSalt *string `json:"randomizationSalt" yaml:"randomizationSalt"`
	// The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
	//
	// The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
	//
	// This is represented in thousandths of a percent. For example, specify 10,000 to allocate 10% of the available audience.
	SamplingRate *float64 `json:"samplingRate" yaml:"samplingRate"`
	// Assigns one or more tags (key-value pairs) to the experiment.
	//
	// Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
	//
	// Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
	//
	// You can associate as many as 50 tags with an experiment.
	//
	// For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnExperiment`.

TODO: EXAMPLE

type CfnExperiment_MetricGoalObjectProperty 

type CfnExperiment_MetricGoalObjectProperty struct {
	// `INCREASE` means that a variation with a higher number for this metric is performing better.
	//
	// `DECREASE` means that a variation with a lower number for this metric is performing better.
	DesiredChange *string `json:"desiredChange" yaml:"desiredChange"`
	// The entity, such as a user or session, that does an action that causes a metric value to be recorded.
	//
	// An example is `userDetails.userID` .
	EntityIdKey *string `json:"entityIdKey" yaml:"entityIdKey"`
	// The EventBridge event pattern that defines how the metric is recorded.
	//
	// For more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) .
	EventPattern *string `json:"eventPattern" yaml:"eventPattern"`
	// A name for the metric.
	//
	// It can include up to 255 characters.
	MetricName *string `json:"metricName" yaml:"metricName"`
	// The JSON path to reference the numerical metric value in the event.
	ValueKey *string `json:"valueKey" yaml:"valueKey"`
	// A label for the units that the metric is measuring.
	UnitLabel *string `json:"unitLabel" yaml:"unitLabel"`
}

Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

TODO: EXAMPLE

type CfnExperiment_OnlineAbConfigObjectProperty 

type CfnExperiment_OnlineAbConfigObjectProperty struct {
	// The name of the variation that is to be the default variation that the other variations are compared to.
	ControlTreatmentName *string `json:"controlTreatmentName" yaml:"controlTreatmentName"`
	// A set of key-value pairs.
	//
	// The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation.
	TreatmentWeights interface{} `json:"treatmentWeights" yaml:"treatmentWeights"`
}

A structure that contains the configuration of which variation to use as the "control" version.

The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.

TODO: EXAMPLE

type CfnExperiment_TreatmentObjectProperty 

type CfnExperiment_TreatmentObjectProperty struct {
	// The name of the feature for this experiment.
	Feature *string `json:"feature" yaml:"feature"`
	// A name for this treatment.
	//
	// It can include up to 127 characters.
	TreatmentName *string `json:"treatmentName" yaml:"treatmentName"`
	// The name of the variation to use for this treatment.
	Variation *string `json:"variation" yaml:"variation"`
	// The description of the treatment.
	Description *string `json:"description" yaml:"description"`
}

A structure that defines one treatment in an experiment.

A treatment is a variation of the feature that you are including in the experiment.

TODO: EXAMPLE

type CfnExperiment_TreatmentToWeightProperty 

type CfnExperiment_TreatmentToWeightProperty struct {
	// The portion of experiment traffic to allocate to this treatment.
	//
	// Specify the traffic portion in thousandths of a percent, so 20,000 allocated to a treatment would allocate 20% of the experiment traffic to that treatment.
	SplitWeight *float64 `json:"splitWeight" yaml:"splitWeight"`
	// The name of the treatment.
	Treatment *string `json:"treatment" yaml:"treatment"`
}

This structure defines how much experiment traffic to allocate to one treatment used in the experiment.

TODO: EXAMPLE

type CfnFeature 

type CfnFeature interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultVariation() *string
	SetDefaultVariation(val *string)
	Description() *string
	SetDescription(val *string)
	EntityOverrides() interface{}
	SetEntityOverrides(val interface{})
	EvaluationStrategy() *string
	SetEvaluationStrategy(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Project() *string
	SetProject(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Variations() interface{}
	SetVariations(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Evidently::Feature`.

Creates or updates an Evidently *feature* that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see [CreateProject](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateProject.html) .

TODO: EXAMPLE

func NewCfnFeature 

func NewCfnFeature(scope awscdk.Construct, id *string, props *CfnFeatureProps) CfnFeature

Create a new `AWS::Evidently::Feature`.

type CfnFeatureProps 

type CfnFeatureProps struct {
	// The name for the feature.
	//
	// It can include up to 127 characters.
	Name *string `json:"name" yaml:"name"`
	// The name or ARN of the project that is to contain the new feature.
	Project *string `json:"project" yaml:"project"`
	// An array of structures that contain the configuration of the feature's different variations.
	//
	// Each `VariationObject` in the `Variations` array for a feature must have the same type of value ( `BooleanValue` , `DoubleValue` , `LongValue` or `StringValue` ).
	Variations interface{} `json:"variations" yaml:"variations"`
	// The name of the variation to use as the default variation.
	//
	// The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.
	//
	// This variation must also be listed in the `Variations` structure.
	//
	// If you omit `DefaultVariation` , the first variation listed in the `Variations` structure is used as the default variation.
	DefaultVariation *string `json:"defaultVariation" yaml:"defaultVariation"`
	// An optional description of the feature.
	Description *string `json:"description" yaml:"description"`
	// Specify users that should always be served a specific variation of a feature.
	//
	// Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.
	EntityOverrides interface{} `json:"entityOverrides" yaml:"entityOverrides"`
	// Specify `ALL_RULES` to activate the traffic allocation specified by any ongoing launches or experiments.
	//
	// Specify `DEFAULT_VARIATION` to serve the default variation to all users instead.
	EvaluationStrategy *string `json:"evaluationStrategy" yaml:"evaluationStrategy"`
	// Assigns one or more tags (key-value pairs) to the feature.
	//
	// Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
	//
	// Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
	//
	// You can associate as many as 50 tags with a feature.
	//
	// For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnFeature`.

TODO: EXAMPLE

type CfnFeature_EntityOverrideProperty 

type CfnFeature_EntityOverrideProperty struct {
	// The entity ID to be served the variation specified in `Variation` .
	EntityId *string `json:"entityId" yaml:"entityId"`
	// The name of the variation to serve to the user session that matches the `EntityId` .
	Variation *string `json:"variation" yaml:"variation"`
}

A set of key-value pairs that specify users who should always be served a specific variation of a feature.

Each key specifies a user using their user ID, account ID, or some other identifier. The value specifies the name of the variation that the user is to be served.

TODO: EXAMPLE

type CfnFeature_VariationObjectProperty 

type CfnFeature_VariationObjectProperty struct {
	// The value assigned to this variation, if the variation type is boolean.
	BooleanValue interface{} `json:"booleanValue" yaml:"booleanValue"`
	// The value assigned to this variation, if the variation type is a double.
	DoubleValue *float64 `json:"doubleValue" yaml:"doubleValue"`
	// The value assigned to this variation, if the variation type is a long.
	LongValue *float64 `json:"longValue" yaml:"longValue"`
	// The value assigned to this variation, if the variation type is a string.
	StringValue *string `json:"stringValue" yaml:"stringValue"`
	// A name for the variation.
	//
	// It can include up to 127 characters.
	VariationName *string `json:"variationName" yaml:"variationName"`
}

This structure contains the name and variation value of one variation of a feature.

It can contain only one of the following parameters: `BooleanValue` , `DoubleValue` , `LongValue` or `StringValue` .

TODO: EXAMPLE

type CfnLaunch 

type CfnLaunch interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	Groups() interface{}
	SetGroups(val interface{})
	LogicalId() *string
	MetricMonitors() interface{}
	SetMetricMonitors(val interface{})
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Project() *string
	SetProject(val *string)
	RandomizationSalt() *string
	SetRandomizationSalt(val *string)
	Ref() *string
	ScheduledSplitsConfig() interface{}
	SetScheduledSplitsConfig(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Evidently::Launch`.

Creates or updates a *launch* of a given feature. Before you create a launch, you must create the feature to use for the launch.

You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.

TODO: EXAMPLE

func NewCfnLaunch 

func NewCfnLaunch(scope awscdk.Construct, id *string, props *CfnLaunchProps) CfnLaunch

Create a new `AWS::Evidently::Launch`.

type CfnLaunchProps 

type CfnLaunchProps struct {
	// An array of structures that contains the feature and variations that are to be used for the launch.
	//
	// You can up to five launch groups in a launch.
	Groups interface{} `json:"groups" yaml:"groups"`
	// The name for the launch.
	//
	// It can include up to 127 characters.
	Name *string `json:"name" yaml:"name"`
	// The name or ARN of the project that you want to create the launch in.
	Project *string `json:"project" yaml:"project"`
	// An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.
	ScheduledSplitsConfig interface{} `json:"scheduledSplitsConfig" yaml:"scheduledSplitsConfig"`
	// An optional description for the launch.
	Description *string `json:"description" yaml:"description"`
	// An array of structures that define the metrics that will be used to monitor the launch performance.
	//
	// You can have up to three metric monitors in the array.
	MetricMonitors interface{} `json:"metricMonitors" yaml:"metricMonitors"`
	// When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served.
	//
	// This randomization ID is a combination of the entity ID and `randomizationSalt` . If you omit `randomizationSalt` , Evidently uses the launch name as the `randomizationsSalt` .
	RandomizationSalt *string `json:"randomizationSalt" yaml:"randomizationSalt"`
	// Assigns one or more tags (key-value pairs) to the launch.
	//
	// Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
	//
	// Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
	//
	// You can associate as many as 50 tags with a launch.
	//
	// For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnLaunch`.

TODO: EXAMPLE

type CfnLaunch_GroupToWeightProperty 

type CfnLaunch_GroupToWeightProperty struct {
	// The name of the launch group.
	//
	// It can include up to 127 characters.
	GroupName *string `json:"groupName" yaml:"groupName"`
	// The portion of launch traffic to allocate to this launch group.
	//
	// This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the launch audience to this launch group.
	SplitWeight *float64 `json:"splitWeight" yaml:"splitWeight"`
}

A structure containing the percentage of launch traffic to allocate to one launch group.

TODO: EXAMPLE

type CfnLaunch_LaunchGroupObjectProperty 

type CfnLaunch_LaunchGroupObjectProperty struct {
	// The feature that this launch is using.
	Feature *string `json:"feature" yaml:"feature"`
	// A name for this launch group.
	//
	// It can include up to 127 characters.
	GroupName *string `json:"groupName" yaml:"groupName"`
	// The feature variation to use for this launch group.
	Variation *string `json:"variation" yaml:"variation"`
	// A description of the launch group.
	Description *string `json:"description" yaml:"description"`
}

A structure that defines one launch group in a launch.

A launch group is a variation of the feature that you are including in the launch.

TODO: EXAMPLE

type CfnLaunch_MetricDefinitionObjectProperty 

type CfnLaunch_MetricDefinitionObjectProperty struct {
	// The entity, such as a user or session, that does an action that causes a metric value to be recorded.
	//
	// An example is `userDetails.userID` .
	EntityIdKey *string `json:"entityIdKey" yaml:"entityIdKey"`
	// The EventBridge event pattern that defines how the metric is recorded.
	//
	// For more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) .
	EventPattern *string `json:"eventPattern" yaml:"eventPattern"`
	// A name for the metric.
	//
	// It can include up to 255 characters.
	MetricName *string `json:"metricName" yaml:"metricName"`
	// The value that is tracked to produce the metric.
	ValueKey *string `json:"valueKey" yaml:"valueKey"`
	// A label for the units that the metric is measuring.
	UnitLabel *string `json:"unitLabel" yaml:"unitLabel"`
}

This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.

TODO: EXAMPLE

type CfnLaunch_StepConfigProperty 

type CfnLaunch_StepConfigProperty struct {
	// An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch.
	GroupWeights interface{} `json:"groupWeights" yaml:"groupWeights"`
	// The date and time to start this step of the launch.
	//
	// Use UTC format, `yyyy-MM-ddTHH:mm:ssZ` . For example, `2025-11-25T23:59:59Z`
	StartTime *string `json:"startTime" yaml:"startTime"`
}

A structure that defines when each step of the launch is to start, and how much launch traffic is to be allocated to each variation during each step.

TODO: EXAMPLE

type CfnProject 

type CfnProject interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DataDelivery() interface{}
	SetDataDelivery(val interface{})
	Description() *string
	SetDescription(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Evidently::Project`.

Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments. Use projects to group similar features together.

TODO: EXAMPLE

func NewCfnProject 

func NewCfnProject(scope awscdk.Construct, id *string, props *CfnProjectProps) CfnProject

Create a new `AWS::Evidently::Project`.

type CfnProjectProps 

type CfnProjectProps struct {
	// The name for the project.
	//
	// It can include up to 127 characters.
	Name *string `json:"name" yaml:"name"`
	// A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so.
	//
	// If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view.
	//
	// You can't specify both `CloudWatchLogs` and `S3Destination` in the same operation.
	DataDelivery interface{} `json:"dataDelivery" yaml:"dataDelivery"`
	// An optional description of the project.
	Description *string `json:"description" yaml:"description"`
	// Assigns one or more tags (key-value pairs) to the project.
	//
	// Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
	//
	// Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
	//
	// You can associate as many as 50 tags with a project.
	//
	// For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnProject`.

TODO: EXAMPLE

type CfnProject_DataDeliveryObjectProperty 

type CfnProject_DataDeliveryObjectProperty struct {
	// If the project stores evaluation events in CloudWatch Logs , this structure stores the log group name.
	LogGroup *string `json:"logGroup" yaml:"logGroup"`
	// If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
	S3 interface{} `json:"s3" yaml:"s3"`
}

A structure that contains information about where Evidently is to store evaluation events for longer term storage.

TODO: EXAMPLE

type CfnProject_S3DestinationProperty 

type CfnProject_S3DestinationProperty struct {
	// The name of the bucket in which Evidently stores evaluation events.
	BucketName *string `json:"bucketName" yaml:"bucketName"`
	// The bucket prefix in which Evidently stores evaluation events.
	Prefix *string `json:"prefix" yaml:"prefix"`
}

If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.