AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::ApplicationSettings

CfnApplicationSettings

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.

Import

import { CfnApplicationSettings } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnApplicationSettings

Properties

Configuration passed to the constructor as CfnApplicationSettingsProps.

applicationIdRequired
string

The unique identifier for the Amazon Pinpoint application.

campaignHookOptional
IResolvable | CampaignHookProperty

The settings for the 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.

cloudWatchMetricsEnabledOptional
boolean | IResolvable
limitsOptional
IResolvable | LimitsProperty

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.

quietTimeOptional
IResolvable | QuietTimeProperty

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter