software.amazon.awscdk.services.pinpoint

Class CfnApplicationSettings

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnApplicationSettings

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.196Z")
 @Stability(value=Stable)
public class CfnApplicationSettings
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::ApplicationSettings`.

Specifies the settings for an Amazon Pinpoint application. In Amazon Pinpoint, an application (also referred to as an app or project ) is a collection of related settings, customer information, segments, and campaigns, and other types of Amazon Pinpoint resources.

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.*;
 CfnApplicationSettings cfnApplicationSettings = CfnApplicationSettings.Builder.create(this, "MyCfnApplicationSettings")
         .applicationId("applicationId")
         // the properties below are optional
         .campaignHook(CampaignHookProperty.builder()
                 .lambdaFunctionName("lambdaFunctionName")
                 .mode("mode")
                 .webUrl("webUrl")
                 .build())
         .cloudWatchMetricsEnabled(false)
         .limits(LimitsProperty.builder()
                 .daily(123)
                 .maximumDuration(123)
                 .messagesPerSecond(123)
                 .total(123)
                 .build())
         .quietTime(QuietTimeProperty.builder()
                 .end("end")
                 .start("start")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApplicationSettings.Builder A fluent builder for CfnApplicationSettings.
static interface	CfnApplicationSettings.CampaignHookProperty Specifies the Lambda function to use by default as a code hook for campaigns in the application.
static interface	CfnApplicationSettings.LimitsProperty Specifies the default sending limits for campaigns in the application.
static interface	CfnApplicationSettings.QuietTimeProperty Specifies the start and end times that define a time range when messages aren't sent to endpoints.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplicationSettings(software.constructs.Construct scope, String id, CfnApplicationSettingsProps props) Create a new `AWS::Pinpoint::ApplicationSettings`.
protected	CfnApplicationSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplicationSettings(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() The unique identifier for the Amazon Pinpoint application.
Object	getCampaignHook() The settings for the Lambda function to use by default as a code hook for campaigns in the application.
protected Map<String,Object>	getCfnProperties()
Object	getCloudWatchMetricsEnabled() Specifies whether to enable application-related alarms in Amazon CloudWatch.
Object	getLimits() The default sending limits for campaigns in the application.
Object	getQuietTime() The default quiet time for campaigns in the application.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) The unique identifier for the Amazon Pinpoint application.
void	setCampaignHook(CfnApplicationSettings.CampaignHookProperty value) The settings for the Lambda function to use by default as a code hook for campaigns in the application.
void	setCampaignHook(IResolvable value) The settings for the Lambda function to use by default as a code hook for campaigns in the application.
void	setCloudWatchMetricsEnabled(Boolean value) Specifies whether to enable application-related alarms in Amazon CloudWatch.
void	setCloudWatchMetricsEnabled(IResolvable value) Specifies whether to enable application-related alarms in Amazon CloudWatch.
void	setLimits(CfnApplicationSettings.LimitsProperty value) The default sending limits for campaigns in the application.
void	setLimits(IResolvable value) The default sending limits for campaigns in the application.
void	setQuietTime(CfnApplicationSettings.QuietTimeProperty value) The default quiet time for campaigns in the application.
void	setQuietTime(IResolvable value) The default quiet time for campaigns in the application.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApplicationSettings

protected CfnApplicationSettings(software.amazon.jsii.JsiiObjectRef objRef)

CfnApplicationSettings

protected CfnApplicationSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApplicationSettings

@Stability(value=Stable)
public CfnApplicationSettings(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @NotNull
                                                       CfnApplicationSettingsProps props)

Create a new `AWS::Pinpoint::ApplicationSettings`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

@Stability(value=Stable)
 @NotNull
public String getApplicationId()

The unique identifier for the Amazon Pinpoint application.

setApplicationId

@Stability(value=Stable)
public void setApplicationId(@NotNull
                                                      String value)

The unique identifier for the Amazon Pinpoint application.

getCampaignHook

@Stability(value=Stable)
 @Nullable
public Object getCampaignHook()

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.

setCampaignHook

@Stability(value=Stable)
public void setCampaignHook(@Nullable
                                                     CfnApplicationSettings.CampaignHookProperty value)

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.

setCampaignHook

@Stability(value=Stable)
public void setCampaignHook(@Nullable
                                                     IResolvable value)

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.

getCloudWatchMetricsEnabled

@Stability(value=Stable)
 @Nullable
public Object getCloudWatchMetricsEnabled()

Specifies whether to enable application-related alarms in Amazon CloudWatch.

setCloudWatchMetricsEnabled

@Stability(value=Stable)
public void setCloudWatchMetricsEnabled(@Nullable
                                                                 Boolean value)

Specifies whether to enable application-related alarms in Amazon CloudWatch.

setCloudWatchMetricsEnabled

@Stability(value=Stable)
public void setCloudWatchMetricsEnabled(@Nullable
                                                                 IResolvable value)

Specifies whether to enable application-related alarms in Amazon CloudWatch.

getLimits

@Stability(value=Stable)
 @Nullable
public Object getLimits()

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.

setLimits

@Stability(value=Stable)
public void setLimits(@Nullable
                                               CfnApplicationSettings.LimitsProperty value)

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.

setLimits

@Stability(value=Stable)
public void setLimits(@Nullable
                                               IResolvable value)

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.

getQuietTime

@Stability(value=Stable)
 @Nullable
public Object getQuietTime()

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.

setQuietTime

@Stability(value=Stable)
public void setQuietTime(@Nullable
                                                  CfnApplicationSettings.QuietTimeProperty value)

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.

setQuietTime

@Stability(value=Stable)
public void setQuietTime(@Nullable
                                                  IResolvable value)

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.