CfnApplicationSettingsPropsMixin

class aws_cdk.mixins_preview.aws_pinpoint.mixins.CfnApplicationSettingsPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html
CloudformationResource:: AWS::Pinpoint::ApplicationSettings
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

cfn_application_settings_props_mixin = pinpoint_mixins.CfnApplicationSettingsPropsMixin(pinpoint_mixins.CfnApplicationSettingsMixinProps(
    application_id="applicationId",
    campaign_hook=pinpoint_mixins.CfnApplicationSettingsPropsMixin.CampaignHookProperty(
        lambda_function_name="lambdaFunctionName",
        mode="mode",
        web_url="webUrl"
    ),
    cloud_watch_metrics_enabled=False,
    limits=pinpoint_mixins.CfnApplicationSettingsPropsMixin.LimitsProperty(
        daily=123,
        maximum_duration=123,
        messages_per_second=123,
        total=123
    ),
    quiet_time=pinpoint_mixins.CfnApplicationSettingsPropsMixin.QuietTimeProperty(
        end="end",
        start="start"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Pinpoint::ApplicationSettings.

Parameters:

props (Union[CfnApplicationSettingsMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationId', 'campaignHook', 'cloudWatchMetricsEnabled', 'limits', 'quietTime']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CampaignHookProperty

class CfnApplicationSettingsPropsMixin.CampaignHookProperty(*, lambda_function_name=None, mode=None, web_url=None)

Bases: object

Specifies the Lambda function to use by default as a code hook for campaigns in the application.

Parameters:

lambda_function_name (Optional[str]) – The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.
mode (Optional[str]) – The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:. - FILTER - Invoke the function to customize the segment that’s used by a campaign. - DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
web_url (Optional[str]) – The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.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.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

campaign_hook_property = pinpoint_mixins.CfnApplicationSettingsPropsMixin.CampaignHookProperty(
    lambda_function_name="lambdaFunctionName",
    mode="mode",
    web_url="webUrl"
)

Attributes

lambda_function_name

The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.

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

mode

.

FILTER - Invoke the function to customize the segment that’s used by a campaign.
DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-mode
Type:: The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are

web_url

The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.

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

LimitsProperty

class CfnApplicationSettingsPropsMixin.LimitsProperty(*, daily=None, maximum_duration=None, messages_per_second=None, total=None)

Bases: object

Specifies the default sending limits for campaigns in the application.

Parameters:

daily (Union[int, float, None]) – The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
maximum_duration (Union[int, float, None]) – 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.
messages_per_second (Union[int, float, None]) – The maximum number of messages that a campaign can send each second. The minimum value is 1. The maximum value is 20,000.
total (Union[int, float, None]) – 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.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.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

limits_property = pinpoint_mixins.CfnApplicationSettingsPropsMixin.LimitsProperty(
    daily=123,
    maximum_duration=123,
    messages_per_second=123,
    total=123
)

Attributes

daily

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-daily

maximum_duration

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-maximumduration

messages_per_second

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

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

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

total

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-total

QuietTimeProperty

class CfnApplicationSettingsPropsMixin.QuietTimeProperty(*, end=None, start=None)

Bases: object

Specifies the start and end times that define a time range when messages aren’t sent to endpoints.

Parameters:

end (Optional[str]) – The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
start (Optional[str]) – The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.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.mixins_preview.aws_pinpoint import mixins as pinpoint_mixins

quiet_time_property = pinpoint_mixins.CfnApplicationSettingsPropsMixin.QuietTimeProperty(
    end="end",
    start="start"
)

Attributes

end

The specific time when quiet time ends.

This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

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

start

The specific time when quiet time begins.

This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

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