Documentation ¶
Index ¶
- func CfnExperiment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnExperiment_IsCfnElement(x interface{}) *bool
- func CfnExperiment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnExperiment_IsConstruct(x interface{}) *bool
- func CfnFeature_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFeature_IsCfnElement(x interface{}) *bool
- func CfnFeature_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFeature_IsConstruct(x interface{}) *bool
- func CfnLaunch_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLaunch_IsCfnElement(x interface{}) *bool
- func CfnLaunch_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLaunch_IsConstruct(x interface{}) *bool
- func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProject_IsCfnElement(x interface{}) *bool
- func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnProject_IsConstruct(x interface{}) *bool
- func CfnSegment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSegment_IsCfnElement(x interface{}) *bool
- func CfnSegment_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSegment_IsConstruct(x interface{}) *bool
- func NewCfnExperiment_Override(c CfnExperiment, scope constructs.Construct, id *string, ...)
- func NewCfnFeature_Override(c CfnFeature, scope constructs.Construct, id *string, props *CfnFeatureProps)
- func NewCfnLaunch_Override(c CfnLaunch, scope constructs.Construct, id *string, props *CfnLaunchProps)
- func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
- func NewCfnSegment_Override(c CfnSegment, scope constructs.Construct, id *string, props *CfnSegmentProps)
- type CfnExperiment
- type CfnExperimentProps
- type CfnExperiment_MetricGoalObjectProperty
- type CfnExperiment_OnlineAbConfigObjectProperty
- type CfnExperiment_RunningStatusObjectProperty
- type CfnExperiment_TreatmentObjectProperty
- type CfnExperiment_TreatmentToWeightProperty
- type CfnFeature
- type CfnFeatureProps
- type CfnFeature_EntityOverrideProperty
- type CfnFeature_VariationObjectProperty
- type CfnLaunch
- type CfnLaunchProps
- type CfnLaunch_ExecutionStatusObjectProperty
- type CfnLaunch_GroupToWeightProperty
- type CfnLaunch_LaunchGroupObjectProperty
- type CfnLaunch_MetricDefinitionObjectProperty
- type CfnLaunch_SegmentOverrideProperty
- type CfnLaunch_StepConfigProperty
- type CfnProject
- type CfnProjectProps
- type CfnProject_AppConfigResourceObjectProperty
- type CfnProject_DataDeliveryObjectProperty
- type CfnProject_S3DestinationProperty
- type CfnSegment
- type CfnSegmentProps
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.
func CfnExperiment_IsCfnResource ¶
func CfnExperiment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnExperiment_IsConstruct ¶
func CfnExperiment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnFeature_IsCfnResource ¶
func CfnFeature_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnFeature_IsConstruct ¶
func CfnFeature_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnLaunch_IsCfnResource ¶
func CfnLaunch_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLaunch_IsConstruct ¶
func CfnLaunch_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnProject_IsCfnResource ¶
func CfnProject_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnProject_IsConstruct ¶
func CfnProject_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSegment_CFN_RESOURCE_TYPE_NAME ¶ added in v2.34.0
func CfnSegment_CFN_RESOURCE_TYPE_NAME() *string
func CfnSegment_IsCfnElement ¶ added in v2.34.0
func CfnSegment_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.
func CfnSegment_IsCfnResource ¶ added in v2.34.0
func CfnSegment_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnSegment_IsConstruct ¶ added in v2.34.0
func CfnSegment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnExperiment_Override ¶
func NewCfnExperiment_Override(c CfnExperiment, scope constructs.Construct, id *string, props *CfnExperimentProps)
func NewCfnFeature_Override ¶
func NewCfnFeature_Override(c CfnFeature, scope constructs.Construct, id *string, props *CfnFeatureProps)
func NewCfnLaunch_Override ¶
func NewCfnLaunch_Override(c CfnLaunch, scope constructs.Construct, id *string, props *CfnLaunchProps)
func NewCfnProject_Override ¶
func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
func NewCfnSegment_Override ¶ added in v2.34.0
func NewCfnSegment_Override(c CfnSegment, scope constructs.Construct, id *string, props *CfnSegmentProps)
Types ¶
type CfnExperiment ¶
type CfnExperiment interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the experiment. // // For example, `arn:aws:evidently:us-west-2:0123455678912:project/myProject/experiment/myExperiment`. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // An optional description of the experiment. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // 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. MetricGoals() interface{} SetMetricGoals(val interface{}) // A name for the new experiment. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // A structure that contains the configuration of which variation to use as the "control" version. OnlineAbConfig() interface{} SetOnlineAbConfig(val interface{}) // The name or the ARN of the project where this experiment is to be created. Project() *string SetProject(val *string) // 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. RandomizationSalt() *string SetRandomizationSalt(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // Set this to `true` to remove the segment that is associated with this experiment. RemoveSegment() interface{} SetRemoveSegment(val interface{}) // A structure that you can use to start and stop the experiment. RunningStatus() interface{} SetRunningStatus(val interface{}) // The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. SamplingRate() *float64 SetSamplingRate(val *float64) // Specifies an audience *segment* to use in the experiment. Segment() *string SetSegment(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Assigns one or more tags (key-value pairs) to the experiment. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // An array of structures that describe the configuration of each feature variation used in the experiment. Treatments() interface{} SetTreatments(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnExperiment := awscdk.Aws_evidently.NewCfnExperiment(this, jsii.String("MyCfnExperiment"), &CfnExperimentProps{ MetricGoals: []interface{}{ &MetricGoalObjectProperty{ DesiredChange: jsii.String("desiredChange"), EntityIdKey: jsii.String("entityIdKey"), MetricName: jsii.String("metricName"), ValueKey: jsii.String("valueKey"), // the properties below are optional EventPattern: jsii.String("eventPattern"), UnitLabel: jsii.String("unitLabel"), }, }, Name: jsii.String("name"), OnlineAbConfig: &OnlineAbConfigObjectProperty{ ControlTreatmentName: jsii.String("controlTreatmentName"), TreatmentWeights: []interface{}{ &TreatmentToWeightProperty{ SplitWeight: jsii.Number(123), Treatment: jsii.String("treatment"), }, }, }, Project: jsii.String("project"), Treatments: []interface{}{ &TreatmentObjectProperty{ Feature: jsii.String("feature"), TreatmentName: jsii.String("treatmentName"), Variation: jsii.String("variation"), // the properties below are optional Description: jsii.String("description"), }, }, // the properties below are optional Description: jsii.String("description"), RandomizationSalt: jsii.String("randomizationSalt"), RemoveSegment: jsii.Boolean(false), RunningStatus: &RunningStatusObjectProperty{ Status: jsii.String("status"), // the properties below are optional AnalysisCompleteTime: jsii.String("analysisCompleteTime"), DesiredState: jsii.String("desiredState"), Reason: jsii.String("reason"), }, SamplingRate: jsii.Number(123), Segment: jsii.String("segment"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html
func NewCfnExperiment ¶
func NewCfnExperiment(scope constructs.Construct, id *string, props *CfnExperimentProps) CfnExperiment
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-metricgoals // MetricGoals interface{} `field:"required" json:"metricGoals" yaml:"metricGoals"` // A name for the new experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-name // Name *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-onlineabconfig // OnlineAbConfig interface{} `field:"required" json:"onlineAbConfig" yaml:"onlineAbConfig"` // The name or the ARN of the project where this experiment is to be created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-project // Project *string `field:"required" json:"project" yaml:"project"` // An array of structures that describe the configuration of each feature variation used in the experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-treatments // Treatments interface{} `field:"required" json:"treatments" yaml:"treatments"` // An optional description of the experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-description // Description *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-randomizationsalt // RandomizationSalt *string `field:"optional" json:"randomizationSalt" yaml:"randomizationSalt"` // Set this to `true` to remove the segment that is associated with this experiment. // // You can't use this parameter if the experiment is currently running. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-removesegment // RemoveSegment interface{} `field:"optional" json:"removeSegment" yaml:"removeSegment"` // A structure that you can use to start and stop the experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-runningstatus // RunningStatus interface{} `field:"optional" json:"runningStatus" yaml:"runningStatus"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-samplingrate // SamplingRate *float64 `field:"optional" json:"samplingRate" yaml:"samplingRate"` // Specifies an audience *segment* to use in the experiment. // // When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. // // For more information, see [Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-segment // Segment *string `field:"optional" json:"segment" yaml:"segment"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html#cfn-evidently-experiment-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnExperiment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnExperimentProps := &CfnExperimentProps{ MetricGoals: []interface{}{ &MetricGoalObjectProperty{ DesiredChange: jsii.String("desiredChange"), EntityIdKey: jsii.String("entityIdKey"), MetricName: jsii.String("metricName"), ValueKey: jsii.String("valueKey"), // the properties below are optional EventPattern: jsii.String("eventPattern"), UnitLabel: jsii.String("unitLabel"), }, }, Name: jsii.String("name"), OnlineAbConfig: &OnlineAbConfigObjectProperty{ ControlTreatmentName: jsii.String("controlTreatmentName"), TreatmentWeights: []interface{}{ &TreatmentToWeightProperty{ SplitWeight: jsii.Number(123), Treatment: jsii.String("treatment"), }, }, }, Project: jsii.String("project"), Treatments: []interface{}{ &TreatmentObjectProperty{ Feature: jsii.String("feature"), TreatmentName: jsii.String("treatmentName"), Variation: jsii.String("variation"), // the properties below are optional Description: jsii.String("description"), }, }, // the properties below are optional Description: jsii.String("description"), RandomizationSalt: jsii.String("randomizationSalt"), RemoveSegment: jsii.Boolean(false), RunningStatus: &RunningStatusObjectProperty{ Status: jsii.String("status"), // the properties below are optional AnalysisCompleteTime: jsii.String("analysisCompleteTime"), DesiredState: jsii.String("desiredState"), Reason: jsii.String("reason"), }, SamplingRate: jsii.Number(123), Segment: jsii.String("segment"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-experiment.html
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-desiredchange // DesiredChange *string `field:"required" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-entityidkey // EntityIdKey *string `field:"required" json:"entityIdKey" yaml:"entityIdKey"` // A name for the metric. // // It can include up to 255 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-metricname // MetricName *string `field:"required" json:"metricName" yaml:"metricName"` // The JSON path to reference the numerical metric value in the event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-valuekey // ValueKey *string `field:"required" json:"valueKey" yaml:"valueKey"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-eventpattern // EventPattern *string `field:"optional" json:"eventPattern" yaml:"eventPattern"` // A label for the units that the metric is measuring. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-unitlabel // UnitLabel *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" metricGoalObjectProperty := &MetricGoalObjectProperty{ DesiredChange: jsii.String("desiredChange"), EntityIdKey: jsii.String("entityIdKey"), MetricName: jsii.String("metricName"), ValueKey: jsii.String("valueKey"), // the properties below are optional EventPattern: jsii.String("eventPattern"), UnitLabel: jsii.String("unitLabel"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-onlineabconfigobject.html#cfn-evidently-experiment-onlineabconfigobject-controltreatmentname // ControlTreatmentName *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-onlineabconfigobject.html#cfn-evidently-experiment-onlineabconfigobject-treatmentweights // TreatmentWeights interface{} `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" onlineAbConfigObjectProperty := &OnlineAbConfigObjectProperty{ ControlTreatmentName: jsii.String("controlTreatmentName"), TreatmentWeights: []interface{}{ &TreatmentToWeightProperty{ SplitWeight: jsii.Number(123), Treatment: jsii.String("treatment"), }, }, }
type CfnExperiment_RunningStatusObjectProperty ¶ added in v2.23.0
type CfnExperiment_RunningStatusObjectProperty struct { // To start the experiment now, specify `START` for this parameter. // // If this experiment is currently running and you want to stop it now, specify `STOP` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-status // Status *string `field:"required" json:"status" yaml:"status"` // If you are using AWS CloudFormation to start the experiment, use this field to specify when the experiment is to end. // // The format is as a UNIX timestamp. For more information about this format, see [The Current Epoch Unix Timestamp](https://docs.aws.amazon.com/https://www.unixtimestamp.com/index.php) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-analysiscompletetime // AnalysisCompleteTime *string `field:"optional" json:"analysisCompleteTime" yaml:"analysisCompleteTime"` // If you are using AWS CloudFormation to stop this experiment, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-desiredstate // DesiredState *string `field:"optional" json:"desiredState" yaml:"desiredState"` // If you are using AWS CloudFormation to stop this experiment, this is an optional field that you can use to record why the experiment is being stopped or cancelled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-reason // Reason *string `field:"optional" json:"reason" yaml:"reason"` }
Use this structure to start and stop the experiment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" runningStatusObjectProperty := &RunningStatusObjectProperty{ Status: jsii.String("status"), // the properties below are optional AnalysisCompleteTime: jsii.String("analysisCompleteTime"), DesiredState: jsii.String("desiredState"), Reason: jsii.String("reason"), }
type CfnExperiment_TreatmentObjectProperty ¶
type CfnExperiment_TreatmentObjectProperty struct { // The name of the feature for this experiment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-feature // Feature *string `field:"required" json:"feature" yaml:"feature"` // A name for this treatment. // // It can include up to 127 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-treatmentname // TreatmentName *string `field:"required" json:"treatmentName" yaml:"treatmentName"` // The name of the variation to use for this treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-variation // Variation *string `field:"required" json:"variation" yaml:"variation"` // The description of the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html#cfn-evidently-experiment-treatmentobject-description // Description *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" treatmentObjectProperty := &TreatmentObjectProperty{ Feature: jsii.String("feature"), TreatmentName: jsii.String("treatmentName"), Variation: jsii.String("variation"), // the properties below are optional Description: jsii.String("description"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmenttoweight.html#cfn-evidently-experiment-treatmenttoweight-splitweight // SplitWeight *float64 `field:"required" json:"splitWeight" yaml:"splitWeight"` // The name of the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmenttoweight.html#cfn-evidently-experiment-treatmenttoweight-treatment // Treatment *string `field:"required" json:"treatment" yaml:"treatment"` }
This structure defines how much experiment traffic to allocate to one treatment used in the experiment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" treatmentToWeightProperty := &TreatmentToWeightProperty{ SplitWeight: jsii.Number(123), Treatment: jsii.String("treatment"), }
type CfnFeature ¶
type CfnFeature interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the feature. // // For example, `arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature` . AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The name of the variation to use as the default variation. DefaultVariation() *string SetDefaultVariation(val *string) // An optional description of the feature. Description() *string SetDescription(val *string) // Specify users that should always be served a specific variation of a feature. EntityOverrides() interface{} SetEntityOverrides(val interface{}) // Specify `ALL_RULES` to activate the traffic allocation specified by any ongoing launches or experiments. EvaluationStrategy() *string SetEvaluationStrategy(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name for the feature. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The name or ARN of the project that is to contain the new feature. Project() *string SetProject(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Assigns one or more tags (key-value pairs) to the feature. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // An array of structures that contain the configuration of the feature's different variations. Variations() interface{} SetVariations(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFeature := awscdk.Aws_evidently.NewCfnFeature(this, jsii.String("MyCfnFeature"), &CfnFeatureProps{ Name: jsii.String("name"), Project: jsii.String("project"), Variations: []interface{}{ &VariationObjectProperty{ VariationName: jsii.String("variationName"), // the properties below are optional BooleanValue: jsii.Boolean(false), DoubleValue: jsii.Number(123), LongValue: jsii.Number(123), StringValue: jsii.String("stringValue"), }, }, // the properties below are optional DefaultVariation: jsii.String("defaultVariation"), Description: jsii.String("description"), EntityOverrides: []interface{}{ &EntityOverrideProperty{ EntityId: jsii.String("entityId"), Variation: jsii.String("variation"), }, }, EvaluationStrategy: jsii.String("evaluationStrategy"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html
func NewCfnFeature ¶
func NewCfnFeature(scope constructs.Construct, id *string, props *CfnFeatureProps) CfnFeature
type CfnFeatureProps ¶
type CfnFeatureProps struct { // The name for the feature. // // It can include up to 127 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-name // Name *string `field:"required" json:"name" yaml:"name"` // The name or ARN of the project that is to contain the new feature. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-project // Project *string `field:"required" 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` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-variations // Variations interface{} `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-defaultvariation // DefaultVariation *string `field:"optional" json:"defaultVariation" yaml:"defaultVariation"` // An optional description of the feature. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-description // Description *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-entityoverrides // EntityOverrides interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-evaluationstrategy // EvaluationStrategy *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html#cfn-evidently-feature-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnFeature`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFeatureProps := &CfnFeatureProps{ Name: jsii.String("name"), Project: jsii.String("project"), Variations: []interface{}{ &VariationObjectProperty{ VariationName: jsii.String("variationName"), // the properties below are optional BooleanValue: jsii.Boolean(false), DoubleValue: jsii.Number(123), LongValue: jsii.Number(123), StringValue: jsii.String("stringValue"), }, }, // the properties below are optional DefaultVariation: jsii.String("defaultVariation"), Description: jsii.String("description"), EntityOverrides: []interface{}{ &EntityOverrideProperty{ EntityId: jsii.String("entityId"), Variation: jsii.String("variation"), }, }, EvaluationStrategy: jsii.String("evaluationStrategy"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html
type CfnFeature_EntityOverrideProperty ¶
type CfnFeature_EntityOverrideProperty struct { // The entity ID to be served the variation specified in `Variation` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-entityoverride.html#cfn-evidently-feature-entityoverride-entityid // EntityId *string `field:"optional" json:"entityId" yaml:"entityId"` // The name of the variation to serve to the user session that matches the `EntityId` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-entityoverride.html#cfn-evidently-feature-entityoverride-variation // Variation *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" entityOverrideProperty := &EntityOverrideProperty{ EntityId: jsii.String("entityId"), Variation: jsii.String("variation"), }
type CfnFeature_VariationObjectProperty ¶
type CfnFeature_VariationObjectProperty struct { // A name for the variation. // // It can include up to 127 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-variationname // VariationName *string `field:"required" json:"variationName" yaml:"variationName"` // The value assigned to this variation, if the variation type is boolean. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-booleanvalue // BooleanValue interface{} `field:"optional" json:"booleanValue" yaml:"booleanValue"` // The value assigned to this variation, if the variation type is a double. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-doublevalue // DoubleValue *float64 `field:"optional" json:"doubleValue" yaml:"doubleValue"` // The value assigned to this variation, if the variation type is a long. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-longvalue // LongValue *float64 `field:"optional" json:"longValue" yaml:"longValue"` // The value assigned to this variation, if the variation type is a string. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-feature-variationobject.html#cfn-evidently-feature-variationobject-stringvalue // StringValue *string `field:"optional" json:"stringValue" yaml:"stringValue"` }
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` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" variationObjectProperty := &VariationObjectProperty{ VariationName: jsii.String("variationName"), // the properties below are optional BooleanValue: jsii.Boolean(false), DoubleValue: jsii.Number(123), LongValue: jsii.Number(123), StringValue: jsii.String("stringValue"), }
type CfnLaunch ¶
type CfnLaunch interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the launch. // // For example, `arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch`. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // An optional description for the launch. Description() *string SetDescription(val *string) // A structure that you can use to start and stop the launch. ExecutionStatus() interface{} SetExecutionStatus(val interface{}) // An array of structures that contains the feature and variations that are to be used for the launch. Groups() interface{} SetGroups(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // An array of structures that define the metrics that will be used to monitor the launch performance. MetricMonitors() interface{} SetMetricMonitors(val interface{}) // The name for the launch. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The name or ARN of the project that you want to create the launch in. Project() *string SetProject(val *string) // 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. RandomizationSalt() *string SetRandomizationSalt(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. ScheduledSplitsConfig() interface{} SetScheduledSplitsConfig(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Assigns one or more tags (key-value pairs) to the launch. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLaunch := awscdk.Aws_evidently.NewCfnLaunch(this, jsii.String("MyCfnLaunch"), &CfnLaunchProps{ Groups: []interface{}{ &LaunchGroupObjectProperty{ Feature: jsii.String("feature"), GroupName: jsii.String("groupName"), Variation: jsii.String("variation"), // the properties below are optional Description: jsii.String("description"), }, }, Name: jsii.String("name"), Project: jsii.String("project"), ScheduledSplitsConfig: []interface{}{ &StepConfigProperty{ GroupWeights: []interface{}{ &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }, }, StartTime: jsii.String("startTime"), // the properties below are optional SegmentOverrides: []interface{}{ &SegmentOverrideProperty{ EvaluationOrder: jsii.Number(123), Segment: jsii.String("segment"), Weights: []interface{}{ &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }, }, }, }, }, }, // the properties below are optional Description: jsii.String("description"), ExecutionStatus: &ExecutionStatusObjectProperty{ Status: jsii.String("status"), // the properties below are optional DesiredState: jsii.String("desiredState"), Reason: jsii.String("reason"), }, MetricMonitors: []interface{}{ &MetricDefinitionObjectProperty{ EntityIdKey: jsii.String("entityIdKey"), MetricName: jsii.String("metricName"), ValueKey: jsii.String("valueKey"), // the properties below are optional EventPattern: jsii.String("eventPattern"), UnitLabel: jsii.String("unitLabel"), }, }, RandomizationSalt: jsii.String("randomizationSalt"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html
func NewCfnLaunch ¶
func NewCfnLaunch(scope constructs.Construct, id *string, props *CfnLaunchProps) CfnLaunch
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-groups // Groups interface{} `field:"required" json:"groups" yaml:"groups"` // The name for the launch. // // It can include up to 127 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-name // Name *string `field:"required" json:"name" yaml:"name"` // The name or ARN of the project that you want to create the launch in. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-project // Project *string `field:"required" json:"project" yaml:"project"` // An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-scheduledsplitsconfig // ScheduledSplitsConfig interface{} `field:"required" json:"scheduledSplitsConfig" yaml:"scheduledSplitsConfig"` // An optional description for the launch. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-description // Description *string `field:"optional" json:"description" yaml:"description"` // A structure that you can use to start and stop the launch. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-executionstatus // ExecutionStatus interface{} `field:"optional" json:"executionStatus" yaml:"executionStatus"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-metricmonitors // MetricMonitors interface{} `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-randomizationsalt // RandomizationSalt *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html#cfn-evidently-launch-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnLaunch`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLaunchProps := &CfnLaunchProps{ Groups: []interface{}{ &LaunchGroupObjectProperty{ Feature: jsii.String("feature"), GroupName: jsii.String("groupName"), Variation: jsii.String("variation"), // the properties below are optional Description: jsii.String("description"), }, }, Name: jsii.String("name"), Project: jsii.String("project"), ScheduledSplitsConfig: []interface{}{ &StepConfigProperty{ GroupWeights: []interface{}{ &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }, }, StartTime: jsii.String("startTime"), // the properties below are optional SegmentOverrides: []interface{}{ &SegmentOverrideProperty{ EvaluationOrder: jsii.Number(123), Segment: jsii.String("segment"), Weights: []interface{}{ &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }, }, }, }, }, }, // the properties below are optional Description: jsii.String("description"), ExecutionStatus: &ExecutionStatusObjectProperty{ Status: jsii.String("status"), // the properties below are optional DesiredState: jsii.String("desiredState"), Reason: jsii.String("reason"), }, MetricMonitors: []interface{}{ &MetricDefinitionObjectProperty{ EntityIdKey: jsii.String("entityIdKey"), MetricName: jsii.String("metricName"), ValueKey: jsii.String("valueKey"), // the properties below are optional EventPattern: jsii.String("eventPattern"), UnitLabel: jsii.String("unitLabel"), }, }, RandomizationSalt: jsii.String("randomizationSalt"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-launch.html
type CfnLaunch_ExecutionStatusObjectProperty ¶ added in v2.23.0
type CfnLaunch_ExecutionStatusObjectProperty struct { // To start the launch now, specify `START` for this parameter. // // If this launch is currently running and you want to stop it now, specify `STOP` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-status // Status *string `field:"required" json:"status" yaml:"status"` // If you are using AWS CloudFormation to stop this launch, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment. // // If you omit this parameter, the default of `COMPLETED` is used. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-desiredstate // DesiredState *string `field:"optional" json:"desiredState" yaml:"desiredState"` // If you are using AWS CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html#cfn-evidently-launch-executionstatusobject-reason // Reason *string `field:"optional" json:"reason" yaml:"reason"` }
Use this structure to start and stop the launch.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" executionStatusObjectProperty := &ExecutionStatusObjectProperty{ Status: jsii.String("status"), // the properties below are optional DesiredState: jsii.String("desiredState"), Reason: jsii.String("reason"), }
type CfnLaunch_GroupToWeightProperty ¶
type CfnLaunch_GroupToWeightProperty struct { // The name of the launch group. // // It can include up to 127 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html#cfn-evidently-launch-grouptoweight-groupname // GroupName *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html#cfn-evidently-launch-grouptoweight-splitweight // SplitWeight *float64 `field:"required" json:"splitWeight" yaml:"splitWeight"` }
A structure containing the percentage of launch traffic to allocate to one launch group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" groupToWeightProperty := &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }
type CfnLaunch_LaunchGroupObjectProperty ¶
type CfnLaunch_LaunchGroupObjectProperty struct { // The feature that this launch is using. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-feature // Feature *string `field:"required" json:"feature" yaml:"feature"` // A name for this launch group. // // It can include up to 127 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-groupname // GroupName *string `field:"required" json:"groupName" yaml:"groupName"` // The feature variation to use for this launch group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-variation // Variation *string `field:"required" json:"variation" yaml:"variation"` // A description of the launch group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html#cfn-evidently-launch-launchgroupobject-description // Description *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" launchGroupObjectProperty := &LaunchGroupObjectProperty{ Feature: jsii.String("feature"), GroupName: jsii.String("groupName"), Variation: jsii.String("variation"), // the properties below are optional Description: jsii.String("description"), }
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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-entityidkey // EntityIdKey *string `field:"required" json:"entityIdKey" yaml:"entityIdKey"` // A name for the metric. // // It can include up to 255 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-metricname // MetricName *string `field:"required" json:"metricName" yaml:"metricName"` // The value that is tracked to produce the metric. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-valuekey // ValueKey *string `field:"required" json:"valueKey" yaml:"valueKey"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-eventpattern // EventPattern *string `field:"optional" json:"eventPattern" yaml:"eventPattern"` // A label for the units that the metric is measuring. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html#cfn-evidently-launch-metricdefinitionobject-unitlabel // UnitLabel *string `field:"optional" json:"unitLabel" yaml:"unitLabel"` }
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" metricDefinitionObjectProperty := &MetricDefinitionObjectProperty{ EntityIdKey: jsii.String("entityIdKey"), MetricName: jsii.String("metricName"), ValueKey: jsii.String("valueKey"), // the properties below are optional EventPattern: jsii.String("eventPattern"), UnitLabel: jsii.String("unitLabel"), }
type CfnLaunch_SegmentOverrideProperty ¶ added in v2.33.0
type CfnLaunch_SegmentOverrideProperty struct { // A number indicating the order to use to evaluate segment overrides, if there are more than one. // // Segment overrides with lower numbers are evaluated first. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-evaluationorder // EvaluationOrder *float64 `field:"required" json:"evaluationOrder" yaml:"evaluationOrder"` // The ARN of the segment to use for this override. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-segment // Segment *string `field:"required" json:"segment" yaml:"segment"` // The traffic allocation percentages among the feature variations to assign to this segment. // // This is a set of key-value pairs. The keys are variation names. The values represent the amount of traffic to allocate to that variation for this segment. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html#cfn-evidently-launch-segmentoverride-weights // Weights interface{} `field:"required" json:"weights" yaml:"weights"` }
Use this structure to specify different traffic splits for one or more audience *segments* .
A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
For more information, see [Use segments to focus your audience](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html) .
This sructure is an array of up to six segment override objects. Each of these objects specifies a segment that you have already created, and defines the traffic split for that segment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" segmentOverrideProperty := &SegmentOverrideProperty{ EvaluationOrder: jsii.Number(123), Segment: jsii.String("segment"), Weights: []interface{}{ &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-groupweights // GroupWeights interface{} `field:"required" 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` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-starttime // StartTime *string `field:"required" json:"startTime" yaml:"startTime"` // An array of structures that you can use to specify different traffic splits for one or more audience *segments* . // // A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age. // // For more information, see [Use segments to focus your audience](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html#cfn-evidently-launch-stepconfig-segmentoverrides // SegmentOverrides interface{} `field:"optional" json:"segmentOverrides" yaml:"segmentOverrides"` }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" stepConfigProperty := &StepConfigProperty{ GroupWeights: []interface{}{ &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }, }, StartTime: jsii.String("startTime"), // the properties below are optional SegmentOverrides: []interface{}{ &SegmentOverrideProperty{ EvaluationOrder: jsii.Number(123), Segment: jsii.String("segment"), Weights: []interface{}{ &GroupToWeightProperty{ GroupName: jsii.String("groupName"), SplitWeight: jsii.Number(123), }, }, }, }, }
type CfnProject ¶
type CfnProject interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* . AppConfigResource() interface{} SetAppConfigResource(val interface{}) // The ARN of the project. // // For example, `arn:aws:evidently:us-west-2:0123455678912:project/myProject`. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. DataDelivery() interface{} SetDataDelivery(val interface{}) // An optional description of the project. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name for the project. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Assigns one or more tags (key-value pairs) to the project. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.
Use projects to group similar features together.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnProject := awscdk.Aws_evidently.NewCfnProject(this, jsii.String("MyCfnProject"), &CfnProjectProps{ Name: jsii.String("name"), // the properties below are optional AppConfigResource: &AppConfigResourceObjectProperty{ ApplicationId: jsii.String("applicationId"), EnvironmentId: jsii.String("environmentId"), }, DataDelivery: &DataDeliveryObjectProperty{ LogGroup: jsii.String("logGroup"), S3: &S3DestinationProperty{ BucketName: jsii.String("bucketName"), // the properties below are optional Prefix: jsii.String("prefix"), }, }, Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html
func NewCfnProject ¶
func NewCfnProject(scope constructs.Construct, id *string, props *CfnProjectProps) CfnProject
type CfnProjectProps ¶
type CfnProjectProps struct { // The name for the project. // // It can include up to 127 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-name // Name *string `field:"required" json:"name" yaml:"name"` // Use this parameter if the project will use *client-side evaluation powered by AWS AppConfig* . // // Client-side evaluation allows your application to assign variations to user sessions locally instead of by calling the [EvaluateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) operation. This mitigates the latency and availability risks that come with an API call. For more information, see [Use client-side evaluation - powered by AWS AppConfig .](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html) // // This parameter is a structure that contains information about the AWS AppConfig application that will be used as for client-side evaluation. // // To create a project that uses client-side evaluation, you must have the `evidently:ExportProjectAsConfiguration` permission. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-appconfigresource // AppConfigResource interface{} `field:"optional" json:"appConfigResource" yaml:"appConfigResource"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-datadelivery // DataDelivery interface{} `field:"optional" json:"dataDelivery" yaml:"dataDelivery"` // An optional description of the project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-description // Description *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html#cfn-evidently-project-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnProject`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnProjectProps := &CfnProjectProps{ Name: jsii.String("name"), // the properties below are optional AppConfigResource: &AppConfigResourceObjectProperty{ ApplicationId: jsii.String("applicationId"), EnvironmentId: jsii.String("environmentId"), }, DataDelivery: &DataDeliveryObjectProperty{ LogGroup: jsii.String("logGroup"), S3: &S3DestinationProperty{ BucketName: jsii.String("bucketName"), // the properties below are optional Prefix: jsii.String("prefix"), }, }, Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html
type CfnProject_AppConfigResourceObjectProperty ¶ added in v2.43.0
type CfnProject_AppConfigResourceObjectProperty struct { // The ID of the AWS AppConfig application to use for client-side evaluation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html#cfn-evidently-project-appconfigresourceobject-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The ID of the AWS AppConfig environment to use for client-side evaluation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html#cfn-evidently-project-appconfigresourceobject-environmentid // EnvironmentId *string `field:"required" json:"environmentId" yaml:"environmentId"` }
This is a structure that defines the configuration of how your application integrates with AWS AppConfig to run client-side evaluation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" appConfigResourceObjectProperty := &AppConfigResourceObjectProperty{ ApplicationId: jsii.String("applicationId"), EnvironmentId: jsii.String("environmentId"), }
type CfnProject_DataDeliveryObjectProperty ¶
type CfnProject_DataDeliveryObjectProperty struct { // If the project stores evaluation events in CloudWatch Logs , this structure stores the log group name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html#cfn-evidently-project-datadeliveryobject-loggroup // LogGroup *string `field:"optional" json:"logGroup" yaml:"logGroup"` // If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html#cfn-evidently-project-datadeliveryobject-s3 // S3 interface{} `field:"optional" json:"s3" yaml:"s3"` }
A structure that contains information about where Evidently is to store evaluation events for longer term storage.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataDeliveryObjectProperty := &DataDeliveryObjectProperty{ LogGroup: jsii.String("logGroup"), S3: &S3DestinationProperty{ BucketName: jsii.String("bucketName"), // the properties below are optional Prefix: jsii.String("prefix"), }, }
type CfnProject_S3DestinationProperty ¶
type CfnProject_S3DestinationProperty struct { // The name of the bucket in which Evidently stores evaluation events. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html#cfn-evidently-project-s3destination-bucketname // BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"` // The bucket prefix in which Evidently stores evaluation events. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html#cfn-evidently-project-s3destination-prefix // Prefix *string `field:"optional" json:"prefix" yaml:"prefix"` }
If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3DestinationProperty := &S3DestinationProperty{ BucketName: jsii.String("bucketName"), // the properties below are optional Prefix: jsii.String("prefix"), }
type CfnSegment ¶ added in v2.34.0
type CfnSegment interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the segment. // // For example, `arn:aws:evidently:us-west-2:123456789012:segment/australiaSegment`. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // An optional description for this segment. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A name for the segment. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The pattern to use for the segment. Pattern() *string SetPattern(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Assigns one or more tags (key-value pairs) to the feature. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates or updates a *segment* of your audience.
A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.
Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allow you to define different traffic splits for the different audience segments.
For more information about segment pattern syntax, see [Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html) .
The pattern that you define for a segment is matched against the value of `evaluationContext` , which is passed into Evidently in the [EvaluateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) operation, when Evidently assigns a feature variation to a user.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSegment := awscdk.Aws_evidently.NewCfnSegment(this, jsii.String("MyCfnSegment"), &CfnSegmentProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), Pattern: jsii.String("pattern"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html
func NewCfnSegment ¶ added in v2.34.0
func NewCfnSegment(scope constructs.Construct, id *string, props *CfnSegmentProps) CfnSegment
type CfnSegmentProps ¶ added in v2.34.0
type CfnSegmentProps struct { // A name for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-name // Name *string `field:"required" json:"name" yaml:"name"` // An optional description for this segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-description // Description *string `field:"optional" json:"description" yaml:"description"` // The pattern to use for the segment. // // For more information about pattern syntax, see [Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-pattern // Pattern *string `field:"optional" json:"pattern" yaml:"pattern"` // 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html#cfn-evidently-segment-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSegment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSegmentProps := &CfnSegmentProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), Pattern: jsii.String("pattern"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.html
Source Files ¶
- CfnExperiment.go
- CfnExperimentProps.go
- CfnExperiment_MetricGoalObjectProperty.go
- CfnExperiment_OnlineAbConfigObjectProperty.go
- CfnExperiment_RunningStatusObjectProperty.go
- CfnExperiment_TreatmentObjectProperty.go
- CfnExperiment_TreatmentToWeightProperty.go
- CfnExperiment__checks.go
- CfnFeature.go
- CfnFeatureProps.go
- CfnFeature_EntityOverrideProperty.go
- CfnFeature_VariationObjectProperty.go
- CfnFeature__checks.go
- CfnLaunch.go
- CfnLaunchProps.go
- CfnLaunch_ExecutionStatusObjectProperty.go
- CfnLaunch_GroupToWeightProperty.go
- CfnLaunch_LaunchGroupObjectProperty.go
- CfnLaunch_MetricDefinitionObjectProperty.go
- CfnLaunch_SegmentOverrideProperty.go
- CfnLaunch_StepConfigProperty.go
- CfnLaunch__checks.go
- CfnProject.go
- CfnProjectProps.go
- CfnProject_AppConfigResourceObjectProperty.go
- CfnProject_DataDeliveryObjectProperty.go
- CfnProject_S3DestinationProperty.go
- CfnProject__checks.go
- CfnSegment.go
- CfnSegmentProps.go
- CfnSegment__checks.go
- main.go