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

Class CfnInAppTemplatePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnInAppTemplatePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.312Z")
@Stability(Stable)
public class CfnInAppTemplatePropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a message template that you can use to send in-app messages.

A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications. The In-App channel is unavailable in AWS GovCloud (US).

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.pinpoint.*;
 import software.amazon.awscdk.*;
 Object customConfig;
 IMergeStrategy mergeStrategy;
 Object tags;
 CfnInAppTemplatePropsMixin cfnInAppTemplatePropsMixin = CfnInAppTemplatePropsMixin.Builder.create(CfnInAppTemplateMixinProps.builder()
         .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")
         .templateName("templateName")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnInAppTemplatePropsMixin.BodyConfigProperty	Specifies the configuration of the main body text of the in-app message.
static final class	CfnInAppTemplatePropsMixin.Builder	A fluent builder for CfnInAppTemplatePropsMixin.
static interface	CfnInAppTemplatePropsMixin.ButtonConfigProperty	Specifies the behavior of buttons that appear in an in-app message template.
static interface	CfnInAppTemplatePropsMixin.DefaultButtonConfigurationProperty	Specifies the default behavior of a button that appears in an in-app message.
static interface	CfnInAppTemplatePropsMixin.HeaderConfigProperty	Specifies the configuration and content of the header or title text of the in-app message.
static interface	CfnInAppTemplatePropsMixin.InAppMessageContentProperty	Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.
static interface	CfnInAppTemplatePropsMixin.OverrideButtonConfigurationProperty	Specifies the configuration of a button with settings that are specific to a certain device type.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnInAppTemplatePropsMixin(CfnInAppTemplateMixinProps props)	Create a mixin to apply properties to AWS::Pinpoint::InAppTemplate.
	CfnInAppTemplatePropsMixin(CfnInAppTemplateMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Pinpoint::InAppTemplate.
protected	CfnInAppTemplatePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInAppTemplatePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnInAppTemplateMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnInAppTemplatePropsMixin

protected CfnInAppTemplatePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnInAppTemplatePropsMixin

protected CfnInAppTemplatePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnInAppTemplatePropsMixin

@Stability(Stable)
public CfnInAppTemplatePropsMixin(@NotNull
 CfnInAppTemplateMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Pinpoint::InAppTemplate.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnInAppTemplatePropsMixin

@Stability(Stable)
public CfnInAppTemplatePropsMixin(@NotNull
 CfnInAppTemplateMixinProps props)

Create a mixin to apply properties to AWS::Pinpoint::InAppTemplate.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnInAppTemplateMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()