1.204.0

interface CfnApplicationSettingsProps

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnApplicationSettingsProps
Javasoftware.amazon.awscdk.services.pinpoint.CfnApplicationSettingsProps
Pythonaws_cdk.aws_pinpoint.CfnApplicationSettingsProps
TypeScript @aws-cdk/aws-pinpoint » CfnApplicationSettingsProps

Properties for defining a CfnApplicationSettings.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pinpoint from '@aws-cdk/aws-pinpoint';
const cfnApplicationSettingsProps: pinpoint.CfnApplicationSettingsProps = {
  applicationId: 'applicationId',

  // the properties below are optional
  campaignHook: {
    lambdaFunctionName: 'lambdaFunctionName',
    mode: 'mode',
    webUrl: 'webUrl',
  },
  cloudWatchMetricsEnabled: false,
  limits: {
    daily: 123,
    maximumDuration: 123,
    messagesPerSecond: 123,
    total: 123,
  },
  quietTime: {
    end: 'end',
    start: 'start',
  },
};

Properties

NameTypeDescription
applicationIdstringThe unique identifier for the Amazon Pinpoint application.
campaignHook?IResolvable | CampaignHookPropertyThe settings for the Lambda function to use by default as a code hook for campaigns in the application.
cloudWatchMetricsEnabled?boolean | IResolvableSpecifies whether to enable application-related alarms in Amazon CloudWatch.
limits?IResolvable | LimitsPropertyThe default sending limits for campaigns in the application.
quietTime?IResolvable | QuietTimePropertyThe default quiet time for campaigns in the application.

applicationId

Type: string

The unique identifier for the Amazon Pinpoint application.

campaignHook?

Type: IResolvable | CampaignHookProperty (optional)

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.

cloudWatchMetricsEnabled?

Type: boolean | IResolvable (optional)

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

limits?

Type: IResolvable | LimitsProperty (optional)

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.

quietTime?

Type: IResolvable | QuietTimeProperty (optional)

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.

← PreviousNext →