Package software.amazon.awscdk.services.pinpoint

Class CfnInAppTemplate.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnInAppTemplate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInAppTemplate>

Enclosing class:

CfnInAppTemplate

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

A fluent builder for CfnInAppTemplate.

Method Summary

Modifier and Type	Method	Description
CfnInAppTemplate	build()
CfnInAppTemplate.Builder	content(List<? extends Object> content)	An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.
CfnInAppTemplate.Builder	content(IResolvable content)	An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.
static CfnInAppTemplate.Builder	create(software.constructs.Construct scope, String id)
CfnInAppTemplate.Builder	customConfig(Object customConfig)	Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
CfnInAppTemplate.Builder	layout(String layout)	A string that determines the appearance of the in-app message.
CfnInAppTemplate.Builder	tags(Object tags)	An array of key-value pairs to apply to this resource.
CfnInAppTemplate.Builder	templateDescription(String templateDescription)	An optional description of the in-app template.
CfnInAppTemplate.Builder	templateName(String templateName)	The name of the in-app message template.

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 CfnInAppTemplate.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 CfnInAppTemplate.Builder.

templateName

@Stability(Stable)
public CfnInAppTemplate.Builder templateName(String templateName)

The name of the in-app message template.

Parameters:

templateName - The name of the in-app message template. This parameter is required.

Returns:

this

See Also:

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

content

@Stability(Stable)
public CfnInAppTemplate.Builder content(IResolvable content)

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

Parameters:

content - An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors. This parameter is required.

Returns:

this

See Also:

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

content

@Stability(Stable)
public CfnInAppTemplate.Builder content(List<? extends Object> content)

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

Parameters:

content - An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors. This parameter is required.

Returns:

this

See Also:

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

customConfig

@Stability(Stable)
public CfnInAppTemplate.Builder customConfig(Object customConfig)

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Parameters:

customConfig - Custom data, in the form of key-value pairs, that is included in an in-app messaging payload. This parameter is required.

Returns:

this

See Also:

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

layout

@Stability(Stable)
public CfnInAppTemplate.Builder layout(String layout)

A string that determines the appearance of the in-app message. You can specify one of the following:.

• BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
• TOP_BANNER – a message that appears as a banner at the top of the page.
• OVERLAYS – a message that covers entire screen.
• MOBILE_FEED – a message that appears in a window in front of the page.
• MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
• CAROUSEL – a scrollable layout of up to five unique messages.

Parameters:

layout - A string that determines the appearance of the in-app message. You can specify one of the following:. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnInAppTemplate.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-inapptemplate.html#cfn-pinpoint-inapptemplate-tags

templateDescription

@Stability(Stable)
public CfnInAppTemplate.Builder templateDescription(String templateDescription)

An optional description of the in-app template.

Parameters:

templateDescription - An optional description of the in-app template. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnInAppTemplate build()

Specified by:

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

Returns:

a newly built instance of CfnInAppTemplate.