CfnSegment

java.lang.Object
- 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.pinpoint.CfnSegment

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.252Z")
public class CfnSegment
extends CfnResource
implements IInspectable

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

Updates the configuration, dimension, and other settings for an existing 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` Specifies attribute-based criteria for including or excluding endpoints from a segment.
`static interface`	`CfnSegment.BehaviorProperty` Specifies behavior-based criteria for the segment, such as how recently users have used your app.
`static class`	`CfnSegment.Builder` A fluent builder for `CfnSegment`.
`static interface`	`CfnSegment.CoordinatesProperty` Specifies the GPS coordinates of a location.
`static interface`	`CfnSegment.DemographicProperty` Specifies demographic-based criteria, such as device platform, for the segment.
`static interface`	`CfnSegment.GPSPointProperty` Specifies the GPS coordinates of the endpoint location.
`static interface`	`CfnSegment.GroupsProperty` An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
`static interface`	`CfnSegment.LocationProperty` Specifies location-based criteria, such as region or GPS coordinates, for the segment.
`static interface`	`CfnSegment.RecencyProperty` Specifies how recently segment members were active.
`static interface`	`CfnSegment.SegmentDimensionsProperty` Specifies the dimension settings for a segment.
`static interface`	`CfnSegment.SegmentGroupsProperty` Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
`static interface`	`CfnSegment.SetDimensionProperty` Specifies the dimension type and values for a segment dimension.
`static interface`	`CfnSegment.SourceSegmentsProperty` Specifies the base segment to build the segment on.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnSegment(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getApplicationId()` The unique identifier for the Amazon Pinpoint application that the segment is associated with.
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the segment.
`java.lang.String`	`getAttrSegmentId()` The unique identifier for the segment.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getDimensions()` The criteria that define the dimensions for the segment.
`java.lang.String`	`getName()` The name of the segment.
`java.lang.Object`	`getSegmentGroups()` The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
`TagManager`	`getTags()` An array of key-value pairs to apply to this resource.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setApplicationId(java.lang.String value)` The unique identifier for the Amazon Pinpoint application that the segment is associated with.
`void`	`setDimensions(CfnSegment.SegmentDimensionsProperty value)` The criteria that define the dimensions for the segment.
`void`	`setDimensions(IResolvable value)` The criteria that define the dimensions for the segment.
`void`	`setName(java.lang.String value)` The name of the segment.
`void`	`setSegmentGroups(CfnSegment.SegmentGroupsProperty value)` The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
`void`	`setSegmentGroups(IResolvable value)` The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnSegment(Construct scope,
                  java.lang.String id,
                  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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the segment.
  - getAttrSegmentId
```
public java.lang.String getAttrSegmentId()
```
    The unique identifier for the segment.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of key-value pairs to apply to this resource.
    For more information, see Tag .
  - getApplicationId
```
public java.lang.String getApplicationId()
```
    The unique identifier for the Amazon Pinpoint application that the segment is associated with.
  - setApplicationId
```
public void setApplicationId(java.lang.String value)
```
    The unique identifier for the Amazon Pinpoint application that the segment is associated with.
  - getName
```
public java.lang.String getName()
```
    The name of the segment.
    
    A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the segment.
    
    A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
  - getDimensions
```
public java.lang.Object getDimensions()
```
    The criteria that define the dimensions for the segment.
  - setDimensions
```
public void setDimensions(IResolvable value)
```
    The criteria that define the dimensions for the segment.
  - setDimensions
```
public void setDimensions(CfnSegment.SegmentDimensionsProperty value)
```
    The criteria that define the dimensions for the segment.
  - getSegmentGroups
```
public java.lang.Object getSegmentGroups()
```
    The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
    A segment group can consist of zero or more base segments. Your request can include only one segment group.
  - setSegmentGroups
```
public void setSegmentGroups(IResolvable value)
```
    The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
    A segment group can consist of zero or more base segments. Your request can include only one segment group.
  - setSegmentGroups
```
public void setSegmentGroups(CfnSegment.SegmentGroupsProperty value)
```
    The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
    A segment group can consist of zero or more base segments. Your request can include only one segment group.

Class CfnSegment

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnSegment

CfnSegment

CfnSegment

Method Detail

inspect

renderProperties

getAttrArn

getAttrSegmentId

getCfnProperties

getTags

getApplicationId

setApplicationId

getName

setName

getDimensions

setDimensions

setDimensions

getSegmentGroups

setSegmentGroups

setSegmentGroups