interface CfnApplicationSettingsProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pinpoint.CfnApplicationSettingsProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnApplicationSettingsProps |
![]() | software.amazon.awscdk.services.pinpoint.CfnApplicationSettingsProps |
![]() | aws_cdk.aws_pinpoint.CfnApplicationSettingsProps |
![]() | aws-cdk-lib » 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 { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
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
Name | Type | Description |
---|---|---|
application | string | The unique identifier for the Amazon Pinpoint application. |
campaign | IResolvable | Campaign | The settings for the Lambda function to use by default as a code hook for campaigns in the application. |
cloud | boolean | IResolvable | |
limits? | IResolvable | Limits | The default sending limits for campaigns in the application. |
quiet | IResolvable | Quiet | The default quiet time for campaigns in the application. |
applicationId
Type:
string
The unique identifier for the Amazon Pinpoint application.
campaignHook?
Type:
IResolvable
|
Campaign
(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)
limits?
Type:
IResolvable
|
Limits
(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
|
Quiet
(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.