Package software.amazon.awscdk.services.pinpoint

Class CfnApplicationSettings.Builder

java.lang.Object
software.amazon.awscdk.services.pinpoint.CfnApplicationSettings.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApplicationSettings>
Enclosing class:
CfnApplicationSettings
@Stability(Stable) public static final class CfnApplicationSettings.Builder extends Object implements software.amazon.jsii.Builder<CfnApplicationSettings>
A fluent builder for CfnApplicationSettings.

  • Method Details

    • create

      @Stability(Stable) public static CfnApplicationSettings.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnApplicationSettings.Builder.

    • applicationId

      @Stability(Stable) public CfnApplicationSettings.Builder applicationId(String applicationId)
      The unique identifier for the Amazon Pinpoint application.

      Parameters:
      applicationId - The unique identifier for the Amazon Pinpoint application. This parameter is required.
      Returns:
      this

    • campaignHook

      @Stability(Stable) public CfnApplicationSettings.Builder campaignHook(IResolvable 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.

      Parameters:
      campaignHook - The settings for the Lambda function to use by default as a code hook for campaigns in the application. This parameter is required.
      Returns:
      this

    • campaignHook

      @Stability(Stable) public CfnApplicationSettings.Builder campaignHook(CfnApplicationSettings.CampaignHookProperty 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.

      Parameters:
      campaignHook - The settings for the Lambda function to use by default as a code hook for campaigns in the application. This parameter is required.
      Returns:
      this

    • cloudWatchMetricsEnabled

      @Stability(Stable) public CfnApplicationSettings.Builder cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
      Specifies whether to enable application-related alarms in Amazon CloudWatch.

      Parameters:
      cloudWatchMetricsEnabled - Specifies whether to enable application-related alarms in Amazon CloudWatch. This parameter is required.
      Returns:
      this

    • cloudWatchMetricsEnabled

      @Stability(Stable) public CfnApplicationSettings.Builder cloudWatchMetricsEnabled(IResolvable cloudWatchMetricsEnabled)
      Specifies whether to enable application-related alarms in Amazon CloudWatch.

      Parameters:
      cloudWatchMetricsEnabled - Specifies whether to enable application-related alarms in Amazon CloudWatch. This parameter is required.
      Returns:
      this

    • limits

      @Stability(Stable) public CfnApplicationSettings.Builder limits(IResolvable 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.

      Parameters:
      limits - The default sending limits for campaigns in the application. This parameter is required.
      Returns:
      this

    • limits

      @Stability(Stable) public CfnApplicationSettings.Builder limits(CfnApplicationSettings.LimitsProperty 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.

      Parameters:
      limits - The default sending limits for campaigns in the application. This parameter is required.
      Returns:
      this

    • quietTime

      @Stability(Stable) public CfnApplicationSettings.Builder quietTime(IResolvable 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.

      Parameters:
      quietTime - The default quiet time for campaigns in the application. This parameter is required.
      Returns:
      this

    • quietTime

      @Stability(Stable) public CfnApplicationSettings.Builder quietTime(CfnApplicationSettings.QuietTimeProperty 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.

      Parameters:
      quietTime - The default quiet time for campaigns in the application. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnApplicationSettings build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnApplicationSettings>
      Returns:
      a newly built instance of CfnApplicationSettings.