You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::AddressConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AddressConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  body_override: "__string",
  channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
  context: {
    "__string" => "__string",
  },
  raw_content: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  title_override: "__string",
}

Specifies address-based configuration settings for a message that's sent directly to an endpoint.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#body_override ⇒ String

The message body to use instead of the default message body. This value overrides the default message body.

Returns:

  • (String) —

    The message body to use instead of the default message body.

#channel_type ⇒ String

The channel to use when sending the message.

Possible values:

  • PUSH
  • GCM
  • APNS
  • APNS_SANDBOX
  • APNS_VOIP
  • APNS_VOIP_SANDBOX
  • ADM
  • SMS
  • VOICE
  • EMAIL
  • BAIDU
  • CUSTOM

Returns:

  • (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. 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.

Returns:

  • (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. If specified, this value overrides all other values for the message.

Returns:

  • (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. The variables specified in this map take precedence over all other variables.

Returns:

  • (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. This value overrides the default message title.

Returns:

  • (String) —

    The message title to use instead of the default message title.