software.amazon.awscdk.services.pinpoint

Class CfnCampaign.ScheduleProperty.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnCampaign.ScheduleProperty.Builder

Enclosing interface:

CfnCampaign.ScheduleProperty

public static final class CfnCampaign.ScheduleProperty.Builder
extends java.lang.Object

A builder for CfnCampaign.ScheduleProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnCampaign.ScheduleProperty	build() Builds the configured instance.
CfnCampaign.ScheduleProperty.Builder	endTime(java.lang.String endTime) Sets the value of CfnCampaign.ScheduleProperty.getEndTime()
CfnCampaign.ScheduleProperty.Builder	eventFilter(CfnCampaign.CampaignEventFilterProperty eventFilter) Sets the value of CfnCampaign.ScheduleProperty.getEventFilter()
CfnCampaign.ScheduleProperty.Builder	eventFilter(IResolvable eventFilter) Sets the value of CfnCampaign.ScheduleProperty.getEventFilter()
CfnCampaign.ScheduleProperty.Builder	frequency(java.lang.String frequency) Sets the value of CfnCampaign.ScheduleProperty.getFrequency()
CfnCampaign.ScheduleProperty.Builder	isLocalTime(java.lang.Boolean isLocalTime) Sets the value of CfnCampaign.ScheduleProperty.getIsLocalTime()
CfnCampaign.ScheduleProperty.Builder	isLocalTime(IResolvable isLocalTime) Sets the value of CfnCampaign.ScheduleProperty.getIsLocalTime()
CfnCampaign.ScheduleProperty.Builder	quietTime(CfnCampaign.QuietTimeProperty quietTime) Sets the value of CfnCampaign.ScheduleProperty.getQuietTime()
CfnCampaign.ScheduleProperty.Builder	quietTime(IResolvable quietTime) Sets the value of CfnCampaign.ScheduleProperty.getQuietTime()
CfnCampaign.ScheduleProperty.Builder	startTime(java.lang.String startTime) Sets the value of CfnCampaign.ScheduleProperty.getStartTime()
CfnCampaign.ScheduleProperty.Builder	timeZone(java.lang.String timeZone) Sets the value of CfnCampaign.ScheduleProperty.getTimeZone()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

endTime

public CfnCampaign.ScheduleProperty.Builder endTime(java.lang.String endTime)

Sets the value of CfnCampaign.ScheduleProperty.getEndTime()

Parameters:

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

Returns:

this

eventFilter

public CfnCampaign.ScheduleProperty.Builder eventFilter(IResolvable eventFilter)

Sets the value of CfnCampaign.ScheduleProperty.getEventFilter()

Parameters:

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

Returns:

this

eventFilter

public CfnCampaign.ScheduleProperty.Builder eventFilter(CfnCampaign.CampaignEventFilterProperty eventFilter)

Sets the value of CfnCampaign.ScheduleProperty.getEventFilter()

Parameters:

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

Returns:

this

frequency

public CfnCampaign.ScheduleProperty.Builder frequency(java.lang.String frequency)

Sets the value of CfnCampaign.ScheduleProperty.getFrequency()

Parameters:

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

Returns:

this

isLocalTime

public CfnCampaign.ScheduleProperty.Builder isLocalTime(java.lang.Boolean isLocalTime)

Sets the value of CfnCampaign.ScheduleProperty.getIsLocalTime()

Parameters:

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 .

Returns:

this

isLocalTime

public CfnCampaign.ScheduleProperty.Builder isLocalTime(IResolvable isLocalTime)

Sets the value of CfnCampaign.ScheduleProperty.getIsLocalTime()

Parameters:

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 .

Returns:

this

quietTime

public CfnCampaign.ScheduleProperty.Builder quietTime(IResolvable quietTime)

Sets the value of CfnCampaign.ScheduleProperty.getQuietTime()

Parameters:

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:

• 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:

this

quietTime

public CfnCampaign.ScheduleProperty.Builder quietTime(CfnCampaign.QuietTimeProperty quietTime)

Sets the value of CfnCampaign.ScheduleProperty.getQuietTime()

Parameters:

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:

• 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:

this

startTime

public CfnCampaign.ScheduleProperty.Builder startTime(java.lang.String startTime)

Sets the value of CfnCampaign.ScheduleProperty.getStartTime()

Parameters:

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.

Returns:

this

timeZone

public CfnCampaign.ScheduleProperty.Builder timeZone(java.lang.String timeZone)

Sets the value of CfnCampaign.ScheduleProperty.getTimeZone()

Parameters:

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 .

Returns:

this

build

public CfnCampaign.ScheduleProperty build()

Builds the configured instance.

Returns:

a new instance of CfnCampaign.ScheduleProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided