Class CfnInAppTemplate

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnInAppTemplate

Implements

IInspectable

IInAppTemplateRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnInAppTemplate : CfnResource, IInspectable, IInAppTemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnInAppTemplate Inherits CfnResource Implements IInspectable, IInAppTemplateRef, IConstruct, IDependable, IEnvironmentAware, 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).

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

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(Construct, string, ICfnInAppTemplateProps)

Create a new AWS::Pinpoint::InAppTemplate.

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	Creates a message template that you can use to send in-app messages.
CfnPropertyNames	Creates a message template that you can use to send in-app messages.
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.
InAppTemplateRef	A reference to a InAppTemplate resource.
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

ArnForInAppTemplate(IInAppTemplateRef)	Creates a message template that you can use to send in-app messages.
FromInAppTemplateArn(Construct, string, string)	Creates a new IInAppTemplateRef from an ARN.
FromTemplateName(Construct, string, string)	Creates a new IInAppTemplateRef from a templateName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnInAppTemplate(object)	Checks whether the given object is a CfnInAppTemplate.
RenderProperties(IDictionary<string, object>)	Creates a message template that you can use to send in-app messages.

Constructors

CfnInAppTemplate(Construct, string, ICfnInAppTemplateProps)

Create a new AWS::Pinpoint::InAppTemplate.

public CfnInAppTemplate(Construct scope, string id, ICfnInAppTemplateProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnInAppTemplateProps

Resource properties.

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

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

string

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnInAppTemplate.IInAppMessageContentProperty)[]

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

object

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

InAppTemplateRef

A reference to a InAppTemplate resource.

public virtual IInAppTemplateReference InAppTemplateRef { get; }

Property Value

IInAppTemplateReference

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

Layout

A string that determines the appearance of the in-app message.

public virtual string? Layout { get; set; }

Property Value

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

TagManager

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual object TagsRaw { get; set; }

Property Value

object

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

TemplateDescription

An optional description of the in-app template.

public virtual string? TemplateDescription { get; set; }

Property Value

string

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

TemplateName

The name of the in-app message template.

public virtual string TemplateName { get; set; }

Property Value

string

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

Methods

ArnForInAppTemplate(IInAppTemplateRef)

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

public static string ArnForInAppTemplate(IInAppTemplateRef resource)

Parameters

resource IInAppTemplateRef

Returns

string

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).

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

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"
             });

FromInAppTemplateArn(Construct, string, string)

Creates a new IInAppTemplateRef from an ARN.

public static IInAppTemplateRef FromInAppTemplateArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IInAppTemplateRef

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

FromTemplateName(Construct, string, string)

Creates a new IInAppTemplateRef from a templateName.

public static IInAppTemplateRef FromTemplateName(Construct scope, string id, string templateName)

Parameters

scope Construct

id string

templateName string

Returns

IInAppTemplateRef

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

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.

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

IsCfnInAppTemplate(object)

Checks whether the given object is a CfnInAppTemplate.

public static bool IsCfnInAppTemplate(object x)

Parameters

x object

Returns

bool

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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).

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

CloudformationResource: AWS::Pinpoint::InAppTemplate

ExampleMetadata: fixture=_generated

Implements

IInspectable

IInAppTemplateRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable