CfnApplicationSettingsProps

class aws_cdk.aws_pinpoint.CfnApplicationSettingsProps(*, application_id, campaign_hook=None, cloud_watch_metrics_enabled=None, limits=None, quiet_time=None)

Bases: object

Properties for defining a CfnApplicationSettings.

Parameters:

application_id (str) – The unique identifier for the Amazon Pinpoint application.
campaign_hook (Union[IResolvable, CampaignHookProperty, Dict[str, Any], None]) – 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.
cloud_watch_metrics_enabled (Union[bool, IResolvable, None]) –
limits (Union[IResolvable, LimitsProperty, Dict[str, Any], None]) – 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.
quiet_time (Union[IResolvable, QuietTimeProperty, Dict[str, Any], None]) – 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.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_pinpoint as pinpoint

cfn_application_settings_props = pinpoint.CfnApplicationSettingsProps(
    application_id="applicationId",

    # the properties below are optional
    campaign_hook=pinpoint.CfnApplicationSettings.CampaignHookProperty(
        lambda_function_name="lambdaFunctionName",
        mode="mode",
        web_url="webUrl"
    ),
    cloud_watch_metrics_enabled=False,
    limits=pinpoint.CfnApplicationSettings.LimitsProperty(
        daily=123,
        maximum_duration=123,
        messages_per_second=123,
        total=123
    ),
    quiet_time=pinpoint.CfnApplicationSettings.QuietTimeProperty(
        end="end",
        start="start"
    )
)

Attributes

application_id

The unique identifier for the Amazon Pinpoint application.

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

campaign_hook

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.

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

cloud_watch_metrics_enabled

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

Type:: see

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.

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

quiet_time

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.

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