Class CfnSmsTemplate

Creates a message template that you can use in messages that are sent through the SMS channel.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnSmsTemplate
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSmsTemplate : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnSmsTemplate
    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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

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 tags;

var cfnSmsTemplate = new CfnSmsTemplate(this, "MyCfnSmsTemplate", new CfnSmsTemplateProps {
    Body = "body",
    TemplateName = "templateName",

    // the properties below are optional
    DefaultSubstitutions = "defaultSubstitutions",
    Tags = tags,
    TemplateDescription = "templateDescription"
});

Synopsis

Constructors

CfnSmsTemplate(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnSmsTemplate(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnSmsTemplate(Construct, String, ICfnSmsTemplateProps)

Properties

AttrArn

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

The message body to use in text messages that are based on the message template.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
DefaultSubstitutions

A JSON object that specifies the default values to use for message variables in the message template.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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

A custom description of the message template.
TemplateName

The name of the message template to use for the message.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnSmsTemplate(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnSmsTemplate(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnSmsTemplate(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnSmsTemplate(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnSmsTemplate(Construct, String, ICfnSmsTemplateProps)

public CfnSmsTemplate(Construct scope, string id, ICfnSmsTemplateProps 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 ICfnSmsTemplateProps

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

AttrId

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

Body

The message body to use in text messages that are based on the message template.

public virtual string Body { get; set; }
Property Value

System.String

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

DefaultSubstitutions

A JSON object that specifies the default values to use for message variables in the message template.

public virtual string DefaultSubstitutions { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

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

public virtual object TagsRaw { get; set; }
Property Value

System.Object

TemplateDescription

A custom description of the message template.

public virtual string TemplateDescription { get; set; }
Property Value

System.String

TemplateName

The name of the message template to use for the message.

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>

Overrides

Implements