Interface CfnCampaign.ScheduleProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnCampaign.ScheduleProperty extends
Specifies the schedule settings for a campaign.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object attributes;
 Object metrics;
 ScheduleProperty scheduleProperty = ScheduleProperty.builder()
  • Method Details

    • getEndTime

      @Stability(Stable) @Nullable default String getEndTime()
      The scheduled time, in ISO 8601 format, when the campaign ended or will end.
    • getEventFilter

      @Stability(Stable) @Nullable default Object getEventFilter()
      The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT .
    • getFrequency

      @Stability(Stable) @Nullable default String getFrequency()
      Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
    • getIsLocalTime

      @Stability(Stable) @Nullable default Object getIsLocalTime()
      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 .

    • getQuietTime

      @Stability(Stable) @Nullable default Object getQuietTime()
      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.

    • getStartTime

      @Stability(Stable) @Nullable default String getStartTime()
      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.

    • getTimeZone

      @Stability(Stable) @Nullable default String getTimeZone()
      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 .

    • builder

      @Stability(Stable) static CfnCampaign.ScheduleProperty.Builder builder()
      a CfnCampaign.ScheduleProperty.Builder of CfnCampaign.ScheduleProperty