Package software.amazon.awscdk.services.pinpoint

Interface CfnInAppTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInAppTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:43.203Z")
@Stability(Stable)
public interface CfnInAppTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnInAppTemplate.

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 customConfig;
 Object tags;
 CfnInAppTemplateProps cfnInAppTemplateProps = CfnInAppTemplateProps.builder()
         .templateName("templateName")
         // the properties below are optional
         .content(List.of(InAppMessageContentProperty.builder()
                 .backgroundColor("backgroundColor")
                 .bodyConfig(BodyConfigProperty.builder()
                         .alignment("alignment")
                         .body("body")
                         .textColor("textColor")
                         .build())
                 .headerConfig(HeaderConfigProperty.builder()
                         .alignment("alignment")
                         .header("header")
                         .textColor("textColor")
                         .build())
                 .imageUrl("imageUrl")
                 .primaryBtn(ButtonConfigProperty.builder()
                         .android(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                 .backgroundColor("backgroundColor")
                                 .borderRadius(123)
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .text("text")
                                 .textColor("textColor")
                                 .build())
                         .ios(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .web(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .build())
                 .secondaryBtn(ButtonConfigProperty.builder()
                         .android(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                 .backgroundColor("backgroundColor")
                                 .borderRadius(123)
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .text("text")
                                 .textColor("textColor")
                                 .build())
                         .ios(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .web(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .build())
                 .build()))
         .customConfig(customConfig)
         .layout("layout")
         .tags(tags)
         .templateDescription("templateDescription")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInAppTemplateProps.Builder	A builder for CfnInAppTemplateProps
static final class	CfnInAppTemplateProps.Jsii$Proxy	An implementation for CfnInAppTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnInAppTemplateProps.Builder	builder()
default Object	getContent()	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.
default Object	getCustomConfig()	Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
default String	getLayout()	A string that determines the appearance of the in-app message.
default Object	getTags()	An array of key-value pairs to apply to this resource.
default String	getTemplateDescription()	An optional description of the in-app template.
String	getTemplateName()	The name of the in-app message template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTemplateName

@Stability(Stable)
@NotNull
String getTemplateName()

The name of the in-app message template.

See Also:

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

getContent

@Stability(Stable)
@Nullable
default Object getContent()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnInAppTemplate.InAppMessageContentProperty>

See Also:

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

getCustomConfig

@Stability(Stable)
@Nullable
default Object getCustomConfig()

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

See Also:

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

getLayout

@Stability(Stable)
@Nullable
default String getLayout()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Object getTags()

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

For more information, see Tag .

See Also:

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

getTemplateDescription

@Stability(Stable)
@Nullable
default String getTemplateDescription()

An optional description of the in-app template.

See Also:

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

builder

@Stability(Stable)
static CfnInAppTemplateProps.Builder builder()

Returns:

a CfnInAppTemplateProps.Builder of CfnInAppTemplateProps