Package software.amazon.awscdk.services.pinpoint

Class CfnApplicationSettings

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.pinpoint.CfnApplicationSettings
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.750Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApplicationSettings

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

    • CfnApplicationSettings

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

    • CfnApplicationSettings

      @Stability(Stable) public CfnApplicationSettings(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The unique identifier for the Amazon Pinpoint application.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier for the Amazon Pinpoint application.

    • getCampaignHook

      @Stability(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(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.

    • setCampaignHook

      @Stability(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.

    • getCloudWatchMetricsEnabled

      @Stability(Stable) @Nullable public Object getCloudWatchMetricsEnabled()
      Specifies whether to enable application-related alarms in Amazon CloudWatch.

    • setCloudWatchMetricsEnabled

      @Stability(Stable) public void setCloudWatchMetricsEnabled(@Nullable Boolean value)
      Specifies whether to enable application-related alarms in Amazon CloudWatch.

    • setCloudWatchMetricsEnabled

      @Stability(Stable) public void setCloudWatchMetricsEnabled(@Nullable IResolvable value)
      Specifies whether to enable application-related alarms in Amazon CloudWatch.

    • getLimits

      @Stability(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(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.

    • setLimits

      @Stability(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.

    • getQuietTime

      @Stability(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(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.

    • setQuietTime

      @Stability(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.