Class CfnSegment
A CloudFormation AWS::Evidently::Segment
.
Inherited Members
Namespace: Amazon.CDK.AWS.Evidently
Assembly: Amazon.CDK.AWS.Evidently.dll
Syntax (csharp)
public class CfnSegment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSegment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
The pattern that you define for a segment is matched against the value of evaluationContext
, which is passed into Evidently in the EvaluateFeature operation, when Evidently assigns a feature variation to a user.
CloudformationResource: AWS::Evidently::Segment
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-segment.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 cfnSegment = new CfnSegment(this, "MyCfnSegment", new CfnSegmentProps {
Name = "name",
// the properties below are optional
Description = "description",
Pattern = "pattern",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSegment(Construct, String, ICfnSegmentProps) | Create a new |
CfnSegment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSegment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The ARN of the segment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | An optional description for this segment. |
Name | A name for the segment. |
Pattern | The pattern to use for the segment. |
Tags | Assigns one or more tags (key-value pairs) to the feature. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSegment(Construct, String, ICfnSegmentProps)
Create a new AWS::Evidently::Segment
.
public CfnSegment(Construct scope, string id, ICfnSegmentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSegmentProps
- resource properties.
CfnSegment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSegment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSegment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSegment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The ARN of the segment.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:evidently:us-west-2:123456789012:segment/australiaSegment
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
Description
An optional description for this segment.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
A name for the segment.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Pattern
The pattern to use for the segment.
public virtual string Pattern { get; set; }
Property Value
System.String
Remarks
For more information about pattern syntax, see Segment rule pattern syntax .
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 .
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>