Class: AWSCDK::Pinpoint::CfnCampaign::LimitsProperty

Inherits:

Jsii::Struct

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

Defined in:

pinpoint/cfn_campaign.rb

Overview

Specifies the limits on the messages that a campaign can send.

See Also:

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

Instance Attribute Summary

• #daily ⇒ Numeric^? readonly

  The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.

• #maximum_duration ⇒ Numeric^? readonly

  The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.

• #messages_per_second ⇒ Numeric^? readonly

  The maximum number of messages that a campaign can send each second.

• #session ⇒ Numeric^? readonly

  The maximum number of messages that the campaign can send per user session.

• #total ⇒ Numeric^? readonly

  The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(daily: nil, maximum_duration: nil, messages_per_second: nil, session: nil, total: nil) ⇒ LimitsProperty constructor

  A new instance of LimitsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(daily: nil, maximum_duration: nil, messages_per_second: nil, session: nil, total: nil) ⇒ LimitsProperty

Returns a new instance of LimitsProperty.

Parameters:

• daily (Numeric, nil) (defaults to: nil) —

  The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.

• maximum_duration (Numeric, nil) (defaults to: nil) —

  The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.

• messages_per_second (Numeric, nil) (defaults to: nil) —

  The maximum number of messages that a campaign can send each second.

• session (Numeric, nil) (defaults to: nil) —

  The maximum number of messages that the campaign can send per user session.

• total (Numeric, nil) (defaults to: nil) —

  The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

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

def initialize(daily: nil, maximum_duration: nil, messages_per_second: nil, session: nil, total: nil)
  @daily = daily
  Jsii::Type.check_type(@daily, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "daily") unless @daily.nil?
  @maximum_duration = maximum_duration
  Jsii::Type.check_type(@maximum_duration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumDuration") unless @maximum_duration.nil?
  @messages_per_second = messages_per_second
  Jsii::Type.check_type(@messages_per_second, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "messagesPerSecond") unless @messages_per_second.nil?
  @session = session
  Jsii::Type.check_type(@session, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "session") unless @session.nil?
  @total = total
  Jsii::Type.check_type(@total, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "total") unless @total.nil?
end

Instance Attribute Details

#daily ⇒ Numeric^? (readonly)

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.

The maximum value is 100.

Returns:

• (Numeric, nil)

See Also:

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

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

def daily
  @daily
end

#maximum_duration ⇒ Numeric^? (readonly)

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.

The minimum value is 60 seconds.

Returns:

• (Numeric, nil)

See Also:

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

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

def maximum_duration
  @maximum_duration
end

#messages_per_second ⇒ Numeric^? (readonly)

The maximum number of messages that a campaign can send each second.

The minimum value is 1. The maximum value is 20,000.

Returns:

• (Numeric, nil)

See Also:

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

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

def messages_per_second
  @messages_per_second
end

#session ⇒ Numeric^? (readonly)

The maximum number of messages that the campaign can send per user session.

Returns:

• (Numeric, nil)

See Also:

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

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

def session
  @session
end

#total ⇒ Numeric^? (readonly)

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

The maximum value is 100.

Returns:

• (Numeric, nil)

See Also:

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

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

def total
  @total
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :daily => "daily",
    :maximum_duration => "maximumDuration",
    :messages_per_second => "messagesPerSecond",
    :session => "session",
    :total => "total",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "daily" => @daily,
    "maximumDuration" => @maximum_duration,
    "messagesPerSecond" => @messages_per_second,
    "session" => @session,
    "total" => @total,
  })
  result.compact
end