software.amazon.awscdk.services.pinpoint

Class CfnInAppTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnInAppTemplate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.223Z")
 @Stability(value=Stable)
public class CfnInAppTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::InAppTemplate`.

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.

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;
 CfnInAppTemplate cfnInAppTemplate = CfnInAppTemplate.Builder.create(this, "MyCfnInAppTemplate")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnInAppTemplate.BodyConfigProperty Specifies the configuration of the main body text of the in-app message.
static class	CfnInAppTemplate.Builder A fluent builder for CfnInAppTemplate.
static interface	CfnInAppTemplate.ButtonConfigProperty Specifies the behavior of buttons that appear in an in-app message template.
static interface	CfnInAppTemplate.DefaultButtonConfigurationProperty Specifies the default behavior of a button that appears in an in-app message.
static interface	CfnInAppTemplate.HeaderConfigProperty Specifies the configuration and content of the header or title text of the in-app message.
static interface	CfnInAppTemplate.InAppMessageContentProperty Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.
static interface	CfnInAppTemplate.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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnInAppTemplate(software.constructs.Construct scope, String id, CfnInAppTemplateProps props) Create a new `AWS::Pinpoint::InAppTemplate`.
protected	CfnInAppTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInAppTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the message template.
protected Map<String,Object>	getCfnProperties()
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.
Object	getCustomConfig() Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
String	getLayout() A string that determines the appearance of the in-app message.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getTemplateDescription() An optional description of the in-app template.
String	getTemplateName() The name of the in-app message template.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContent(IResolvable value) 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.
void	setContent(List<Object> value) 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.
void	setCustomConfig(Object value) Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
void	setLayout(String value) A string that determines the appearance of the in-app message.
void	setTemplateDescription(String value) An optional description of the in-app template.
void	setTemplateName(String value) The name of the in-app message template.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInAppTemplate

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

CfnInAppTemplate

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

CfnInAppTemplate

@Stability(value=Stable)
public CfnInAppTemplate(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnInAppTemplateProps props)

Create a new `AWS::Pinpoint::InAppTemplate`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the message template.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getCustomConfig

@Stability(value=Stable)
 @NotNull
public Object getCustomConfig()

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

setCustomConfig

@Stability(value=Stable)
public void setCustomConfig(@NotNull
                                                     Object value)

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

getTemplateName

@Stability(value=Stable)
 @NotNull
public String getTemplateName()

The name of the in-app message template.

setTemplateName

@Stability(value=Stable)
public void setTemplateName(@NotNull
                                                     String value)

The name of the in-app message template.

getContent

@Stability(value=Stable)
 @Nullable
public 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.

setContent

@Stability(value=Stable)
public void setContent(@Nullable
                                                IResolvable value)

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.

setContent

@Stability(value=Stable)
public void setContent(@Nullable
                                                List<Object> value)

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.

getLayout

@Stability(value=Stable)
 @Nullable
public 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.

setLayout

@Stability(value=Stable)
public void setLayout(@Nullable
                                               String value)

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.

getTemplateDescription

@Stability(value=Stable)
 @Nullable
public String getTemplateDescription()

An optional description of the in-app template.

setTemplateDescription

@Stability(value=Stable)
public void setTemplateDescription(@Nullable
                                                            String value)

An optional description of the in-app template.