Class CfnSmsTemplate

A CloudFormation AWS::Pinpoint::SmsTemplate.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnSmsTemplate

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.AWS.Pinpoint.dll

Syntax (csharp)

public class CfnSmsTemplate : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnSmsTemplate
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

Creates a message template that you can use in messages that are sent through the SMS channel. 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.

CloudformationResource: AWS::Pinpoint::SmsTemplate

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

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(Construct, String, ICfnSmsTemplateProps)	Create a new `AWS::Pinpoint::SmsTemplate`.
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

Properties

AttrArn	The Amazon Resource Name (ARN) of the message template.
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	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.

Methods

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

Constructors

CfnSmsTemplate(Construct, String, ICfnSmsTemplateProps)

Create a new AWS::Pinpoint::SmsTemplate.

public CfnSmsTemplate(Construct scope, string id, ICfnSmsTemplateProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnSmsTemplateProps

resource properties.

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

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

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

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-body

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

CfnResource.CfnProperties

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

Remarks

This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-defaultsubstitutions

TemplateDescription

A custom description of the message template.

public virtual string TemplateDescription { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatedescription

TemplateName

The name of the message template.

public virtual string TemplateName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatename

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

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable