software.amazon.awscdk.services.pinpoint

Interface CfnApplicationSettingsProps

All Known Implementing Classes:

CfnApplicationSettingsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.156Z")
public interface 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 software.amazon.awscdk.services.pinpoint.*;
 CfnApplicationSettingsProps cfnApplicationSettingsProps = CfnApplicationSettingsProps.builder()
         .applicationId("applicationId")
         // the properties below are optional
         .campaignHook(CampaignHookProperty.builder()
                 .lambdaFunctionName("lambdaFunctionName")
                 .mode("mode")
                 .webUrl("webUrl")
                 .build())
         .cloudWatchMetricsEnabled(false)
         .limits(LimitsProperty.builder()
                 .daily(123)
                 .maximumDuration(123)
                 .messagesPerSecond(123)
                 .total(123)
                 .build())
         .quietTime(QuietTimeProperty.builder()
                 .end("end")
                 .start("start")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnApplicationSettingsProps.Builder A builder for CfnApplicationSettingsProps
static class	CfnApplicationSettingsProps.Jsii$Proxy An implementation for CfnApplicationSettingsProps

Method Summary

Modifier and Type	Method and Description
static CfnApplicationSettingsProps.Builder	builder()
java.lang.String	getApplicationId() The unique identifier for the Amazon Pinpoint application.
default java.lang.Object	getCampaignHook() The settings for the Lambda function to use by default as a code hook for campaigns in the application.
default java.lang.Object	getCloudWatchMetricsEnabled() Specifies whether to enable application-related alarms in Amazon CloudWatch.
default java.lang.Object	getLimits() The default sending limits for campaigns in the application.
default java.lang.Object	getQuietTime() The default quiet time for campaigns in the application.

Method Detail

getApplicationId

java.lang.String getApplicationId()

The unique identifier for the Amazon Pinpoint application.

getCampaignHook

default java.lang.Object getCampaignHook()

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.

getCloudWatchMetricsEnabled

default java.lang.Object getCloudWatchMetricsEnabled()

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

getLimits

default java.lang.Object getLimits()

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.

getQuietTime

default java.lang.Object getQuietTime()

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.

builder

static CfnApplicationSettingsProps.Builder builder()

Returns:

a CfnApplicationSettingsProps.Builder of CfnApplicationSettingsProps