Package software.amazon.awscdk.services.pinpoint
Amazon Pinpoint Construct Library
---
AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
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.)
Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html
-
ClassDescriptionA CloudFormation
AWS::Pinpoint::ADMChannel.A fluent builder forCfnADMChannel.Properties for defining aCfnADMChannel.A builder forCfnADMChannelPropsAn implementation forCfnADMChannelPropsA CloudFormationAWS::Pinpoint::APNSChannel.A fluent builder forCfnAPNSChannel.Properties for defining aCfnAPNSChannel.A builder forCfnAPNSChannelPropsAn implementation forCfnAPNSChannelPropsA CloudFormationAWS::Pinpoint::APNSSandboxChannel.A fluent builder forCfnAPNSSandboxChannel.Properties for defining aCfnAPNSSandboxChannel.A builder forCfnAPNSSandboxChannelPropsAn implementation forCfnAPNSSandboxChannelPropsA CloudFormationAWS::Pinpoint::APNSVoipChannel.A fluent builder forCfnAPNSVoipChannel.Properties for defining aCfnAPNSVoipChannel.A builder forCfnAPNSVoipChannelPropsAn implementation forCfnAPNSVoipChannelPropsA CloudFormationAWS::Pinpoint::APNSVoipSandboxChannel.A fluent builder forCfnAPNSVoipSandboxChannel.Properties for defining aCfnAPNSVoipSandboxChannel.A builder forCfnAPNSVoipSandboxChannelPropsAn implementation forCfnAPNSVoipSandboxChannelPropsA CloudFormationAWS::Pinpoint::App.A fluent builder forCfnApp.A CloudFormationAWS::Pinpoint::ApplicationSettings.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 CloudFormationAWS::Pinpoint::BaiduChannel.A fluent builder forCfnBaiduChannel.Properties for defining aCfnBaiduChannel.A builder forCfnBaiduChannelPropsAn implementation forCfnBaiduChannelPropsA CloudFormationAWS::Pinpoint::Campaign.Specifies attribute-based criteria for including or excluding endpoints from a segment.A builder forCfnCampaign.AttributeDimensionPropertyAn implementation forCfnCampaign.AttributeDimensionPropertyA fluent builder forCfnCampaign.Example: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.CampaignSmsMessagePropertyExample: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.MessagePropertySpecifies metric-based criteria for including or excluding endpoints from a segment.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.SetDimensionPropertyExample:A builder forCfnCampaign.TemplateConfigurationPropertyAn implementation forCfnCampaign.TemplateConfigurationPropertyExample: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 CloudFormationAWS::Pinpoint::EmailChannel.A fluent builder forCfnEmailChannel.Properties for defining aCfnEmailChannel.A builder forCfnEmailChannelPropsAn implementation forCfnEmailChannelPropsA CloudFormationAWS::Pinpoint::EmailTemplate.A fluent builder forCfnEmailTemplate.Properties for defining aCfnEmailTemplate.A builder forCfnEmailTemplatePropsAn implementation forCfnEmailTemplatePropsA CloudFormationAWS::Pinpoint::EventStream.A fluent builder forCfnEventStream.Properties for defining aCfnEventStream.A builder forCfnEventStreamPropsAn implementation forCfnEventStreamPropsA CloudFormationAWS::Pinpoint::GCMChannel.A fluent builder forCfnGCMChannel.Properties for defining aCfnGCMChannel.A builder forCfnGCMChannelPropsAn implementation forCfnGCMChannelPropsA CloudFormationAWS::Pinpoint::InAppTemplate.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 forCfnInAppTemplatePropsA CloudFormationAWS::Pinpoint::PushTemplate.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 forCfnPushTemplatePropsA CloudFormationAWS::Pinpoint::Segment.Specifies attribute-based criteria for including or excluding endpoints from a segment.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 CloudFormationAWS::Pinpoint::SMSChannel.A fluent builder forCfnSMSChannel.Properties for defining aCfnSMSChannel.A builder forCfnSMSChannelPropsAn implementation forCfnSMSChannelPropsA CloudFormationAWS::Pinpoint::SmsTemplate.A fluent builder forCfnSmsTemplate.Properties for defining aCfnSmsTemplate.A builder forCfnSmsTemplatePropsAn implementation forCfnSmsTemplatePropsA CloudFormationAWS::Pinpoint::VoiceChannel.A fluent builder forCfnVoiceChannel.Properties for defining aCfnVoiceChannel.A builder forCfnVoiceChannelPropsAn implementation forCfnVoiceChannelProps