interface ScheduleProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pinpoint.CfnCampaign.ScheduleProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnCampaign_ScheduleProperty |
![]() | software.amazon.awscdk.services.pinpoint.CfnCampaign.ScheduleProperty |
![]() | aws_cdk.aws_pinpoint.CfnCampaign.ScheduleProperty |
![]() | aws-cdk-lib » aws_pinpoint » CfnCampaign » ScheduleProperty |
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 { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
declare const attributes: any;
declare const metrics: any;
const scheduleProperty: pinpoint.CfnCampaign.ScheduleProperty = {
endTime: 'endTime',
eventFilter: {
dimensions: {
attributes: attributes,
eventType: {
dimensionType: 'dimensionType',
values: ['values'],
},
metrics: metrics,
},
filterType: 'filterType',
},
frequency: 'frequency',
isLocalTime: false,
quietTime: {
end: 'end',
start: 'start',
},
startTime: 'startTime',
timeZone: 'timeZone',
};
Properties
Name | Type | Description |
---|---|---|
end | string | The scheduled time, in ISO 8601 format, when the campaign ended or will end. |
event | IResolvable | Campaign | The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT . |
frequency? | string | Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. |
is | boolean | IResolvable | Specifies whether the start and end times for the campaign schedule use each recipient's local time. |
quiet | IResolvable | Quiet | The default quiet time for the campaign. |
start | string | The scheduled time when the campaign began or will begin. |
time | string | The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true . |
endTime?
Type:
string
(optional)
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
eventFilter?
Type:
IResolvable
|
Campaign
(optional)
The type of event that causes the campaign to be sent, if the value of the Frequency
property is EVENT
.
frequency?
Type:
string
(optional)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
isLocalTime?
Type:
boolean |
IResolvable
(optional)
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
.
quietTime?
Type:
IResolvable
|
Quiet
(optional)
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.
startTime?
Type:
string
(optional)
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.
timeZone?
Type:
string
(optional)
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
.