Package software.amazon.awscdk.services.pinpoint
package software.amazon.awscdk.services.pinpoint
Amazon Pinpoint Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.pinpoint.*;
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for Pinpoint construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Pinpoint resources directly.
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.)
-
ClassDescriptionA reference to a ADMChannel resource.A builder for
ADMChannelReferenceAn implementation forADMChannelReferenceA reference to a APNSChannel resource.A builder forAPNSChannelReferenceAn implementation forAPNSChannelReferenceA reference to a APNSSandboxChannel resource.A builder forAPNSSandboxChannelReferenceAn implementation forAPNSSandboxChannelReferenceA reference to a APNSVoipChannel resource.A builder forAPNSVoipChannelReferenceAn implementation forAPNSVoipChannelReferenceA reference to a APNSVoipSandboxChannel resource.A builder forAPNSVoipSandboxChannelReferenceAn implementation forAPNSVoipSandboxChannelReferenceA reference to a ApplicationSettings resource.A builder forApplicationSettingsReferenceAn implementation forApplicationSettingsReferenceA reference to a App resource.A builder forAppReferenceAn implementation forAppReferenceA reference to a BaiduChannel resource.A builder forBaiduChannelReferenceAn implementation forBaiduChannelReferenceA reference to a Campaign resource.A builder forCampaignReferenceAn implementation forCampaignReferenceA channel is a type of platform that you can deliver messages to.A fluent builder forCfnADMChannel.Properties for defining aCfnADMChannel.A builder forCfnADMChannelPropsAn implementation forCfnADMChannelPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnAPNSChannel.Properties for defining aCfnAPNSChannel.A builder forCfnAPNSChannelPropsAn implementation forCfnAPNSChannelPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnAPNSSandboxChannel.Properties for defining aCfnAPNSSandboxChannel.A builder forCfnAPNSSandboxChannelPropsAn implementation forCfnAPNSSandboxChannelPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnAPNSVoipChannel.Properties for defining aCfnAPNSVoipChannel.A builder forCfnAPNSVoipChannelPropsAn implementation forCfnAPNSVoipChannelPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnAPNSVoipSandboxChannel.Properties for defining aCfnAPNSVoipSandboxChannel.A builder forCfnAPNSVoipSandboxChannelPropsAn implementation forCfnAPNSVoipSandboxChannelPropsAn app is an Amazon Pinpoint application, also referred to as a project .A fluent builder forCfnApp.Specifies the settings for an Amazon Pinpoint application.A fluent builder forCfnApplicationSettings.Specifies the Lambda function to use by default as a code hook for campaigns in the application.A builder forCfnApplicationSettings.CampaignHookPropertyAn implementation forCfnApplicationSettings.CampaignHookPropertySpecifies the default sending limits for campaigns in the application.A builder forCfnApplicationSettings.LimitsPropertyAn implementation forCfnApplicationSettings.LimitsPropertySpecifies the start and end times that define a time range when messages aren't sent to endpoints.A builder forCfnApplicationSettings.QuietTimePropertyAn implementation forCfnApplicationSettings.QuietTimePropertyProperties for defining aCfnApplicationSettings.A builder forCfnApplicationSettingsPropsAn implementation forCfnApplicationSettingsPropsProperties for defining aCfnApp.A builder forCfnAppPropsAn implementation forCfnAppPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnBaiduChannel.Properties for defining aCfnBaiduChannel.A builder forCfnBaiduChannelPropsAn implementation forCfnBaiduChannelPropsSpecifies the settings for a campaign.Example:A builder forCfnCampaign.AttributeDimensionPropertyAn implementation forCfnCampaign.AttributeDimensionPropertyA fluent builder forCfnCampaign.Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.A builder forCfnCampaign.CampaignCustomMessagePropertyAn implementation forCfnCampaign.CampaignCustomMessagePropertySpecifies the content and "From" address for an email message that's sent to recipients of a campaign.A builder forCfnCampaign.CampaignEmailMessagePropertyAn implementation forCfnCampaign.CampaignEmailMessagePropertySpecifies the settings for events that cause a campaign to be sent.A builder forCfnCampaign.CampaignEventFilterPropertyAn implementation forCfnCampaign.CampaignEventFilterPropertySpecifies settings for invoking an Lambda function that customizes a segment for a campaign.A builder forCfnCampaign.CampaignHookPropertyAn implementation forCfnCampaign.CampaignHookPropertySpecifies 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.A builder forCfnCampaign.CampaignInAppMessagePropertyAn implementation forCfnCampaign.CampaignInAppMessagePropertySpecifies the content and settings for an SMS message that's sent to recipients of a campaign.A builder forCfnCampaign.CampaignSmsMessagePropertyAn implementation forCfnCampaign.CampaignSmsMessagePropertySpecifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel.A builder forCfnCampaign.CustomDeliveryConfigurationPropertyAn implementation forCfnCampaign.CustomDeliveryConfigurationPropertySpecifies the default behavior for a button that appears in an in-app message.A builder forCfnCampaign.DefaultButtonConfigurationPropertyAn implementation forCfnCampaign.DefaultButtonConfigurationPropertySpecifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.A builder forCfnCampaign.EventDimensionsPropertyAn implementation forCfnCampaign.EventDimensionsPropertySpecifies the configuration of main body text of the in-app message.A builder forCfnCampaign.InAppMessageBodyConfigPropertyAn implementation forCfnCampaign.InAppMessageBodyConfigPropertySpecifies the configuration of a button that appears in an in-app message.A builder forCfnCampaign.InAppMessageButtonPropertyAn implementation forCfnCampaign.InAppMessageButtonPropertySpecifies the configuration and contents of an in-app message.A builder forCfnCampaign.InAppMessageContentPropertyAn implementation forCfnCampaign.InAppMessageContentPropertySpecifies the configuration and content of the header or title text of the in-app message.A builder forCfnCampaign.InAppMessageHeaderConfigPropertyAn implementation forCfnCampaign.InAppMessageHeaderConfigPropertySpecifies the limits on the messages that a campaign can send.A builder forCfnCampaign.LimitsPropertyAn implementation forCfnCampaign.LimitsPropertySpecifies the message configuration settings for a campaign.A builder forCfnCampaign.MessageConfigurationPropertyAn implementation forCfnCampaign.MessageConfigurationPropertySpecifies the content and settings for a push notification that's sent to recipients of a campaign.A builder forCfnCampaign.MessagePropertyAn implementation forCfnCampaign.MessagePropertyExample:A builder forCfnCampaign.MetricDimensionPropertyAn implementation forCfnCampaign.MetricDimensionPropertySpecifies the configuration of a button with settings that are specific to a certain device type.A builder forCfnCampaign.OverrideButtonConfigurationPropertyAn implementation forCfnCampaign.OverrideButtonConfigurationPropertySpecifies the start and end times that define a time range when messages aren't sent to endpoints.A builder forCfnCampaign.QuietTimePropertyAn implementation forCfnCampaign.QuietTimePropertySpecifies the schedule settings for a campaign.A builder forCfnCampaign.SchedulePropertyAn implementation forCfnCampaign.SchedulePropertySpecifies the dimension type and values for a segment dimension.A builder forCfnCampaign.SetDimensionPropertyAn implementation forCfnCampaign.SetDimensionPropertySpecifies the message template to use for the message, for each type of channel.A builder forCfnCampaign.TemplateConfigurationPropertyAn implementation forCfnCampaign.TemplateConfigurationPropertySpecifies the name and version of the message template to use for the message.A builder forCfnCampaign.TemplatePropertyAn implementation forCfnCampaign.TemplatePropertySpecifies the settings for a campaign treatment.A builder forCfnCampaign.WriteTreatmentResourcePropertyAn implementation forCfnCampaign.WriteTreatmentResourcePropertyProperties for defining aCfnCampaign.A builder forCfnCampaignPropsAn implementation forCfnCampaignPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnEmailChannel.Properties for defining aCfnEmailChannel.A builder forCfnEmailChannelPropsAn implementation forCfnEmailChannelPropsCreates a message template that you can use in messages that are sent through the email channel.A fluent builder forCfnEmailTemplate.Properties for defining aCfnEmailTemplate.A builder forCfnEmailTemplatePropsAn implementation forCfnEmailTemplatePropsCreates a new event stream for an application or updates the settings of an existing event stream for an application.A fluent builder forCfnEventStream.Properties for defining aCfnEventStream.A builder forCfnEventStreamPropsAn implementation forCfnEventStreamPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnGCMChannel.Properties for defining aCfnGCMChannel.A builder forCfnGCMChannelPropsAn implementation forCfnGCMChannelPropsCreates a message template that you can use to send in-app messages.Specifies the configuration of the main body text of the in-app message.A builder forCfnInAppTemplate.BodyConfigPropertyAn implementation forCfnInAppTemplate.BodyConfigPropertyA fluent builder forCfnInAppTemplate.Specifies the behavior of buttons that appear in an in-app message template.A builder forCfnInAppTemplate.ButtonConfigPropertyAn implementation forCfnInAppTemplate.ButtonConfigPropertySpecifies the default behavior of a button that appears in an in-app message.A builder forCfnInAppTemplate.DefaultButtonConfigurationPropertyAn implementation forCfnInAppTemplate.DefaultButtonConfigurationPropertySpecifies the configuration and content of the header or title text of the in-app message.A builder forCfnInAppTemplate.HeaderConfigPropertyAn implementation forCfnInAppTemplate.HeaderConfigPropertySpecifies the configuration of an in-app message, including its header, body, buttons, colors, and images.A builder forCfnInAppTemplate.InAppMessageContentPropertyAn implementation forCfnInAppTemplate.InAppMessageContentPropertySpecifies the configuration of a button with settings that are specific to a certain device type.A builder forCfnInAppTemplate.OverrideButtonConfigurationPropertyAn implementation forCfnInAppTemplate.OverrideButtonConfigurationPropertyProperties for defining aCfnInAppTemplate.A builder forCfnInAppTemplatePropsAn implementation forCfnInAppTemplatePropsCreates a message template that you can use in messages that are sent through a push notification channel.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.A builder forCfnPushTemplate.AndroidPushNotificationTemplatePropertyAn implementation forCfnPushTemplate.AndroidPushNotificationTemplatePropertySpecifies 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.A builder forCfnPushTemplate.APNSPushNotificationTemplatePropertyAn implementation forCfnPushTemplate.APNSPushNotificationTemplatePropertyA fluent builder forCfnPushTemplate.Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.A builder forCfnPushTemplate.DefaultPushNotificationTemplatePropertyAn implementation forCfnPushTemplate.DefaultPushNotificationTemplatePropertyProperties for defining aCfnPushTemplate.A builder forCfnPushTemplatePropsAn implementation forCfnPushTemplatePropsUpdates the configuration, dimension, and other settings for an existing segment.Example:A builder forCfnSegment.AttributeDimensionPropertyAn implementation forCfnSegment.AttributeDimensionPropertySpecifies behavior-based criteria for the segment, such as how recently users have used your app.A builder forCfnSegment.BehaviorPropertyAn implementation forCfnSegment.BehaviorPropertyA fluent builder forCfnSegment.Specifies the GPS coordinates of a location.A builder forCfnSegment.CoordinatesPropertyAn implementation forCfnSegment.CoordinatesPropertySpecifies demographic-based criteria, such as device platform, for the segment.A builder forCfnSegment.DemographicPropertyAn implementation forCfnSegment.DemographicPropertySpecifies the GPS coordinates of the endpoint location.A builder forCfnSegment.GPSPointPropertyAn implementation forCfnSegment.GPSPointPropertyAn array that defines the set of segment criteria to evaluate when handling segment groups for the segment.A builder forCfnSegment.GroupsPropertyAn implementation forCfnSegment.GroupsPropertySpecifies location-based criteria, such as region or GPS coordinates, for the segment.A builder forCfnSegment.LocationPropertyAn implementation forCfnSegment.LocationPropertySpecifies how recently segment members were active.A builder forCfnSegment.RecencyPropertyAn implementation forCfnSegment.RecencyPropertySpecifies the dimension settings for a segment.A builder forCfnSegment.SegmentDimensionsPropertyAn implementation forCfnSegment.SegmentDimensionsPropertySpecifies the set of segment criteria to evaluate when handling segment groups for the segment.A builder forCfnSegment.SegmentGroupsPropertyAn implementation forCfnSegment.SegmentGroupsPropertySpecifies the dimension type and values for a segment dimension.A builder forCfnSegment.SetDimensionPropertyAn implementation forCfnSegment.SetDimensionPropertySpecifies the base segment to build the segment on.A builder forCfnSegment.SourceSegmentsPropertyAn implementation forCfnSegment.SourceSegmentsPropertyProperties for defining aCfnSegment.A builder forCfnSegmentPropsAn implementation forCfnSegmentPropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnSMSChannel.Properties for defining aCfnSMSChannel.A builder forCfnSMSChannelPropsAn implementation forCfnSMSChannelPropsCreates a message template that you can use in messages that are sent through the SMS channel.A fluent builder forCfnSmsTemplate.Properties for defining aCfnSmsTemplate.A builder forCfnSmsTemplatePropsAn implementation forCfnSmsTemplatePropsA channel is a type of platform that you can deliver messages to.A fluent builder forCfnVoiceChannel.Properties for defining aCfnVoiceChannel.A builder forCfnVoiceChannelPropsAn implementation forCfnVoiceChannelPropsA reference to a EmailChannel resource.A builder forEmailChannelReferenceAn implementation forEmailChannelReferenceA reference to a EmailTemplate resource.A builder forEmailTemplateReferenceAn implementation forEmailTemplateReferenceA reference to a EventStream resource.A builder forEventStreamReferenceAn implementation forEventStreamReferenceA reference to a GCMChannel resource.A builder forGCMChannelReferenceAn implementation forGCMChannelReference(experimental) Indicates that this resource can be referenced as a ADMChannel.Internal default implementation forIADMChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a APNSChannel.Internal default implementation forIAPNSChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a APNSSandboxChannel.Internal default implementation forIAPNSSandboxChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a APNSVoipChannel.Internal default implementation forIAPNSVoipChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a APNSVoipSandboxChannel.Internal default implementation forIAPNSVoipSandboxChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a ApplicationSettings.Internal default implementation forIApplicationSettingsRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a App.Internal default implementation forIAppRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a BaiduChannel.Internal default implementation forIBaiduChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Campaign.Internal default implementation forICampaignRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a EmailChannel.Internal default implementation forIEmailChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a EmailTemplate.Internal default implementation forIEmailTemplateRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a EventStream.Internal default implementation forIEventStreamRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a GCMChannel.Internal default implementation forIGCMChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a InAppTemplate.Internal default implementation forIInAppTemplateRef.A proxy class which represents a concrete javascript instance of this type.A reference to a InAppTemplate resource.A builder forInAppTemplateReferenceAn implementation forInAppTemplateReference(experimental) Indicates that this resource can be referenced as a PushTemplate.Internal default implementation forIPushTemplateRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Segment.Internal default implementation forISegmentRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a SMSChannel.Internal default implementation forISMSChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a SmsTemplate.Internal default implementation forISmsTemplateRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a VoiceChannel.Internal default implementation forIVoiceChannelRef.A proxy class which represents a concrete javascript instance of this type.A reference to a PushTemplate resource.A builder forPushTemplateReferenceAn implementation forPushTemplateReferenceA reference to a Segment resource.A builder forSegmentReferenceAn implementation forSegmentReferenceA reference to a SMSChannel resource.A builder forSMSChannelReferenceAn implementation forSMSChannelReferenceA reference to a SmsTemplate resource.A builder forSmsTemplateReferenceAn implementation forSmsTemplateReferenceA reference to a VoiceChannel resource.A builder forVoiceChannelReferenceAn implementation forVoiceChannelReference