Package software.amazon.awscdk.services.customerprofiles

Interface CfnSegmentDefinition.GroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSegmentDefinition.GroupProperty.Jsii$Proxy

Enclosing class:

CfnSegmentDefinition

@Stability(Stable)
public static interface CfnSegmentDefinition.GroupProperty
extends software.amazon.jsii.JsiiSerializable

Contains dimensions that determine what to segment on.

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.customerprofiles.*;
 GroupProperty groupProperty = GroupProperty.builder()
         .dimensions(List.of(DimensionProperty.builder()
                 .calculatedAttributes(Map.of(
                         "calculatedAttributesKey", CalculatedAttributeDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 // the properties below are optional
                                 .conditionOverrides(ConditionOverridesProperty.builder()
                                         .range(RangeOverrideProperty.builder()
                                                 .start(123)
                                                 .unit("unit")
                                                 // the properties below are optional
                                                 .end(123)
                                                 .build())
                                         .build())
                                 .build()))
                 .profileAttributes(ProfileAttributesProperty.builder()
                         .accountNumber(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .additionalInformation(ExtraLengthValueProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .address(AddressDimensionProperty.builder()
                                 .city(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .country(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .county(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .postalCode(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .province(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .state(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .build())
                         .attributes(Map.of(
                                 "attributesKey", AttributeDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build()))
                         .billingAddress(AddressDimensionProperty.builder()
                                 .city(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .country(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .county(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .postalCode(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .province(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .state(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .build())
                         .birthDate(DateDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .businessEmailAddress(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .businessName(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .businessPhoneNumber(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .emailAddress(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .firstName(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .genderString(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .homePhoneNumber(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .lastName(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .mailingAddress(AddressDimensionProperty.builder()
                                 .city(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .country(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .county(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .postalCode(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .province(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .state(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .build())
                         .middleName(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .mobilePhoneNumber(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .partyTypeString(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .personalEmailAddress(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .phoneNumber(ProfileDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .profileType(ProfileTypeDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .shippingAddress(AddressDimensionProperty.builder()
                                 .city(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .country(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .county(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .postalCode(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .province(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .state(ProfileDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .build())
                         .build())
                 .build()))
         .sourceSegments(List.of(SourceSegmentProperty.builder()
                 .segmentDefinitionName("segmentDefinitionName")
                 .build()))
         .sourceType("sourceType")
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSegmentDefinition.GroupProperty.Builder	A builder for CfnSegmentDefinition.GroupProperty
static final class	CfnSegmentDefinition.GroupProperty.Jsii$Proxy	An implementation for CfnSegmentDefinition.GroupProperty

Method Summary

Modifier and Type	Method	Description
static CfnSegmentDefinition.GroupProperty.Builder	builder()
default Object	getDimensions()	Defines the attributes to segment on.
default Object	getSourceSegments()	Defines the starting source of data.
default String	getSourceType()	Defines how to interact with the source data.
default String	getType()	Defines how to interact with the profiles found in the current filtering.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDimensions

@Stability(Stable)
@Nullable
default Object getDimensions()

Defines the attributes to segment on.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSegmentDefinition.DimensionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-dimensions

getSourceSegments

@Stability(Stable)
@Nullable
default Object getSourceSegments()

Defines the starting source of data.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnSegmentDefinition.SourceSegmentProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcesegments

getSourceType

@Stability(Stable)
@Nullable
default String getSourceType()

Defines how to interact with the source data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcetype

getType

@Stability(Stable)
@Nullable
default String getType()

Defines how to interact with the profiles found in the current filtering.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-type

builder

@Stability(Stable)
static CfnSegmentDefinition.GroupProperty.Builder builder()

Returns:

a CfnSegmentDefinition.GroupProperty.Builder of CfnSegmentDefinition.GroupProperty