Class CfnApplicationSettings
A CloudFormation AWS::Pinpoint::ApplicationSettings
.
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.AWS.Pinpoint.dll
Syntax (csharp)
public class CfnApplicationSettings : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApplicationSettings
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Pinpoint::ApplicationSettings
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.AWS.Pinpoint;
var cfnApplicationSettings = new CfnApplicationSettings(this, "MyCfnApplicationSettings", new CfnApplicationSettingsProps {
ApplicationId = "applicationId",
// the properties below are optional
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
Constructors
CfnApplicationSettings(Construct, String, ICfnApplicationSettingsProps) | Create a new |
CfnApplicationSettings(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplicationSettings(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CloudWatchMetricsEnabled | Specifies whether to enable application-related alarms in Amazon CloudWatch. |
Limits | The default sending limits for campaigns in the application. |
QuietTime | The default quiet time for campaigns in the application. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplicationSettings(Construct, String, ICfnApplicationSettingsProps)
Create a new AWS::Pinpoint::ApplicationSettings
.
public CfnApplicationSettings(Construct scope, string id, ICfnApplicationSettingsProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApplicationSettingsProps
- resource properties.
CfnApplicationSettings(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplicationSettings(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplicationSettings(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplicationSettings(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApplicationId
The unique identifier for the Amazon Pinpoint application.
public virtual string ApplicationId { get; set; }
Property Value
System.String
Remarks
CampaignHook
The settings for the Lambda function to use by default as a code hook for campaigns in the application.
public virtual object CampaignHook { get; set; }
Property Value
System.Object
Remarks
To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CloudWatchMetricsEnabled
Specifies whether to enable application-related alarms in Amazon CloudWatch.
public virtual object CloudWatchMetricsEnabled { get; set; }
Property Value
System.Object
Remarks
Limits
The default sending limits for campaigns in the application.
public virtual object Limits { get; set; }
Property Value
System.Object
Remarks
To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
QuietTime
The default quiet time for campaigns in the application.
public virtual object QuietTime { get; set; }
Property Value
System.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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>