Class CfnApplicationSettingsProps.Builder
java.lang.Object
software.amazon.awscdk.services.pinpoint.CfnApplicationSettingsProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApplicationSettingsProps>
- Enclosing interface:
CfnApplicationSettingsProps
@Stability(Stable)
public static final class CfnApplicationSettingsProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApplicationSettingsProps>
A builder for
CfnApplicationSettingsProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) Sets the value ofCfnApplicationSettingsProps.getApplicationId()
build()
Builds the configured instance.campaignHook
(IResolvable campaignHook) Sets the value ofCfnApplicationSettingsProps.getCampaignHook()
campaignHook
(CfnApplicationSettings.CampaignHookProperty campaignHook) Sets the value ofCfnApplicationSettingsProps.getCampaignHook()
cloudWatchMetricsEnabled
(Boolean cloudWatchMetricsEnabled) Sets the value ofCfnApplicationSettingsProps.getCloudWatchMetricsEnabled()
cloudWatchMetricsEnabled
(IResolvable cloudWatchMetricsEnabled) Sets the value ofCfnApplicationSettingsProps.getCloudWatchMetricsEnabled()
limits
(IResolvable limits) Sets the value ofCfnApplicationSettingsProps.getLimits()
Sets the value ofCfnApplicationSettingsProps.getLimits()
quietTime
(IResolvable quietTime) Sets the value ofCfnApplicationSettingsProps.getQuietTime()
Sets the value ofCfnApplicationSettingsProps.getQuietTime()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
applicationId
Sets the value ofCfnApplicationSettingsProps.getApplicationId()
- Parameters:
applicationId
- The unique identifier for the Amazon Pinpoint application. This parameter is required.- Returns:
this
-
campaignHook
@Stability(Stable) public CfnApplicationSettingsProps.Builder campaignHook(IResolvable campaignHook) Sets the value ofCfnApplicationSettingsProps.getCampaignHook()
- Parameters:
campaignHook
- 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.- Returns:
this
-
campaignHook
@Stability(Stable) public CfnApplicationSettingsProps.Builder campaignHook(CfnApplicationSettings.CampaignHookProperty campaignHook) Sets the value ofCfnApplicationSettingsProps.getCampaignHook()
- Parameters:
campaignHook
- 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.- Returns:
this
-
cloudWatchMetricsEnabled
@Stability(Stable) public CfnApplicationSettingsProps.Builder cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled) Sets the value ofCfnApplicationSettingsProps.getCloudWatchMetricsEnabled()
- Parameters:
cloudWatchMetricsEnabled
- the value to be set.- Returns:
this
-
cloudWatchMetricsEnabled
@Stability(Stable) public CfnApplicationSettingsProps.Builder cloudWatchMetricsEnabled(IResolvable cloudWatchMetricsEnabled) Sets the value ofCfnApplicationSettingsProps.getCloudWatchMetricsEnabled()
- Parameters:
cloudWatchMetricsEnabled
- the value to be set.- Returns:
this
-
limits
Sets the value ofCfnApplicationSettingsProps.getLimits()
- Parameters:
limits
- 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.- Returns:
this
-
limits
@Stability(Stable) public CfnApplicationSettingsProps.Builder limits(CfnApplicationSettings.LimitsProperty limits) Sets the value ofCfnApplicationSettingsProps.getLimits()
- Parameters:
limits
- 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.- Returns:
this
-
quietTime
Sets the value ofCfnApplicationSettingsProps.getQuietTime()
- Parameters:
quietTime
- 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.
- The
- Returns:
this
-
quietTime
@Stability(Stable) public CfnApplicationSettingsProps.Builder quietTime(CfnApplicationSettings.QuietTimeProperty quietTime) Sets the value ofCfnApplicationSettingsProps.getQuietTime()
- Parameters:
quietTime
- 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.
- The
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnApplicationSettingsProps>
- Returns:
- a new instance of
CfnApplicationSettingsProps
- Throws:
NullPointerException
- if any required attribute was not provided
-