AWS CloudFormation
User Guide (Version )

AWS::Pinpoint::ApplicationSettings

Specifies the settings for an Amazon Pinpoint application. In Amazon Pinpoint, an application (also referred to as an app or project) is a collection of related settings, customer information, segments, and campaigns, and other types of Amazon Pinpoint resources.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Pinpoint::ApplicationSettings", "Properties" : { "ApplicationId" : String, "CampaignHook" : CampaignHook, "CloudWatchMetricsEnabled" : Boolean, "Limits" : Limits, "QuietTime" : QuietTime } }

YAML

Type: AWS::Pinpoint::ApplicationSettings Properties: ApplicationId: String CampaignHook: CampaignHook CloudWatchMetricsEnabled: Boolean Limits: Limits QuietTime: QuietTime

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application.

Required: Yes

Type: String

Update requires: Replacement

CampaignHook

The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.

Required: No

Type: CampaignHook

Update requires: No interruption

CloudWatchMetricsEnabled

Specifies whether to enable application-related alarms in Amazon CloudWatch.

Required: No

Type: Boolean

Update requires: No interruption

Limits

The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.

Required: No

Type: Limits

Update requires: No interruption

QuietTime

The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don'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 application (or a campaign that has custom quiet time settings).

- 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 application (or a campaign that has custom quiet time settings).

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

To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.

Required: No

Type: QuietTime

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier (ApplicationId) for the Amazon Pinpoint application that you're specifying the settings for.

For more information about using the Ref function, see Ref.