Namespace Amazon.CDK.AWS.Pinpoint
Amazon Pinpoint Construct Library
This module is part of the AWS Cloud Development Kit project.
using Amazon.CDK.AWS.Pinpoint;There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Pinpoint.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
Classes
| CfnADMChannel | A channel is a type of platform that you can deliver messages to. |
| CfnADMChannelProps | Properties for defining a |
| CfnAPNSChannel | A channel is a type of platform that you can deliver messages to. |
| CfnAPNSChannelProps | Properties for defining a |
| CfnAPNSSandboxChannel | A channel is a type of platform that you can deliver messages to. |
| CfnAPNSSandboxChannelProps | Properties for defining a |
| CfnAPNSVoipChannel | A channel is a type of platform that you can deliver messages to. |
| CfnAPNSVoipChannelProps | Properties for defining a |
| CfnAPNSVoipSandboxChannel | A channel is a type of platform that you can deliver messages to. |
| CfnAPNSVoipSandboxChannelProps | Properties for defining a |
| CfnApp | An app is an Amazon Pinpoint application, also referred to as a project . |
| CfnApplicationSettings | Specifies the settings for an Amazon Pinpoint application. |
| CfnApplicationSettings.CampaignHookProperty | Specifies the Lambda function to use by default as a code hook for campaigns in the application. |
| CfnApplicationSettings.LimitsProperty | Specifies the default sending limits for campaigns in the application. |
| CfnApplicationSettings.QuietTimeProperty | Specifies the start and end times that define a time range when messages aren't sent to endpoints. |
| CfnApplicationSettingsProps | Properties for defining a |
| CfnAppProps | Properties for defining a |
| CfnBaiduChannel | A channel is a type of platform that you can deliver messages to. |
| CfnBaiduChannelProps | Properties for defining a |
| CfnCampaign | Specifies the settings for a campaign. |
| CfnCampaign.AttributeDimensionProperty | |
| CfnCampaign.CampaignCustomMessageProperty | Specifies the contents of a message that's sent through a custom channel to recipients of a campaign. |
| CfnCampaign.CampaignEmailMessageProperty | Specifies the content and "From" address for an email message that's sent to recipients of a campaign. |
| CfnCampaign.CampaignEventFilterProperty | Specifies the settings for events that cause a campaign to be sent. |
| CfnCampaign.CampaignHookProperty | Specifies settings for invoking an Lambda function that customizes a segment for a campaign. |
| CfnCampaign.CampaignInAppMessageProperty | Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message. |
| CfnCampaign.CampaignSmsMessageProperty | Specifies the content and settings for an SMS message that's sent to recipients of a campaign. |
| CfnCampaign.CustomDeliveryConfigurationProperty | Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. |
| CfnCampaign.DefaultButtonConfigurationProperty | Specifies the default behavior for a button that appears in an in-app message. |
| CfnCampaign.EventDimensionsProperty | Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed. |
| CfnCampaign.InAppMessageBodyConfigProperty | Specifies the configuration of main body text of the in-app message. |
| CfnCampaign.InAppMessageButtonProperty | Specifies the configuration of a button that appears in an in-app message. |
| CfnCampaign.InAppMessageContentProperty | Specifies the configuration and contents of an in-app message. |
| CfnCampaign.InAppMessageHeaderConfigProperty | Specifies the configuration and content of the header or title text of the in-app message. |
| CfnCampaign.LimitsProperty | Specifies the limits on the messages that a campaign can send. |
| CfnCampaign.MessageConfigurationProperty | Specifies the message configuration settings for a campaign. |
| CfnCampaign.MessageProperty | Specifies the content and settings for a push notification that's sent to recipients of a campaign. |
| CfnCampaign.MetricDimensionProperty | |
| CfnCampaign.OverrideButtonConfigurationProperty | Specifies the configuration of a button with settings that are specific to a certain device type. |
| CfnCampaign.QuietTimeProperty | Specifies the start and end times that define a time range when messages aren't sent to endpoints. |
| CfnCampaign.ScheduleProperty | Specifies the schedule settings for a campaign. |
| CfnCampaign.SetDimensionProperty | Specifies the dimension type and values for a segment dimension. |
| CfnCampaign.TemplateConfigurationProperty | Specifies the message template to use for the message, for each type of channel. |
| CfnCampaign.TemplateProperty | Specifies the name and version of the message template to use for the message. |
| CfnCampaign.WriteTreatmentResourceProperty | Specifies the settings for a campaign treatment. |
| CfnCampaignProps | Properties for defining a |
| CfnEmailChannel | A channel is a type of platform that you can deliver messages to. |
| CfnEmailChannelProps | Properties for defining a |
| CfnEmailTemplate | Creates a message template that you can use in messages that are sent through the email channel. |
| CfnEmailTemplateProps | Properties for defining a |
| CfnEventStream | Creates a new event stream for an application or updates the settings of an existing event stream for an application. |
| CfnEventStreamProps | Properties for defining a |
| CfnGCMChannel | A channel is a type of platform that you can deliver messages to. |
| CfnGCMChannelProps | Properties for defining a |
| CfnInAppTemplate | Creates a message template that you can use to send in-app messages. |
| CfnInAppTemplate.BodyConfigProperty | Specifies the configuration of the main body text of the in-app message. |
| CfnInAppTemplate.ButtonConfigProperty | Specifies the behavior of buttons that appear in an in-app message template. |
| CfnInAppTemplate.DefaultButtonConfigurationProperty | Specifies the default behavior of a button that appears in an in-app message. |
| CfnInAppTemplate.HeaderConfigProperty | Specifies the configuration and content of the header or title text of the in-app message. |
| CfnInAppTemplate.InAppMessageContentProperty | Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images. |
| CfnInAppTemplate.OverrideButtonConfigurationProperty | Specifies the configuration of a button with settings that are specific to a certain device type. |
| CfnInAppTemplateProps | Properties for defining a |
| CfnPushTemplate | Creates a message template that you can use in messages that are sent through a push notification channel. |
| CfnPushTemplate.AndroidPushNotificationTemplateProperty | Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel. |
| CfnPushTemplate.APNSPushNotificationTemplateProperty | Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel. |
| CfnPushTemplate.DefaultPushNotificationTemplateProperty | Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel. |
| CfnPushTemplateProps | Properties for defining a |
| CfnSegment | Updates the configuration, dimension, and other settings for an existing segment. |
| CfnSegment.AttributeDimensionProperty | |
| CfnSegment.BehaviorProperty | Specifies behavior-based criteria for the segment, such as how recently users have used your app. |
| CfnSegment.CoordinatesProperty | Specifies the GPS coordinates of a location. |
| CfnSegment.DemographicProperty | Specifies demographic-based criteria, such as device platform, for the segment. |
| CfnSegment.GPSPointProperty | Specifies the GPS coordinates of the endpoint location. |
| CfnSegment.GroupsProperty | An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. |
| CfnSegment.LocationProperty | Specifies location-based criteria, such as region or GPS coordinates, for the segment. |
| CfnSegment.RecencyProperty | Specifies how recently segment members were active. |
| CfnSegment.SegmentDimensionsProperty | Specifies the dimension settings for a segment. |
| CfnSegment.SegmentGroupsProperty | Specifies the set of segment criteria to evaluate when handling segment groups for the segment. |
| CfnSegment.SetDimensionProperty | Specifies the dimension type and values for a segment dimension. |
| CfnSegment.SourceSegmentsProperty | Specifies the base segment to build the segment on. |
| CfnSegmentProps | Properties for defining a |
| CfnSMSChannel | A channel is a type of platform that you can deliver messages to. |
| CfnSMSChannelProps | Properties for defining a |
| CfnSmsTemplate | Creates a message template that you can use in messages that are sent through the SMS channel. |
| CfnSmsTemplateProps | Properties for defining a |
| CfnVoiceChannel | A channel is a type of platform that you can deliver messages to. |
| CfnVoiceChannelProps | Properties for defining a |
Interfaces
| CfnApplicationSettings.ICampaignHookProperty | Specifies the Lambda function to use by default as a code hook for campaigns in the application. |
| CfnApplicationSettings.ILimitsProperty | Specifies the default sending limits for campaigns in the application. |
| CfnApplicationSettings.IQuietTimeProperty | Specifies the start and end times that define a time range when messages aren't sent to endpoints. |
| CfnCampaign.IAttributeDimensionProperty | |
| CfnCampaign.ICampaignCustomMessageProperty | Specifies the contents of a message that's sent through a custom channel to recipients of a campaign. |
| CfnCampaign.ICampaignEmailMessageProperty | Specifies the content and "From" address for an email message that's sent to recipients of a campaign. |
| CfnCampaign.ICampaignEventFilterProperty | Specifies the settings for events that cause a campaign to be sent. |
| CfnCampaign.ICampaignHookProperty | Specifies settings for invoking an Lambda function that customizes a segment for a campaign. |
| CfnCampaign.ICampaignInAppMessageProperty | Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message. |
| CfnCampaign.ICampaignSmsMessageProperty | Specifies the content and settings for an SMS message that's sent to recipients of a campaign. |
| CfnCampaign.ICustomDeliveryConfigurationProperty | Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel. |
| CfnCampaign.IDefaultButtonConfigurationProperty | Specifies the default behavior for a button that appears in an in-app message. |
| CfnCampaign.IEventDimensionsProperty | Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed. |
| CfnCampaign.IInAppMessageBodyConfigProperty | Specifies the configuration of main body text of the in-app message. |
| CfnCampaign.IInAppMessageButtonProperty | Specifies the configuration of a button that appears in an in-app message. |
| CfnCampaign.IInAppMessageContentProperty | Specifies the configuration and contents of an in-app message. |
| CfnCampaign.IInAppMessageHeaderConfigProperty | Specifies the configuration and content of the header or title text of the in-app message. |
| CfnCampaign.ILimitsProperty | Specifies the limits on the messages that a campaign can send. |
| CfnCampaign.IMessageConfigurationProperty | Specifies the message configuration settings for a campaign. |
| CfnCampaign.IMessageProperty | Specifies the content and settings for a push notification that's sent to recipients of a campaign. |
| CfnCampaign.IMetricDimensionProperty | |
| CfnCampaign.IOverrideButtonConfigurationProperty | Specifies the configuration of a button with settings that are specific to a certain device type. |
| CfnCampaign.IQuietTimeProperty | Specifies the start and end times that define a time range when messages aren't sent to endpoints. |
| CfnCampaign.IScheduleProperty | Specifies the schedule settings for a campaign. |
| CfnCampaign.ISetDimensionProperty | Specifies the dimension type and values for a segment dimension. |
| CfnCampaign.ITemplateConfigurationProperty | Specifies the message template to use for the message, for each type of channel. |
| CfnCampaign.ITemplateProperty | Specifies the name and version of the message template to use for the message. |
| CfnCampaign.IWriteTreatmentResourceProperty | Specifies the settings for a campaign treatment. |
| CfnInAppTemplate.IBodyConfigProperty | Specifies the configuration of the main body text of the in-app message. |
| CfnInAppTemplate.IButtonConfigProperty | Specifies the behavior of buttons that appear in an in-app message template. |
| CfnInAppTemplate.IDefaultButtonConfigurationProperty | Specifies the default behavior of a button that appears in an in-app message. |
| CfnInAppTemplate.IHeaderConfigProperty | Specifies the configuration and content of the header or title text of the in-app message. |
| CfnInAppTemplate.IInAppMessageContentProperty | Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images. |
| CfnInAppTemplate.IOverrideButtonConfigurationProperty | Specifies the configuration of a button with settings that are specific to a certain device type. |
| CfnPushTemplate.IAndroidPushNotificationTemplateProperty | Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel. |
| CfnPushTemplate.IAPNSPushNotificationTemplateProperty | Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel. |
| CfnPushTemplate.IDefaultPushNotificationTemplateProperty | Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel. |
| CfnSegment.IAttributeDimensionProperty | |
| CfnSegment.IBehaviorProperty | Specifies behavior-based criteria for the segment, such as how recently users have used your app. |
| CfnSegment.ICoordinatesProperty | Specifies the GPS coordinates of a location. |
| CfnSegment.IDemographicProperty | Specifies demographic-based criteria, such as device platform, for the segment. |
| CfnSegment.IGPSPointProperty | Specifies the GPS coordinates of the endpoint location. |
| CfnSegment.IGroupsProperty | An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. |
| CfnSegment.ILocationProperty | Specifies location-based criteria, such as region or GPS coordinates, for the segment. |
| CfnSegment.IRecencyProperty | Specifies how recently segment members were active. |
| CfnSegment.ISegmentDimensionsProperty | Specifies the dimension settings for a segment. |
| CfnSegment.ISegmentGroupsProperty | Specifies the set of segment criteria to evaluate when handling segment groups for the segment. |
| CfnSegment.ISetDimensionProperty | Specifies the dimension type and values for a segment dimension. |
| CfnSegment.ISourceSegmentsProperty | Specifies the base segment to build the segment on. |
| ICfnADMChannelProps | Properties for defining a |
| ICfnAPNSChannelProps | Properties for defining a |
| ICfnAPNSSandboxChannelProps | Properties for defining a |
| ICfnAPNSVoipChannelProps | Properties for defining a |
| ICfnAPNSVoipSandboxChannelProps | Properties for defining a |
| ICfnApplicationSettingsProps | Properties for defining a |
| ICfnAppProps | Properties for defining a |
| ICfnBaiduChannelProps | Properties for defining a |
| ICfnCampaignProps | Properties for defining a |
| ICfnEmailChannelProps | Properties for defining a |
| ICfnEmailTemplateProps | Properties for defining a |
| ICfnEventStreamProps | Properties for defining a |
| ICfnGCMChannelProps | Properties for defining a |
| ICfnInAppTemplateProps | Properties for defining a |
| ICfnPushTemplateProps | Properties for defining a |
| ICfnSegmentProps | Properties for defining a |
| ICfnSMSChannelProps | Properties for defining a |
| ICfnSmsTemplateProps | Properties for defining a |
| ICfnVoiceChannelProps | Properties for defining a |