Show / Hide Table of Contents

Class CfnSmsTemplate

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnSmsTemplate
Implements
IInspectable
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.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
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.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
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(Construct, string, ICfnSmsTemplateProps)

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

Properties

AttrArn

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

AttrId

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

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

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

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

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

Constructors

CfnSmsTemplate(Construct, string, ICfnSmsTemplateProps)

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

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

Scope in which this resource is defined.

id string

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

props ICfnSmsTemplateProps

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

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

AttrId

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

public virtual string AttrId { get; }
Property Value

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

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

CfnProperties

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

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

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

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

TemplateDescription

A custom description of the message 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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

TemplateName

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

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

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.

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

RenderProperties(IDictionary<string, object>)

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

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.

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

CloudformationResource: AWS::Pinpoint::SmsTemplate

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITaggable
Back to top Generated by DocFX