Class: AWSCDK::Pinpoint::CfnCampaign::CustomDeliveryConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pinpoint::CfnCampaign::CustomDeliveryConfigurationProperty

Defined in:

pinpoint/cfn_campaign.rb

Overview

Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel.

This object is required if you use the CampaignCustomMessage object to define the message to send for the campaign or campaign treatment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html

Instance Attribute Summary

• #delivery_uri ⇒ String^? readonly

  The destination to send the campaign or treatment to.

• #endpoint_types ⇒ Array<String>^? readonly

  The types of endpoints to send the campaign or treatment to.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(delivery_uri: nil, endpoint_types: nil) ⇒ CustomDeliveryConfigurationProperty constructor

  A new instance of CustomDeliveryConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(delivery_uri: nil, endpoint_types: nil) ⇒ CustomDeliveryConfigurationProperty

Returns a new instance of CustomDeliveryConfigurationProperty.

Parameters:

• delivery_uri (String, nil) (defaults to: nil) —

  The destination to send the campaign or treatment to. This value can be one of the following:.

• endpoint_types (Array<String>, nil) (defaults to: nil) —

  The types of endpoints to send the campaign or treatment to.

# File 'pinpoint/cfn_campaign.rb', line 1143

def initialize(delivery_uri: nil, endpoint_types: nil)
  @delivery_uri = delivery_uri
  Jsii::Type.check_type(@delivery_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryUri") unless @delivery_uri.nil?
  @endpoint_types = endpoint_types
  Jsii::Type.check_type(@endpoint_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "endpointTypes") unless @endpoint_types.nil?
end

Instance Attribute Details

#delivery_uri ⇒ String^? (readonly)

The destination to send the campaign or treatment to. This value can be one of the following:.

• The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
• The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-deliveryuri

# File 'pinpoint/cfn_campaign.rb', line 1157

def delivery_uri
  @delivery_uri
end

#endpoint_types ⇒ Array<String>^? (readonly)

The types of endpoints to send the campaign or treatment to.

Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-endpointtypes

# File 'pinpoint/cfn_campaign.rb', line 1164

def endpoint_types
  @endpoint_types
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pinpoint/cfn_campaign.rb', line 1166

def self.jsii_properties
  {
    :delivery_uri => "deliveryUri",
    :endpoint_types => "endpointTypes",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pinpoint/cfn_campaign.rb', line 1173

def to_jsii
  result = {}
  result.merge!({
    "deliveryUri" => @delivery_uri,
    "endpointTypes" => @endpoint_types,
  })
  result.compact
end