software.amazon.awscdk.services.pinpoint

Class CfnSegment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnSegment

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.482Z")
 @Stability(value=Stable)
public class CfnSegment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::Segment`.

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.*;
 Object attributes;
 Object metrics;
 Object tags;
 Object userAttributes;
 CfnSegment cfnSegment = CfnSegment.Builder.create(this, "MyCfnSegment")
         .applicationId("applicationId")
         .name("name")
         // the properties below are optional
         .dimensions(SegmentDimensionsProperty.builder()
                 .attributes(attributes)
                 .behavior(BehaviorProperty.builder()
                         .recency(RecencyProperty.builder()
                                 .duration("duration")
                                 .recencyType("recencyType")
                                 .build())
                         .build())
                 .demographic(DemographicProperty.builder()
                         .appVersion(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .channel(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .deviceType(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .make(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .model(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .platform(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .build())
                 .location(LocationProperty.builder()
                         .country(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .gpsPoint(GPSPointProperty.builder()
                                 .coordinates(CoordinatesProperty.builder()
                                         .latitude(123)
                                         .longitude(123)
                                         .build())
                                 .rangeInKilometers(123)
                                 .build())
                         .build())
                 .metrics(metrics)
                 .userAttributes(userAttributes)
                 .build())
         .segmentGroups(SegmentGroupsProperty.builder()
                 .groups(List.of(GroupsProperty.builder()
                         .dimensions(List.of(SegmentDimensionsProperty.builder()
                                 .attributes(attributes)
                                 .behavior(BehaviorProperty.builder()
                                         .recency(RecencyProperty.builder()
                                                 .duration("duration")
                                                 .recencyType("recencyType")
                                                 .build())
                                         .build())
                                 .demographic(DemographicProperty.builder()
                                         .appVersion(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .channel(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .deviceType(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .make(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .model(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .platform(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .build())
                                 .location(LocationProperty.builder()
                                         .country(SetDimensionProperty.builder()
                                                 .dimensionType("dimensionType")
                                                 .values(List.of("values"))
                                                 .build())
                                         .gpsPoint(GPSPointProperty.builder()
                                                 .coordinates(CoordinatesProperty.builder()
                                                         .latitude(123)
                                                         .longitude(123)
                                                         .build())
                                                 .rangeInKilometers(123)
                                                 .build())
                                         .build())
                                 .metrics(metrics)
                                 .userAttributes(userAttributes)
                                 .build()))
                         .sourceSegments(List.of(SourceSegmentsProperty.builder()
                                 .id("id")
                                 // the properties below are optional
                                 .version(123)
                                 .build()))
                         .sourceType("sourceType")
                         .type("type")
                         .build()))
                 .include("include")
                 .build())
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnSegment.AttributeDimensionProperty Example:
static interface	CfnSegment.BehaviorProperty Example:
static class	CfnSegment.Builder A fluent builder for CfnSegment.
static interface	CfnSegment.CoordinatesProperty Example:
static interface	CfnSegment.DemographicProperty Example:
static interface	CfnSegment.GPSPointProperty Example:
static interface	CfnSegment.GroupsProperty Example:
static interface	CfnSegment.LocationProperty Example:
static interface	CfnSegment.RecencyProperty Example:
static interface	CfnSegment.SegmentDimensionsProperty Example:
static interface	CfnSegment.SegmentGroupsProperty Example:
static interface	CfnSegment.SetDimensionProperty Example:
static interface	CfnSegment.SourceSegmentsProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSegment(software.constructs.Construct scope, String id, CfnSegmentProps props) Create a new `AWS::Pinpoint::Segment`.
protected	CfnSegment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSegment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() `AWS::Pinpoint::Segment.ApplicationId`.
String	getAttrArn()
String	getAttrSegmentId()
protected Map<String,Object>	getCfnProperties()
Object	getDimensions() `AWS::Pinpoint::Segment.Dimensions`.
String	getName() `AWS::Pinpoint::Segment.Name`.
Object	getSegmentGroups() `AWS::Pinpoint::Segment.SegmentGroups`.
TagManager	getTags() `AWS::Pinpoint::Segment.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) `AWS::Pinpoint::Segment.ApplicationId`.
void	setDimensions(CfnSegment.SegmentDimensionsProperty value) `AWS::Pinpoint::Segment.Dimensions`.
void	setDimensions(IResolvable value) `AWS::Pinpoint::Segment.Dimensions`.
void	setName(String value) `AWS::Pinpoint::Segment.Name`.
void	setSegmentGroups(CfnSegment.SegmentGroupsProperty value) `AWS::Pinpoint::Segment.SegmentGroups`.
void	setSegmentGroups(IResolvable value) `AWS::Pinpoint::Segment.SegmentGroups`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSegment

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

CfnSegment

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

CfnSegment

@Stability(value=Stable)
public CfnSegment(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnSegmentProps props)

Create a new `AWS::Pinpoint::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 Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getApplicationId

@Stability(value=Stable)
 @NotNull
public String getApplicationId()

`AWS::Pinpoint::Segment.ApplicationId`.

setApplicationId

@Stability(value=Stable)
public void setApplicationId(@NotNull
                                                      String value)

`AWS::Pinpoint::Segment.ApplicationId`.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrSegmentId

@Stability(value=Stable)
 @NotNull
public String getAttrSegmentId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDimensions

@Stability(value=Stable)
 @Nullable
public Object getDimensions()

`AWS::Pinpoint::Segment.Dimensions`.

setDimensions

@Stability(value=Stable)
public void setDimensions(@Nullable
                                                   CfnSegment.SegmentDimensionsProperty value)

`AWS::Pinpoint::Segment.Dimensions`.

setDimensions

@Stability(value=Stable)
public void setDimensions(@Nullable
                                                   IResolvable value)

`AWS::Pinpoint::Segment.Dimensions`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::Pinpoint::Segment.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::Pinpoint::Segment.Name`.

getSegmentGroups

@Stability(value=Stable)
 @Nullable
public Object getSegmentGroups()

`AWS::Pinpoint::Segment.SegmentGroups`.

setSegmentGroups

@Stability(value=Stable)
public void setSegmentGroups(@Nullable
                                                      CfnSegment.SegmentGroupsProperty value)

`AWS::Pinpoint::Segment.SegmentGroups`.

setSegmentGroups

@Stability(value=Stable)
public void setSegmentGroups(@Nullable
                                                      IResolvable value)

`AWS::Pinpoint::Segment.SegmentGroups`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Pinpoint::Segment.Tags`.