@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:18.434Z") public class CfnSmsTemplate extends CfnResource implements IInspectable
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.pinpoint.*; Object tags; CfnSmsTemplate cfnSmsTemplate = CfnSmsTemplate.Builder.create(this, "MyCfnSmsTemplate") .body("body") .templateName("templateName") // the properties below are optional .defaultSubstitutions("defaultSubstitutions") .tags(tags) .templateDescription("templateDescription") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnSmsTemplate.Builder
A fluent builder for
CfnSmsTemplate . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnSmsTemplate(Construct scope,
java.lang.String id,
CfnSmsTemplateProps props)
Create a new `AWS::Pinpoint::SmsTemplate`.
|
protected |
CfnSmsTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnSmsTemplate(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the message template.
|
java.lang.String |
getBody()
The message body to use in text messages that are based on the message template.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDefaultSubstitutions()
A JSON object that specifies the default values to use for message variables in the message template.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
java.lang.String |
getTemplateDescription()
A custom description of the message template.
|
java.lang.String |
getTemplateName()
The name of the message template.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setBody(java.lang.String value)
The message body to use in text messages that are based on the message template.
|
void |
setDefaultSubstitutions(java.lang.String value)
A JSON object that specifies the default values to use for message variables in the message template.
|
void |
setTemplateDescription(java.lang.String value)
A custom description of the message template.
|
void |
setTemplateName(java.lang.String value)
The name of the message template.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnSmsTemplate(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnSmsTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnSmsTemplate(Construct scope, java.lang.String id, CfnSmsTemplateProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getBody()
public void setBody(java.lang.String value)
public java.lang.String getTemplateName()
public void setTemplateName(java.lang.String value)
public java.lang.String getDefaultSubstitutions()
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.
public void setDefaultSubstitutions(java.lang.String value)
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.
public java.lang.String getTemplateDescription()
public void setTemplateDescription(java.lang.String value)