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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-21T06:34:11.811Z")
@Stability(Stable)
public class CfnInAppTemplate
extends CfnResource
implements IInspectable, ITaggable
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.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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Specifies the configuration of the main body text of the in-app message.static final class
A fluent builder forCfnInAppTemplate
.static interface
Specifies the behavior of buttons that appear in an in-app message template.static interface
Specifies the default behavior of a button that appears in an in-app message.static interface
Specifies the configuration and content of the header or title text of the in-app message.static interface
Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.static interface
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.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnInAppTemplate
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnInAppTemplate
(software.amazon.jsii.JsiiObjectRef objRef) CfnInAppTemplate
(software.constructs.Construct scope, String id, CfnInAppTemplateProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the message template.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.Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.A string that determines the appearance of the in-app message.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.An optional description of the in-app template.The name of the in-app message template.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) 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
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
setCustomConfig
(Object value) Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.void
A string that determines the appearance of the in-app message.void
setTagsRaw
(Object value) An array of key-value pairs to apply to this resource.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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnInAppTemplate
protected CfnInAppTemplate(software.amazon.jsii.JsiiObjectRef objRef) -
CfnInAppTemplate
protected CfnInAppTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnInAppTemplate
@Stability(Stable) public CfnInAppTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInAppTemplateProps props) - 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.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the message template. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getTemplateName
The name of the in-app message template. -
setTemplateName
The name of the in-app message template. -
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
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
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. -
getCustomConfig
Custom data, in the form of key-value pairs, that is included in an in-app messaging payload. -
setCustomConfig
Custom data, in the form of key-value pairs, that is included in an in-app messaging payload. -
getLayout
A string that determines the appearance of the in-app message.You can specify one of the following:.
-
setLayout
A string that determines the appearance of the in-app message.You can specify one of the following:.
-
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource. -
getTemplateDescription
An optional description of the in-app template. -
setTemplateDescription
An optional description of the in-app template.
-