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 Summary

Modifier and Type	Method	Description
CfnApplicationSettings.Builder	applicationId(String applicationId)	The unique identifier for the Amazon Pinpoint application.
CfnApplicationSettings	build()
CfnApplicationSettings.Builder	campaignHook(IResolvable campaignHook)	The settings for the Lambda function to use by default as a code hook for campaigns in the application.
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.
CfnApplicationSettings.Builder	cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
CfnApplicationSettings.Builder	cloudWatchMetricsEnabled(IResolvable cloudWatchMetricsEnabled)
static CfnApplicationSettings.Builder	create(software.constructs.Construct scope, String id)
CfnApplicationSettings.Builder	limits(IResolvable limits)	The default sending limits for campaigns in the application.
CfnApplicationSettings.Builder	limits(CfnApplicationSettings.LimitsProperty limits)	The default sending limits for campaigns in the application.
CfnApplicationSettings.Builder	quietTime(IResolvable quietTime)	The default quiet time for campaigns in the application.
CfnApplicationSettings.Builder	quietTime(CfnApplicationSettings.QuietTimeProperty quietTime)	The default quiet time for campaigns in the application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnApplicationSettings.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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

See Also:

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

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

See Also:

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

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

See Also:

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

cloudWatchMetricsEnabled

@Stability(Stable)
public CfnApplicationSettings.Builder cloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)

Parameters:

cloudWatchMetricsEnabled - This parameter is required.

Returns:

this

See Also:

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

cloudWatchMetricsEnabled

@Stability(Stable)
public CfnApplicationSettings.Builder cloudWatchMetricsEnabled(IResolvable cloudWatchMetricsEnabled)

Parameters:

cloudWatchMetricsEnabled - This parameter is required.

Returns:

this

See Also:

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

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

See Also:

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

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

See Also:

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

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

See Also:

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

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

See Also:

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

build

@Stability(Stable)
public CfnApplicationSettings build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnApplicationSettings>

Returns:

a newly built instance of CfnApplicationSettings.