Class: AWSCDK::Pinpoint::CfnCampaign::ScheduleProperty

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

Overview

Specifies the schedule settings for a campaign.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(end_time: nil, event_filter: nil, frequency: nil, is_local_time: nil, quiet_time: nil, start_time: nil, time_zone: nil) ⇒ ScheduleProperty

Returns a new instance of ScheduleProperty.

Parameters:

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

    The scheduled time, in ISO 8601 format, when the campaign ended or will end.

  • event_filter (AWSCDK::IResolvable, AWSCDK::Pinpoint::CfnCampaign::CampaignEventFilterProperty, nil) (defaults to: nil) —

    The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT .

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

    Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

  • is_local_time (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the start and end times for the campaign schedule use each recipient's local time.

  • quiet_time (AWSCDK::IResolvable, AWSCDK::Pinpoint::CfnCampaign::QuietTimeProperty, nil) (defaults to: nil) —

    The default quiet time for the campaign.

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

    The scheduled time when the campaign began or will begin.

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

    The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true .



2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
 
# File 'pinpoint/cfn_campaign.rb', line 2102

def initialize(end_time: nil, event_filter: nil, frequency: nil, is_local_time: nil, quiet_time: nil, start_time: nil, time_zone: nil)
  @end_time = end_time
  Jsii::Type.check_type(@end_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endTime") unless @end_time.nil?
  @event_filter = event_filter.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::CampaignEventFilterProperty.new(**event_filter.transform_keys(&:to_sym)) : event_filter
  Jsii::Type.check_type(@event_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5DYW1wYWlnbkV2ZW50RmlsdGVyUHJvcGVydHkifV19fQ==")), "eventFilter") unless @event_filter.nil?
  @frequency = frequency
  Jsii::Type.check_type(@frequency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "frequency") unless @frequency.nil?
  @is_local_time = is_local_time
  Jsii::Type.check_type(@is_local_time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isLocalTime") unless @is_local_time.nil?
  @quiet_time = quiet_time.is_a?(Hash) ? ::AWSCDK::Pinpoint::CfnCampaign::QuietTimeProperty.new(**quiet_time.transform_keys(&:to_sym)) : quiet_time
  Jsii::Type.check_type(@quiet_time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludC5DZm5DYW1wYWlnbi5RdWlldFRpbWVQcm9wZXJ0eSJ9XX19")), "quietTime") unless @quiet_time.nil?
  @start_time = start_time
  Jsii::Type.check_type(@start_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startTime") unless @start_time.nil?
  @time_zone = time_zone
  Jsii::Type.check_type(@time_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeZone") unless @time_zone.nil?
end

Instance Attribute Details

#end_time ⇒ String? (readonly)

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

Returns:

  • (String, nil)

See Also:



2123
2124
2125
 
# File 'pinpoint/cfn_campaign.rb', line 2123

def end_time
  @end_time
end

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

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT .

Returns:

See Also:



2128
2129
2130
 
# File 'pinpoint/cfn_campaign.rb', line 2128

def event_filter
  @event_filter
end

#frequency ⇒ String? (readonly)

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

Returns:

  • (String, nil)

See Also:



2133
2134
2135
 
# File 'pinpoint/cfn_campaign.rb', line 2133

def frequency
  @frequency
end

#is_local_time ⇒ Boolean, ... (readonly)

Specifies whether the start and end times for the campaign schedule use each recipient's local time.

To base the schedule on each recipient's local time, set this value to true .

Returns:

See Also:



2140
2141
2142
 
# File 'pinpoint/cfn_campaign.rb', line 2140

def is_local_time
  @is_local_time
end

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

The default quiet time for the campaign.

Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

  • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
  • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

Returns:

See Also:



2153
2154
2155
 
# File 'pinpoint/cfn_campaign.rb', line 2153

def quiet_time
  @quiet_time
end

#start_time ⇒ String? (readonly)

The scheduled time when the campaign began or will begin.

Valid values are: IMMEDIATE , to start the campaign immediately; or, a specific time in ISO 8601 format.

Returns:

  • (String, nil)

See Also:



2160
2161
2162
 
# File 'pinpoint/cfn_campaign.rb', line 2160

def start_time
  @start_time
end

#time_zone ⇒ String? (readonly)

The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true .

Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11 .

Returns:

  • (String, nil)

See Also:



2167
2168
2169
 
# File 'pinpoint/cfn_campaign.rb', line 2167

def time_zone
  @time_zone
end

Class Method Details

.jsii_properties ⇒ Object 



2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
 
# File 'pinpoint/cfn_campaign.rb', line 2169

def self.jsii_properties
  {
    :end_time => "endTime",
    :event_filter => "eventFilter",
    :frequency => "frequency",
    :is_local_time => "isLocalTime",
    :quiet_time => "quietTime",
    :start_time => "startTime",
    :time_zone => "timeZone",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
 
# File 'pinpoint/cfn_campaign.rb', line 2181

def to_jsii
  result = {}
  result.merge!({
    "endTime" => @end_time,
    "eventFilter" => @event_filter,
    "frequency" => @frequency,
    "isLocalTime" => @is_local_time,
    "quietTime" => @quiet_time,
    "startTime" => @start_time,
    "timeZone" => @time_zone,
  })
  result.compact
end