Package software.amazon.awscdk.services.pinpoint

Interface CfnApplicationSettingsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationSettingsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:20.280Z")
@Stability(Stable)
public interface CfnApplicationSettingsProps
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

The unique identifier for the Amazon Pinpoint application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-applicationid

getCampaignHook

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-campaignhook

getCloudWatchMetricsEnabled

@Stability(Stable)
@Nullable
default Object getCloudWatchMetricsEnabled()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-cloudwatchmetricsenabled

getLimits

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-limits

getQuietTime

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-quiettime

builder

@Stability(Stable)
static CfnApplicationSettingsProps.Builder builder()

Returns:

a CfnApplicationSettingsProps.Builder of CfnApplicationSettingsProps