Class: Aws::Pinpoint::Types::AddressConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::AddressConfiguration
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
Specifies address-based configuration settings for a message that's sent directly to an endpoint.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#body_override ⇒ String
The message body to use instead of the default message body.
-
#channel_type ⇒ String
The channel to use when sending the message.
-
#context ⇒ Hash<String,String>
An object that maps custom attributes to attributes for the address and is attached to the message.
-
#raw_content ⇒ String
The raw, JSON-formatted string to use as the payload for the message.
-
#substitutions ⇒ Hash<String,Array<String>>
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object.
-
#title_override ⇒ String
The message title to use instead of the default message title.
Instance Attribute Details
#body_override ⇒ String
The message body to use instead of the default message body. This value overrides the default message body.
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1320 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) SENSITIVE = [] include Aws::Structure end |
#channel_type ⇒ String
The channel to use when sending the message.
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1320 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) SENSITIVE = [] include Aws::Structure end |
#context ⇒ Hash<String,String>
An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1320 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) SENSITIVE = [] include Aws::Structure end |
#raw_content ⇒ String
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1320 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) SENSITIVE = [] include Aws::Structure end |
#substitutions ⇒ Hash<String,Array<String>>
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1320 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) SENSITIVE = [] include Aws::Structure end |
#title_override ⇒ String
The message title to use instead of the default message title. This value overrides the default message title.
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1320 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) SENSITIVE = [] include Aws::Structure end |