Class CfnInAppTemplate
Creates a message template that you can use to send in-app messages.
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnInAppTemplate : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnInAppTemplate
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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).
CloudformationResource: AWS::Pinpoint::InAppTemplate
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;
var customConfig;
var tags;
var cfnInAppTemplate = new CfnInAppTemplate(this, "MyCfnInAppTemplate", new CfnInAppTemplateProps {
TemplateName = "templateName",
// the properties below are optional
Content = new [] { new InAppMessageContentProperty {
BackgroundColor = "backgroundColor",
BodyConfig = new BodyConfigProperty {
Alignment = "alignment",
Body = "body",
TextColor = "textColor"
},
HeaderConfig = new HeaderConfigProperty {
Alignment = "alignment",
Header = "header",
TextColor = "textColor"
},
ImageUrl = "imageUrl",
PrimaryBtn = new ButtonConfigProperty {
Android = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
DefaultConfig = new DefaultButtonConfigurationProperty {
BackgroundColor = "backgroundColor",
BorderRadius = 123,
ButtonAction = "buttonAction",
Link = "link",
Text = "text",
TextColor = "textColor"
},
Ios = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
Web = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
}
},
SecondaryBtn = new ButtonConfigProperty {
Android = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
DefaultConfig = new DefaultButtonConfigurationProperty {
BackgroundColor = "backgroundColor",
BorderRadius = 123,
ButtonAction = "buttonAction",
Link = "link",
Text = "text",
TextColor = "textColor"
},
Ios = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
Web = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
}
}
} },
CustomConfig = customConfig,
Layout = "layout",
Tags = tags,
TemplateDescription = "templateDescription"
});
Synopsis
Constructors
CfnInAppTemplate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnInAppTemplate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnInAppTemplate(Construct, String, ICfnInAppTemplateProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the message template. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
CustomConfig | Custom data, in the form of key-value pairs, that is included in an in-app messaging payload. |
Layout | A string that determines the appearance of the in-app message. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
TemplateDescription | An optional description of the in-app template. |
TemplateName | The name of the in-app message template. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnInAppTemplate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnInAppTemplate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnInAppTemplate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnInAppTemplate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnInAppTemplate(Construct, String, ICfnInAppTemplateProps)
public CfnInAppTemplate(Construct scope, string id, ICfnInAppTemplateProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnInAppTemplateProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the message template.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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.
public virtual object Content { get; set; }
Property Value
System.Object
CustomConfig
Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
public virtual object CustomConfig { get; set; }
Property Value
System.Object
Layout
A string that determines the appearance of the in-app message.
public virtual string Layout { get; set; }
Property Value
System.String
Remarks
You can specify one of the following:.
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
TemplateDescription
An optional description of the in-app template.
public virtual string TemplateDescription { get; set; }
Property Value
System.String
TemplateName
The name of the in-app message template.
public virtual string TemplateName { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>