Class: AWSCDK::Pinpoint::CfnCampaign::CampaignHookProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint/cfn_campaign.rb

Overview

Specifies settings for invoking an Lambda function that customizes a segment for a campaign.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lambda_function_name: nil, mode: nil, web_url: nil) ⇒ CampaignHookProperty

Returns a new instance of CampaignHookProperty.

Parameters:

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

    The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

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

    The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:.

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

    The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.



937
938
939
940
941
942
943
944
 
# File 'pinpoint/cfn_campaign.rb', line 937

def initialize(lambda_function_name: nil, mode: nil, web_url: nil)
  @lambda_function_name = lambda_function_name
  Jsii::Type.check_type(@lambda_function_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lambdaFunctionName") unless @lambda_function_name.nil?
  @mode = mode
  Jsii::Type.check_type(@mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mode") unless @mode.nil?
  @web_url = web_url
  Jsii::Type.check_type(@web_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webUrl") unless @web_url.nil?
end

Instance Attribute Details

#lambda_function_name ⇒ String? (readonly)

The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

Returns:

  • (String, nil)

See Also:



950
951
952
 
# File 'pinpoint/cfn_campaign.rb', line 950

def lambda_function_name
  @lambda_function_name
end

#mode ⇒ String? (readonly)

The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:.

  • FILTER - Invoke the function to customize the segment that's used by a campaign.
  • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

Returns:

  • (String, nil)

See Also:



958
959
960
 
# File 'pinpoint/cfn_campaign.rb', line 958

def mode
  @mode
end

#web_url ⇒ String? (readonly)

The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

Returns:

  • (String, nil)

See Also:



963
964
965
 
# File 'pinpoint/cfn_campaign.rb', line 963

def web_url
  @web_url
end

Class Method Details

.jsii_properties ⇒ Object 



965
966
967
968
969
970
971
 
# File 'pinpoint/cfn_campaign.rb', line 965

def self.jsii_properties
  {
    :lambda_function_name => "lambdaFunctionName",
    :mode => "mode",
    :web_url => "webUrl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



973
974
975
976
977
978
979
980
981
 
# File 'pinpoint/cfn_campaign.rb', line 973

def to_jsii
  result = {}
  result.merge!({
    "lambdaFunctionName" => @lambda_function_name,
    "mode" => @mode,
    "webUrl" => @web_url,
  })
  result.compact
end