Class: AWSCDK::Pinpoint::CfnCampaign::EventDimensionsProperty

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

Overview

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes: nil, event_type: nil, metrics: nil) ⇒ EventDimensionsProperty

Returns a new instance of EventDimensionsProperty.

Parameters:

  • attributes (Object, nil) (defaults to: nil) —

    One or more custom attributes that your application reports to Amazon Pinpoint.

  • event_type (AWSCDK::IResolvable, AWSCDK::Pinpoint::CfnCampaign::SetDimensionProperty, nil) (defaults to: nil) —

    The name of the event that causes the campaign to be sent or the journey activity to be performed.

  • metrics (Object, nil) (defaults to: nil) —

    One or more custom metrics that your application reports to Amazon Pinpoint .



1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'pinpoint/cfn_campaign.rb', line 1283

def initialize(attributes: nil, event_type: nil, metrics: nil)
  @attributes = attributes
  Jsii::Type.check_type(@attributes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "attributes") unless @attributes.nil?
  @event_type = event_type.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::SetDimensionProperty.new(**event_type.transform_keys(&:to_sym)) : event_type
  Jsii::Type.check_type(@event_type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5TZXREaW1lbnNpb25Qcm9wZXJ0eSJ9XX19")), "eventType") unless @event_type.nil?
  @metrics = metrics
  Jsii::Type.check_type(@metrics, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "metrics") unless @metrics.nil?
end

Instance Attribute Details

#attributes ⇒ Object? (readonly)

One or more custom attributes that your application reports to Amazon Pinpoint.

You can use these attributes as selection criteria when you create an event filter.

Returns:

  • (Object, nil)

See Also:



1298
1299
1300
 
# File 'pinpoint/cfn_campaign.rb', line 1298

def attributes
  @attributes
end

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

The name of the event that causes the campaign to be sent or the journey activity to be performed.

This can be a standard event that Amazon Pinpoint generates, such as _email.delivered or _custom.delivered . For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide .

Returns:

See Also:



1305
1306
1307
 
# File 'pinpoint/cfn_campaign.rb', line 1305

def event_type
  @event_type
end

#metrics ⇒ Object? (readonly)

One or more custom metrics that your application reports to Amazon Pinpoint .

You can use these metrics as selection criteria when you create an event filter.

Returns:

  • (Object, nil)

See Also:



1312
1313
1314
 
# File 'pinpoint/cfn_campaign.rb', line 1312

def metrics
  @metrics
end

Class Method Details

.jsii_properties ⇒ Object 



1314
1315
1316
1317
1318
1319
1320
 
# File 'pinpoint/cfn_campaign.rb', line 1314

def self.jsii_properties
  {
    :attributes => "attributes",
    :event_type => "eventType",
    :metrics => "metrics",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'pinpoint/cfn_campaign.rb', line 1322

def to_jsii
  result = {}
  result.merge!({
    "attributes" => @attributes,
    "eventType" => @event_type,
    "metrics" => @metrics,
  })
  result.compact
end