Package software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.LimitsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.LimitsProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(Stable)
public static interface CfnCampaign.LimitsProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the limits on the messages that a campaign can send.

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.*;
 LimitsProperty limitsProperty = LimitsProperty.builder()
         .daily(123)
         .maximumDuration(123)
         .messagesPerSecond(123)
         .session(123)
         .total(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCampaign.LimitsProperty.Builder	builder()
default Number	getDaily()	The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
default Number	getMaximumDuration()	The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
default Number	getMessagesPerSecond()	The maximum number of messages that a campaign can send each second.
default Number	getSession()	The maximum number of messages that the campaign can send per user session.
default Number	getTotal()	The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDaily

@Stability(Stable)
@Nullable
default Number getDaily()

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.

The maximum value is 100.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-daily

getMaximumDuration

@Stability(Stable)
@Nullable
default Number getMaximumDuration()

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.

The minimum value is 60 seconds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-maximumduration

getMessagesPerSecond

@Stability(Stable)
@Nullable
default Number getMessagesPerSecond()

The maximum number of messages that a campaign can send each second.

The minimum value is 1. The maximum value is 20,000.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-messagespersecond

getSession

@Stability(Stable)
@Nullable
default Number getSession()

The maximum number of messages that the campaign can send per user session.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-session

getTotal

@Stability(Stable)
@Nullable
default Number getTotal()

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.

The maximum value is 100.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-total

builder

@Stability(Stable)
static CfnCampaign.LimitsProperty.Builder builder()

Returns:

a CfnCampaign.LimitsProperty.Builder of CfnCampaign.LimitsProperty