public static final class CfnCampaign.ScheduleProperty.Builder
extends java.lang.Object
CfnCampaign.ScheduleProperty
Constructor and Description |
---|
Builder() |
public CfnCampaign.ScheduleProperty.Builder endTime(java.lang.String endTime)
CfnCampaign.ScheduleProperty.getEndTime()
endTime
- The scheduled time, in ISO 8601 format, when the campaign ended or will end.this
public CfnCampaign.ScheduleProperty.Builder eventFilter(IResolvable eventFilter)
CfnCampaign.ScheduleProperty.getEventFilter()
eventFilter
- The type of event that causes the campaign to be sent, if the value of the `Frequency` property is `EVENT` .this
public CfnCampaign.ScheduleProperty.Builder eventFilter(CfnCampaign.CampaignEventFilterProperty eventFilter)
CfnCampaign.ScheduleProperty.getEventFilter()
eventFilter
- The type of event that causes the campaign to be sent, if the value of the `Frequency` property is `EVENT` .this
public CfnCampaign.ScheduleProperty.Builder frequency(java.lang.String frequency)
CfnCampaign.ScheduleProperty.getFrequency()
frequency
- Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.this
public CfnCampaign.ScheduleProperty.Builder isLocalTime(java.lang.Boolean isLocalTime)
CfnCampaign.ScheduleProperty.getIsLocalTime()
isLocalTime
- 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
.this
public CfnCampaign.ScheduleProperty.Builder isLocalTime(IResolvable isLocalTime)
CfnCampaign.ScheduleProperty.getIsLocalTime()
isLocalTime
- 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
.this
public CfnCampaign.ScheduleProperty.Builder quietTime(IResolvable quietTime)
CfnCampaign.ScheduleProperty.getQuietTime()
quietTime
- 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:
EndpointDemographic.Timezone
property of the endpoint is set to a valid value.QuietTime.Start
property for the campaign.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.
this
public CfnCampaign.ScheduleProperty.Builder quietTime(CfnCampaign.QuietTimeProperty quietTime)
CfnCampaign.ScheduleProperty.getQuietTime()
quietTime
- 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:
EndpointDemographic.Timezone
property of the endpoint is set to a valid value.QuietTime.Start
property for the campaign.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.
this
public CfnCampaign.ScheduleProperty.Builder startTime(java.lang.String startTime)
CfnCampaign.ScheduleProperty.getStartTime()
startTime
- 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.this
public CfnCampaign.ScheduleProperty.Builder timeZone(java.lang.String timeZone)
CfnCampaign.ScheduleProperty.getTimeZone()
timeZone
- 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
.this
public CfnCampaign.ScheduleProperty build()
CfnCampaign.ScheduleProperty
java.lang.NullPointerException
- if any required attribute was not provided