Package software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.ScheduleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.ScheduleProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(Stable)
public static interface CfnCampaign.ScheduleProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the schedule settings for a campaign.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 Object attributes;
 Object metrics;
 ScheduleProperty scheduleProperty = ScheduleProperty.builder()
         .endTime("endTime")
         .eventFilter(CampaignEventFilterProperty.builder()
                 .dimensions(EventDimensionsProperty.builder()
                         .attributes(attributes)
                         .eventType(SetDimensionProperty.builder()
                                 .dimensionType("dimensionType")
                                 .values(List.of("values"))
                                 .build())
                         .metrics(metrics)
                         .build())
                 .filterType("filterType")
                 .build())
         .frequency("frequency")
         .isLocalTime(false)
         .quietTime(QuietTimeProperty.builder()
                 .end("end")
                 .start("start")
                 .build())
         .startTime("startTime")
         .timeZone("timeZone")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCampaign.ScheduleProperty.Builder	A builder for CfnCampaign.ScheduleProperty
static final class	CfnCampaign.ScheduleProperty.Jsii$Proxy	An implementation for CfnCampaign.ScheduleProperty

Method Summary

Modifier and Type	Method	Description
static CfnCampaign.ScheduleProperty.Builder	builder()
default String	getEndTime()	The scheduled time, in ISO 8601 format, when the campaign ended or will end.
default Object	getEventFilter()	The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT .
default String	getFrequency()	Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
default Object	getIsLocalTime()	Specifies whether the start and end times for the campaign schedule use each recipient's local time.
default Object	getQuietTime()	The default quiet time for the campaign.
default String	getStartTime()	The scheduled time when the campaign began or will begin.
default String	getTimeZone()	The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndTime

@Stability(Stable)
@Nullable
default String getEndTime()

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

See Also:

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

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 .

Returns union: either IResolvable or CfnCampaign.CampaignEventFilterProperty

See Also:

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

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.

See Also:

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

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 .

Returns union: either Boolean or IResolvable

See Also:

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

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.

Returns union: either IResolvable or CfnCampaign.QuietTimeProperty

See Also:

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

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.

See Also:

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

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 .

See Also:

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

builder

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

Returns:

a CfnCampaign.ScheduleProperty.Builder of CfnCampaign.ScheduleProperty