Package software.amazon.awscdk.services.pinpoint

Class CfnCampaign.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnCampaign.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 CfnCampaign.Builder.

    • applicationId

      @Stability(Stable) public CfnCampaign.Builder applicationId(String applicationId)
      The unique identifier for the Amazon Pinpoint application that the campaign is associated with.

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

    • name

      @Stability(Stable) public CfnCampaign.Builder name(String name)
      The name of the campaign.

      Parameters:
      name - The name of the campaign. This parameter is required.
      Returns:
      this

    • schedule

      @Stability(Stable) public CfnCampaign.Builder schedule(IResolvable schedule)
      The schedule settings for the campaign.

      Parameters:
      schedule - The schedule settings for the campaign. This parameter is required.
      Returns:
      this

    • schedule

      @Stability(Stable) public CfnCampaign.Builder schedule(CfnCampaign.ScheduleProperty schedule)
      The schedule settings for the campaign.

      Parameters:
      schedule - The schedule settings for the campaign. This parameter is required.
      Returns:
      this

    • segmentId

      @Stability(Stable) public CfnCampaign.Builder segmentId(String segmentId)
      The unique identifier for the segment to associate with the campaign.

      Parameters:
      segmentId - The unique identifier for the segment to associate with the campaign. This parameter is required.
      Returns:
      this

    • additionalTreatments

      @Stability(Stable) public CfnCampaign.Builder additionalTreatments(IResolvable additionalTreatments)
      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

      Parameters:
      additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. This parameter is required.
      Returns:
      this

    • additionalTreatments

      @Stability(Stable) public CfnCampaign.Builder additionalTreatments(List<? extends Object> additionalTreatments)
      An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

      Parameters:
      additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. This parameter is required.
      Returns:
      this

    • campaignHook

      @Stability(Stable) public CfnCampaign.Builder campaignHook(IResolvable campaignHook)
      Specifies the Lambda function to use as a code hook for a campaign.

      Parameters:
      campaignHook - Specifies the Lambda function to use as a code hook for a campaign. This parameter is required.
      Returns:
      this

    • campaignHook

      @Stability(Stable) public CfnCampaign.Builder campaignHook(CfnCampaign.CampaignHookProperty campaignHook)
      Specifies the Lambda function to use as a code hook for a campaign.

      Parameters:
      campaignHook - Specifies the Lambda function to use as a code hook for a campaign. This parameter is required.
      Returns:
      this

    • customDeliveryConfiguration

      @Stability(Stable) public CfnCampaign.Builder customDeliveryConfiguration(IResolvable customDeliveryConfiguration)
      AWS::Pinpoint::Campaign.CustomDeliveryConfiguration.

      Parameters:
      customDeliveryConfiguration - AWS::Pinpoint::Campaign.CustomDeliveryConfiguration. This parameter is required.
      Returns:
      this

    • customDeliveryConfiguration

      @Stability(Stable) public CfnCampaign.Builder customDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty customDeliveryConfiguration)
      AWS::Pinpoint::Campaign.CustomDeliveryConfiguration.

      Parameters:
      customDeliveryConfiguration - AWS::Pinpoint::Campaign.CustomDeliveryConfiguration. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnCampaign.Builder description(String description)
      A custom description of the campaign.

      Parameters:
      description - A custom description of the campaign. This parameter is required.
      Returns:
      this

    • holdoutPercent

      @Stability(Stable) public CfnCampaign.Builder holdoutPercent(Number holdoutPercent)
      The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

      Parameters:
      holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. This parameter is required.
      Returns:
      this

    • isPaused

      @Stability(Stable) public CfnCampaign.Builder isPaused(Boolean isPaused)
      Specifies whether to pause the campaign.

      A paused campaign doesn't run unless you resume it by changing this value to false . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

      Parameters:
      isPaused - Specifies whether to pause the campaign. This parameter is required.
      Returns:
      this

    • isPaused

      @Stability(Stable) public CfnCampaign.Builder isPaused(IResolvable isPaused)
      Specifies whether to pause the campaign.

      A paused campaign doesn't run unless you resume it by changing this value to false . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

      Parameters:
      isPaused - Specifies whether to pause the campaign. This parameter is required.
      Returns:
      this

    • limits

      @Stability(Stable) public CfnCampaign.Builder limits(IResolvable limits)
      The messaging limits for the campaign.

      Parameters:
      limits - The messaging limits for the campaign. This parameter is required.
      Returns:
      this

    • limits

      @Stability(Stable) public CfnCampaign.Builder limits(CfnCampaign.LimitsProperty limits)
      The messaging limits for the campaign.

      Parameters:
      limits - The messaging limits for the campaign. This parameter is required.
      Returns:
      this

    • messageConfiguration

      @Stability(Stable) public CfnCampaign.Builder messageConfiguration(IResolvable messageConfiguration)
      The message configuration settings for the campaign.

      Parameters:
      messageConfiguration - The message configuration settings for the campaign. This parameter is required.
      Returns:
      this

    • messageConfiguration

      @Stability(Stable) public CfnCampaign.Builder messageConfiguration(CfnCampaign.MessageConfigurationProperty messageConfiguration)
      The message configuration settings for the campaign.

      Parameters:
      messageConfiguration - The message configuration settings for the campaign. This parameter is required.
      Returns:
      this

    • priority

      @Stability(Stable) public CfnCampaign.Builder priority(Number priority)
      An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.

      If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.

      Parameters:
      priority - An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest. This parameter is required.
      Returns:
      this

    • segmentVersion

      @Stability(Stable) public CfnCampaign.Builder segmentVersion(Number segmentVersion)
      The version of the segment to associate with the campaign.

      Parameters:
      segmentVersion - The version of the segment to associate with the campaign. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnCampaign.Builder tags(Object tags)
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

      Parameters:
      tags - An array of key-value pairs to apply to this resource. This parameter is required.
      Returns:
      this

    • templateConfiguration

      @Stability(Stable) public CfnCampaign.Builder templateConfiguration(IResolvable templateConfiguration)
      AWS::Pinpoint::Campaign.TemplateConfiguration.

      Parameters:
      templateConfiguration - AWS::Pinpoint::Campaign.TemplateConfiguration. This parameter is required.
      Returns:
      this

    • templateConfiguration

      @Stability(Stable) public CfnCampaign.Builder templateConfiguration(CfnCampaign.TemplateConfigurationProperty templateConfiguration)
      AWS::Pinpoint::Campaign.TemplateConfiguration.

      Parameters:
      templateConfiguration - AWS::Pinpoint::Campaign.TemplateConfiguration. This parameter is required.
      Returns:
      this

    • treatmentDescription

      @Stability(Stable) public CfnCampaign.Builder treatmentDescription(String treatmentDescription)
      A custom description of the default treatment for the campaign.

      Parameters:
      treatmentDescription - A custom description of the default treatment for the campaign. This parameter is required.
      Returns:
      this

    • treatmentName

      @Stability(Stable) public CfnCampaign.Builder treatmentName(String treatmentName)
      A custom name of the default treatment for the campaign, if the campaign has multiple treatments.

      A treatment is a variation of a campaign that's used for A/B testing.

      Parameters:
      treatmentName - A custom name of the default treatment for the campaign, if the campaign has multiple treatments. This parameter is required.
      Returns:
      this

    • build

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