Add-VSPinpointCampaignSchedule

Add-VSPinpointCampaignSchedule

SYNOPSIS

Adds an AWS::Pinpoint::Campaign.Schedule resource property to the template. Specifies the schedule settings for a campaign.

SYNTAX

Add-VSPinpointCampaignSchedule [[-TimeZone] <Object>] [[-QuietTime] <Object>] [[-EndTime] <Object>]
 [[-StartTime] <Object>] [[-Frequency] <Object>] [[-EventFilter] <Object>] [[-IsLocalTime] <Boolean>]
 [<CommonParameters>]

DESCRIPTION

Adds an AWS::Pinpoint::Campaign.Schedule resource property to the template. Specifies the schedule settings for a campaign.

EXAMPLES

Example 1

PS C:\> 

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.

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-timezone PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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.

Type: QuietTime Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-quiettime UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EndTime

The scheduled time, in ISO 8601 format, for the campaign to end.

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-endtime PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StartTime

The scheduled time, in ISO 8601 format, for the campaign to begin.

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-starttime PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Frequency

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

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-frequency PrimitiveType: String UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EventFilter

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

Type: CampaignEventFilter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-eventfilter UpdateType: Mutable

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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.

Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-islocaltime PrimitiveType: Boolean UpdateType: Mutable

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Vaporshell.Resource.Pinpoint.Campaign.Schedule

NOTES

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