Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Class CfnSegmentPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnSegmentPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSegmentPropsMixin>

Enclosing class:

CfnSegmentPropsMixin

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

A fluent builder for CfnSegmentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnSegmentPropsMixin.Builder	applicationId(String applicationId)	The unique identifier for the Amazon Pinpoint application that the segment is associated with.
CfnSegmentPropsMixin	build()
static CfnSegmentPropsMixin.Builder	create()
static CfnSegmentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnSegmentPropsMixin.Builder	dimensions(CfnSegmentPropsMixin.SegmentDimensionsProperty dimensions)	An array that defines the dimensions for the segment.
CfnSegmentPropsMixin.Builder	dimensions(IResolvable dimensions)	An array that defines the dimensions for the segment.
CfnSegmentPropsMixin.Builder	name(String name)	The name of the segment.
CfnSegmentPropsMixin.Builder	segmentGroups(CfnSegmentPropsMixin.SegmentGroupsProperty segmentGroups)	The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
CfnSegmentPropsMixin.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.
CfnSegmentPropsMixin.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 CfnSegmentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnSegmentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnSegmentPropsMixin.Builder create()

Returns:

a new instance of CfnSegmentPropsMixin.Builder.

applicationId

@Stability(Stable)
public CfnSegmentPropsMixin.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

dimensions

@Stability(Stable)
public CfnSegmentPropsMixin.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 CfnSegmentPropsMixin.Builder dimensions(CfnSegmentPropsMixin.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

name

@Stability(Stable)
public CfnSegmentPropsMixin.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

segmentGroups

@Stability(Stable)
public CfnSegmentPropsMixin.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 CfnSegmentPropsMixin.Builder segmentGroups(CfnSegmentPropsMixin.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 CfnSegmentPropsMixin.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 CfnSegmentPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnSegmentPropsMixin.