Interface Template.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Template.Builder,Template>,SdkBuilder<Template.Builder,Template>,SdkPojo
- Enclosing class:
- Template
public static interface Template.Builder extends SdkPojo, CopyableBuilder<Template.Builder,Template>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Template.Builderheaders(Collection<MessageHeader> headers)The list of message headers that will be added to the email message.Template.Builderheaders(Consumer<MessageHeader.Builder>... headers)The list of message headers that will be added to the email message.Template.Builderheaders(MessageHeader... headers)The list of message headers that will be added to the email message.Template.BuildertemplateArn(String templateArn)The Amazon Resource Name (ARN) of the template.Template.BuildertemplateData(String templateData)An object that defines the values to use for message variables in the template.Template.BuildertemplateName(String templateName)The name of the template.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
templateName
Template.Builder templateName(String templateName)
The name of the template. You will refer to this name when you send email using the
SendTemplatedEmailorSendBulkTemplatedEmailoperations.- Parameters:
templateName- The name of the template. You will refer to this name when you send email using theSendTemplatedEmailorSendBulkTemplatedEmailoperations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateArn
Template.Builder templateArn(String templateArn)
The Amazon Resource Name (ARN) of the template.
- Parameters:
templateArn- The Amazon Resource Name (ARN) of the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateData
Template.Builder templateData(String templateData)
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
- Parameters:
templateData- An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
headers
Template.Builder headers(Collection<MessageHeader> headers)
The list of message headers that will be added to the email message.
- Parameters:
headers- The list of message headers that will be added to the email message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
headers
Template.Builder headers(MessageHeader... headers)
The list of message headers that will be added to the email message.
- Parameters:
headers- The list of message headers that will be added to the email message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
headers
Template.Builder headers(Consumer<MessageHeader.Builder>... headers)
The list of message headers that will be added to the email message.
This is a convenience method that creates an instance of theMessageHeader.Builderavoiding the need to create one manually viaMessageHeader.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#headers(List.) - Parameters:
headers- a consumer that will call methods onMessageHeader.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#headers(java.util.Collection)
-
-