Class: AWSCDK::Pinpoint::CfnCampaign::CampaignEventFilterProperty

Inherits:

Jsii::Struct

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

Defined in:

pinpoint/cfn_campaign.rb

Overview

Specifies the settings for events that cause a campaign to be sent.

See Also:

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

Instance Attribute Summary

• #dimensions ⇒ AWSCDK::IResolvable, ... readonly

  The dimension settings of the event filter for the campaign.

• #filter_type ⇒ String^? readonly

  The type of event that causes the campaign to be sent.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(dimensions: nil, filter_type: nil) ⇒ CampaignEventFilterProperty constructor

  A new instance of CampaignEventFilterProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(dimensions: nil, filter_type: nil) ⇒ CampaignEventFilterProperty

Returns a new instance of CampaignEventFilterProperty.

Parameters:

• dimensions (AWSCDK::IResolvable, AWSCDK::Pinpoint::CfnCampaign::EventDimensionsProperty, nil) (defaults to: nil) —

  The dimension settings of the event filter for the campaign.

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

  The type of event that causes the campaign to be sent.

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

def initialize(dimensions: nil, filter_type: nil)
  @dimensions = dimensions.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::EventDimensionsProperty.new(**dimensions.transform_keys(&:to_sym)) : dimensions
  Jsii::Type.check_type(@dimensions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5FdmVudERpbWVuc2lvbnNQcm9wZXJ0eSJ9XX19")), "dimensions") unless @dimensions.nil?
  @filter_type = filter_type
  Jsii::Type.check_type(@filter_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterType") unless @filter_type.nil?
end

Instance Attribute Details

#dimensions ⇒ AWSCDK::IResolvable, ... (readonly)

The dimension settings of the event filter for the campaign.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Pinpoint::CfnCampaign::EventDimensionsProperty, nil)

See Also:

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

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

def dimensions
  @dimensions
end

#filter_type ⇒ String^? (readonly)

The type of event that causes the campaign to be sent.

Valid values are: SYSTEM , sends the campaign when a system event occurs; and, ENDPOINT , sends the campaign when an endpoint event (Events resource) occurs.

Returns:

• (String, nil)

See Also:

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

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

def filter_type
  @filter_type
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :dimensions => "dimensions",
    :filter_type => "filterType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "dimensions" => @dimensions,
    "filterType" => @filter_type,
  })
  result.compact
end