Class CfnFeature
A CloudFormation AWS::Evidently::Feature
.
Inherited Members
Namespace: Amazon.CDK.AWS.Evidently
Assembly: Amazon.CDK.AWS.Evidently.dll
Syntax (csharp)
public class CfnFeature : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFeature
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::Evidently::Feature
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-feature.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Evidently;
var cfnFeature = new CfnFeature(this, "MyCfnFeature", new CfnFeatureProps {
Name = "name",
Project = "project",
Variations = new [] { new VariationObjectProperty {
VariationName = "variationName",
// the properties below are optional
BooleanValue = false,
DoubleValue = 123,
LongValue = 123,
StringValue = "stringValue"
} },
// the properties below are optional
DefaultVariation = "defaultVariation",
Description = "description",
EntityOverrides = new [] { new EntityOverrideProperty {
EntityId = "entityId",
Variation = "variation"
} },
EvaluationStrategy = "evaluationStrategy",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnFeature(Construct, String, ICfnFeatureProps) | Create a new |
CfnFeature(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFeature(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The ARN of the feature. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DefaultVariation | The name of the variation to use as the default variation. |
Description | An optional description of the feature. |
EntityOverrides | Specify users that should always be served a specific variation of a feature. |
EvaluationStrategy | Specify |
Name | The name for the feature. |
Project | The name or ARN of the project that is to contain the new feature. |
Tags | Assigns one or more tags (key-value pairs) to the feature. |
Variations | An array of structures that contain the configuration of the feature's different variations. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFeature(Construct, String, ICfnFeatureProps)
Create a new AWS::Evidently::Feature
.
public CfnFeature(Construct scope, string id, ICfnFeatureProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFeatureProps
- resource properties.
CfnFeature(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFeature(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFeature(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFeature(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The ARN of the feature.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature
.
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DefaultVariation
The name of the variation to use as the default variation.
public virtual string DefaultVariation { get; set; }
Property Value
System.String
Remarks
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.
Description
An optional description of the feature.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
EntityOverrides
Specify users that should always be served a specific variation of a feature.
public virtual object EntityOverrides { get; set; }
Property Value
System.Object
Remarks
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.
EvaluationStrategy
Specify ALL_RULES
to activate the traffic allocation specified by any ongoing launches or experiments.
public virtual string EvaluationStrategy { get; set; }
Property Value
System.String
Remarks
Specify DEFAULT_VARIATION
to serve the default variation to all users instead.
Name
The name for the feature.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
It can include up to 127 characters.
Project
The name or ARN of the project that is to contain the new feature.
public virtual string Project { get; set; }
Property Value
System.String
Remarks
Tags
Assigns one or more tags (key-value pairs) to the feature.
public virtual TagManager Tags { get; }
Property Value
Remarks
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 .
Variations
An array of structures that contain the configuration of the feature's different variations.
public virtual object Variations { get; set; }
Property Value
System.Object
Remarks
Each VariationObject
in the Variations
array for a feature must have the same type of value ( BooleanValue
, DoubleValue
, LongValue
or StringValue
).
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>