software.amazon.awscdk.services.pinpoint

Interface CfnSegment.SourceSegmentsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSegment.SourceSegmentsProperty.Jsii$Proxy

Enclosing class:

CfnSegment

@Stability(value=Stable)
public static interface CfnSegment.SourceSegmentsProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the base segment to build the segment on.

A base segment, also called a source segment , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.

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.pinpoint.*;
 SourceSegmentsProperty sourceSegmentsProperty = SourceSegmentsProperty.builder()
         .id("id")
         // the properties below are optional
         .version(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSegment.SourceSegmentsProperty.Builder A builder for CfnSegment.SourceSegmentsProperty
static class	CfnSegment.SourceSegmentsProperty.Jsii$Proxy An implementation for CfnSegment.SourceSegmentsProperty

Method Summary

Modifier and Type	Method and Description
static CfnSegment.SourceSegmentsProperty.Builder	builder()
String	getId() The unique identifier for the source segment.
default Number	getVersion() The version number of the source segment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getId

@Stability(value=Stable)
 @NotNull
String getId()

The unique identifier for the source segment.

getVersion

@Stability(value=Stable)
 @Nullable
default Number getVersion()

The version number of the source segment.

builder

@Stability(value=Stable)
static CfnSegment.SourceSegmentsProperty.Builder builder()

Returns:

a CfnSegment.SourceSegmentsProperty.Builder of CfnSegment.SourceSegmentsProperty