Interface ICfnApplicationSettingsMixinProps

Properties for CfnApplicationSettingsPropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Pinpoint

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnApplicationSettingsMixinProps

Syntax (vb)

Public Interface ICfnApplicationSettingsMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Pinpoint;

             var cfnApplicationSettingsMixinProps = new CfnApplicationSettingsMixinProps {
                 ApplicationId = "applicationId",
                 CampaignHook = new CampaignHookProperty {
                     LambdaFunctionName = "lambdaFunctionName",
                     Mode = "mode",
                     WebUrl = "webUrl"
                 },
                 CloudWatchMetricsEnabled = false,
                 Limits = new LimitsProperty {
                     Daily = 123,
                     MaximumDuration = 123,
                     MessagesPerSecond = 123,
                     Total = 123
                 },
                 QuietTime = new QuietTimeProperty {
                     End = "end",
                     Start = "start"
                 }
             };

Synopsis

Properties

ApplicationId	The unique identifier for the Amazon Pinpoint application.
CampaignHook	The settings for the Lambda function to use by default as a code hook for campaigns in the application.
CloudWatchMetricsEnabled	Properties for CfnApplicationSettingsPropsMixin.
Limits	The default sending limits for campaigns in the application.
QuietTime	The default quiet time for campaigns in the application.

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application.

string? ApplicationId { get; }

Property Value

string

Remarks

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

CampaignHook

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

object? CampaignHook { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnApplicationSettingsPropsMixin.ICampaignHookProperty

CloudWatchMetricsEnabled

Properties for CfnApplicationSettingsPropsMixin.

object? CloudWatchMetricsEnabled { get; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

Limits

The default sending limits for campaigns in the application.

object? Limits { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnApplicationSettingsPropsMixin.ILimitsProperty

QuietTime

The default quiet time for campaigns in the application.

object? QuietTime { get; }

Property Value

object

Remarks

Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:

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

Type union: either IResolvable or CfnApplicationSettingsPropsMixin.IQuietTimeProperty