Interface CfnCampaignPropsMixin.IScheduleProperty

Specifies the schedule settings for a campaign.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Pinpoint.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnCampaignPropsMixin.IScheduleProperty

Syntax (vb)

Public Interface CfnCampaignPropsMixin.IScheduleProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Pinpoint.Mixins;

             var attributes;
             var metrics;

             var scheduleProperty = new ScheduleProperty {
                 EndTime = "endTime",
                 EventFilter = new CampaignEventFilterProperty {
                     Dimensions = new EventDimensionsProperty {
                         Attributes = attributes,
                         EventType = new SetDimensionProperty {
                             DimensionType = "dimensionType",
                             Values = new [] { "values" }
                         },
                         Metrics = metrics
                     },
                     FilterType = "filterType"
                 },
                 Frequency = "frequency",
                 IsLocalTime = false,
                 QuietTime = new QuietTimeProperty {
                     End = "end",
                     Start = "start"
                 },
                 StartTime = "startTime",
                 TimeZone = "timeZone"
             };

Synopsis

Properties

EndTime	The scheduled time, in ISO 8601 format, when the campaign ended or will end.
EventFilter	The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT .
Frequency	Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
IsLocalTime	Specifies whether the start and end times for the campaign schedule use each recipient's local time.
QuietTime	The default quiet time for the campaign.
StartTime	The scheduled time when the campaign began or will begin.
TimeZone	The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true .

Properties

EndTime

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

string? EndTime { get; }

Property Value

string

Remarks

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

EventFilter

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

object? EventFilter { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnCampaignPropsMixin.ICampaignEventFilterProperty

Frequency

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

string? Frequency { get; }

Property Value

string

Remarks

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

IsLocalTime

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

object? IsLocalTime { get; }

Property Value

object

Remarks

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

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

Type union: either bool or IResolvable

QuietTime

The default quiet time for the campaign.

object? QuietTime { get; }

Property Value

object

Remarks

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

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

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

Type union: either IResolvable or CfnCampaignPropsMixin.IQuietTimeProperty

StartTime

The scheduled time when the campaign began or will begin.

string? StartTime { get; }

Property Value

string

Remarks

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

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

TimeZone

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

string? TimeZone { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-timezone