Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Class CfnSmsTemplatePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnSmsTemplatePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSmsTemplatePropsMixin>

Enclosing class:

CfnSmsTemplatePropsMixin

@Stability(Stable)
public static final class CfnSmsTemplatePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSmsTemplatePropsMixin>

A fluent builder for CfnSmsTemplatePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnSmsTemplatePropsMixin.Builder	body(String body)	The message body to use in text messages that are based on the message template.
CfnSmsTemplatePropsMixin	build()
static CfnSmsTemplatePropsMixin.Builder	create()
static CfnSmsTemplatePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnSmsTemplatePropsMixin.Builder	defaultSubstitutions(String defaultSubstitutions)	A JSON object that specifies the default values to use for message variables in the message template.
CfnSmsTemplatePropsMixin.Builder	tags(Object tags)	An array of key-value pairs to apply to this resource.
CfnSmsTemplatePropsMixin.Builder	templateDescription(String templateDescription)	A custom description of the message template.
CfnSmsTemplatePropsMixin.Builder	templateName(String templateName)	The name of the message template to use for the message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnSmsTemplatePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnSmsTemplatePropsMixin.Builder.

create

@Stability(Stable)
public static CfnSmsTemplatePropsMixin.Builder create()

Returns:

a new instance of CfnSmsTemplatePropsMixin.Builder.

body

@Stability(Stable)
public CfnSmsTemplatePropsMixin.Builder body(String body)

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

Parameters:

body - The message body to use in text messages that are based on the message template. This parameter is required.

Returns:

this

See Also:

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

defaultSubstitutions

@Stability(Stable)
public CfnSmsTemplatePropsMixin.Builder defaultSubstitutions(String defaultSubstitutions)

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

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.

Parameters:

defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnSmsTemplatePropsMixin.Builder tags(Object tags)

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

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

templateDescription

@Stability(Stable)
public CfnSmsTemplatePropsMixin.Builder templateDescription(String templateDescription)

A custom description of the message template.

Parameters:

templateDescription - A custom description of the message template. This parameter is required.

Returns:

this

See Also:

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

templateName

@Stability(Stable)
public CfnSmsTemplatePropsMixin.Builder templateName(String templateName)

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

If specified, this value must match the name of an existing message template.

Parameters:

templateName - The name of the message template to use for the message. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSmsTemplatePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSmsTemplatePropsMixin>

Returns:

a newly built instance of CfnSmsTemplatePropsMixin.