Class CfnSmsTemplate
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.pinpoint.CfnSmsTemplate
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-11T23:26:37.033Z")
@Stability(Stable)
public class CfnSmsTemplate
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnSmsTemplate
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnSmsTemplate
(software.amazon.jsii.JsiiObjectRef objRef) CfnSmsTemplate
(software.constructs.Construct scope, String id, CfnSmsTemplateProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the message template.getBody()
The message body to use in text messages that are based on the message template.A JSON object that specifies the default values to use for message variables in the message template.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.A custom description of the message template.The name of the message template to use for the message.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
The message body to use in text messages that are based on the message template.void
setDefaultSubstitutions
(String value) A JSON object that specifies the default values to use for message variables in the message template.void
setTagsRaw
(Object value) An array of key-value pairs to apply to this resource.void
setTemplateDescription
(String value) A custom description of the message template.void
setTemplateName
(String value) The name of the message template to use for the message.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnSmsTemplate
protected CfnSmsTemplate(software.amazon.jsii.JsiiObjectRef objRef) -
CfnSmsTemplate
protected CfnSmsTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnSmsTemplate
@Stability(Stable) public CfnSmsTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSmsTemplateProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the message template. -
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getBody
The message body to use in text messages that are based on the message template. -
setBody
The message body to use in text messages that are based on the message template. -
getTemplateName
The name of the message template to use for the message. -
setTemplateName
The name of the message template to use for the message. -
getDefaultSubstitutions
A JSON object that specifies the default values to use for message variables in the message template. -
setDefaultSubstitutions
A JSON object that specifies the default values to use for message variables in the message template. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource. -
getTemplateDescription
A custom description of the message template. -
setTemplateDescription
A custom description of the message template.
-