Package software.amazon.awscdk.services.pinpoint

Class CfnSegment.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnSegment.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSegment>

Enclosing class:

CfnSegment

@Stability(Stable)
public static final class CfnSegment.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSegment>

A fluent builder for CfnSegment.

Method Summary

Modifier and Type	Method	Description
CfnSegment.Builder	applicationId(String applicationId)	The unique identifier for the Amazon Pinpoint application that the segment is associated with.
CfnSegment	build()
static CfnSegment.Builder	create(software.constructs.Construct scope, String id)
CfnSegment.Builder	dimensions(IResolvable dimensions)	An array that defines the dimensions for the segment.
CfnSegment.Builder	dimensions(CfnSegment.SegmentDimensionsProperty dimensions)	An array that defines the dimensions for the segment.
CfnSegment.Builder	name(String name)	The name of the segment.
CfnSegment.Builder	segmentGroups(IResolvable segmentGroups)	The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
CfnSegment.Builder	segmentGroups(CfnSegment.SegmentGroupsProperty segmentGroups)	The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
CfnSegment.Builder	tags(Object tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnSegment.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnSegment.Builder.

applicationId

@Stability(Stable)
public CfnSegment.Builder applicationId(String applicationId)

The unique identifier for the Amazon Pinpoint application that the segment is associated with.

Parameters:

applicationId - The unique identifier for the Amazon Pinpoint application that the segment is associated with. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-applicationid

name

@Stability(Stable)
public CfnSegment.Builder name(String name)

The name of the segment.

A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.

Parameters:

name - The name of the segment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-name

dimensions

@Stability(Stable)
public CfnSegment.Builder dimensions(IResolvable dimensions)

An array that defines the dimensions for the segment.

Parameters:

dimensions - An array that defines the dimensions for the segment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-dimensions

dimensions

@Stability(Stable)
public CfnSegment.Builder dimensions(CfnSegment.SegmentDimensionsProperty dimensions)

An array that defines the dimensions for the segment.

Parameters:

dimensions - An array that defines the dimensions for the segment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-dimensions

segmentGroups

@Stability(Stable)
public CfnSegment.Builder segmentGroups(IResolvable segmentGroups)

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.

Parameters:

segmentGroups - The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-segmentgroups

segmentGroups

@Stability(Stable)
public CfnSegment.Builder segmentGroups(CfnSegment.SegmentGroupsProperty segmentGroups)

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.

Parameters:

segmentGroups - The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-segmentgroups

tags

@Stability(Stable)
public CfnSegment.Builder tags(Object tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-tags

build

@Stability(Stable)
public CfnSegment build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSegment>

Returns:

a newly built instance of CfnSegment.