Package software.amazon.awscdk.services.evidently

Class CfnSegment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.evidently.CfnSegment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.742Z") @Stability(Stable) public class CfnSegment extends CfnResource implements IInspectable
A CloudFormation AWS::Evidently::Segment.

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.evidently.*;
 CfnSegment cfnSegment = CfnSegment.Builder.create(this, "MyCfnSegment")
         .name("name")
         // the properties below are optional
         .description("description")
         .pattern("pattern")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSegment

      protected CfnSegment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSegment

      protected CfnSegment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSegment

      @Stability(Stable) public CfnSegment(@NotNull Construct scope, @NotNull String id, @NotNull CfnSegmentProps props)
      Create a new AWS::Evidently::Segment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the segment.

      For example, arn:aws:evidently:us-west-2:123456789012:segment/australiaSegment

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      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 .

    • getName

      @Stability(Stable) @NotNull public String getName()
      A name for the segment.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A name for the segment.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description for this segment.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description for this segment.

    • getPattern

      @Stability(Stable) @Nullable public String getPattern()
      The pattern to use for the segment.

      For more information about pattern syntax, see Segment rule pattern syntax .

    • setPattern

      @Stability(Stable) public void setPattern(@Nullable String value)
      The pattern to use for the segment.

      For more information about pattern syntax, see Segment rule pattern syntax .