aws-cdk-lib 2.75.1__py3-none-any.whl → 2.76.0__py3-none-any.whl

aws_cdk/aws_pinpoint/__init__.py

@@ -3886,7 +3886,7 @@ class CfnCampaign(
         :param segment_id: The unique identifier for the segment to associate with the campaign.
         :param additional_treatments: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
         :param campaign_hook: Specifies the Lambda function to use as a code hook for a campaign.
-        :param custom_delivery_configuration: The delivery configuration settings for sending the treatment through a custom channel. This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
+        :param custom_delivery_configuration: ``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
         :param description: A custom description of the campaign.
         :param holdout_percent: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
         :param is_paused: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to ``false`` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.
@@ -3895,7 +3895,7 @@ class CfnCampaign(
         :param priority: An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest. If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
         :param segment_version: The version of the segment to associate with the campaign.
         :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
-        :param template_configuration: The message template to use for the treatment.
+        :param template_configuration: ``AWS::Pinpoint::Campaign.TemplateConfiguration``.
         :param treatment_description: A custom description of the default treatment for the campaign.
         :param treatment_name: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A *treatment* is a variation of a campaign that's used for A/B testing.
         '''
@@ -4106,9 +4106,7 @@ class CfnCampaign(
     def custom_delivery_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.CustomDeliveryConfigurationProperty"]]:
-        '''The delivery configuration settings for sending the treatment through a custom channel.
-
-        This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
+        '''``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration
         '''
@@ -4260,7 +4258,7 @@ class CfnCampaign(
     def template_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateConfigurationProperty"]]:
-        '''The message template to use for the treatment.
+        '''``AWS::Pinpoint::Campaign.TemplateConfiguration``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration
         '''
@@ -4397,9 +4395,8 @@ class CfnCampaign(
     )
     class CampaignCustomMessageProperty:
         def __init__(self, *, data: typing.Optional[builtins.str] = None) -> None:
-            '''Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
-
-            :param data: The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
+            '''
+            :param data: ``CfnCampaign.CampaignCustomMessageProperty.Data``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html
             :exampleMetadata: fixture=_generated
@@ -4423,9 +4420,7 @@ class CfnCampaign(
 
         @builtins.property
         def data(self) -> typing.Optional[builtins.str]:
-            '''The raw, JSON-formatted string to use as the payload for the message.
-
-            The maximum size is 5 KB.
+            '''``CfnCampaign.CampaignCustomMessageProperty.Data``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html#cfn-pinpoint-campaign-campaigncustommessage-data
             '''
@@ -5041,12 +5036,9 @@ class CfnCampaign(
             delivery_uri: typing.Optional[builtins.str] = None,
             endpoint_types: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel.
-
-            This object is required if you use the ``CampaignCustomMessage`` object to define the message to send for the campaign or campaign treatment.
-
-            :param delivery_uri: The destination to send the campaign or treatment to. This value can be one of the following:. - The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment. - The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
-            :param endpoint_types: The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ``ChannelType`` property of an endpoint.
+            '''
+            :param delivery_uri: ``CfnCampaign.CustomDeliveryConfigurationProperty.DeliveryUri``.
+            :param endpoint_types: ``CfnCampaign.CustomDeliveryConfigurationProperty.EndpointTypes``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -5074,10 +5066,7 @@ class CfnCampaign(
 
         @builtins.property
         def delivery_uri(self) -> typing.Optional[builtins.str]:
-            '''The destination to send the campaign or treatment to. This value can be one of the following:.
-
-            - The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
-            - The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
+            '''``CfnCampaign.CustomDeliveryConfigurationProperty.DeliveryUri``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-deliveryuri
             '''
@@ -5086,9 +5075,7 @@ class CfnCampaign(
 
         @builtins.property
         def endpoint_types(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''The types of endpoints to send the campaign or treatment to.
-
-            Each valid value maps to a type of channel that you can associate with an endpoint by using the ``ChannelType`` property of an endpoint.
+            '''``CfnCampaign.CustomDeliveryConfigurationProperty.EndpointTypes``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-endpointtypes
             '''
@@ -6023,7 +6010,7 @@ class CfnCampaign(
             :param adm_message: The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
             :param apns_message: The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
             :param baidu_message: The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
-            :param custom_message: The message that the campaign sends through a custom channel, as specified by the delivery configuration ( ``CustomDeliveryConfiguration`` ) settings for the campaign. If specified, this message overrides the default message.
+            :param custom_message: ``CfnCampaign.MessageConfigurationProperty.CustomMessage``.
             :param default_message: The default message that the campaign sends through all the channels that are configured for the campaign.
             :param email_message: The message that the campaign sends through the email channel. If specified, this message overrides the default message.
             :param gcm_message: The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
@@ -6267,9 +6254,7 @@ class CfnCampaign(
         def custom_message(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.CampaignCustomMessageProperty"]]:
-            '''The message that the campaign sends through a custom channel, as specified by the delivery configuration ( ``CustomDeliveryConfiguration`` ) settings for the campaign.
-
-            If specified, this message overrides the default message.
+            '''``CfnCampaign.MessageConfigurationProperty.CustomMessage``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-custommessage
             '''
@@ -7101,12 +7086,11 @@ class CfnCampaign(
             sms_template: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.TemplateProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
             voice_template: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.TemplateProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
         ) -> None:
-            '''Specifies the message template to use for the message, for each type of channel.
-
-            :param email_template: The email template to use for the message.
-            :param push_template: The push notification template to use for the message.
-            :param sms_template: The SMS template to use for the message.
-            :param voice_template: The voice template to use for the message. This object isn't supported for campaigns.
+            '''
+            :param email_template: ``CfnCampaign.TemplateConfigurationProperty.EmailTemplate``.
+            :param push_template: ``CfnCampaign.TemplateConfigurationProperty.PushTemplate``.
+            :param sms_template: ``CfnCampaign.TemplateConfigurationProperty.SMSTemplate``.
+            :param voice_template: ``CfnCampaign.TemplateConfigurationProperty.VoiceTemplate``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -7156,7 +7140,7 @@ class CfnCampaign(
         def email_template(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
-            '''The email template to use for the message.
+            '''``CfnCampaign.TemplateConfigurationProperty.EmailTemplate``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-emailtemplate
             '''
@@ -7167,7 +7151,7 @@ class CfnCampaign(
         def push_template(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
-            '''The push notification template to use for the message.
+            '''``CfnCampaign.TemplateConfigurationProperty.PushTemplate``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-pushtemplate
             '''
@@ -7178,7 +7162,7 @@ class CfnCampaign(
         def sms_template(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
-            '''The SMS template to use for the message.
+            '''``CfnCampaign.TemplateConfigurationProperty.SMSTemplate``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-smstemplate
             '''
@@ -7189,9 +7173,7 @@ class CfnCampaign(
         def voice_template(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
-            '''The voice template to use for the message.
-
-            This object isn't supported for campaigns.
+            '''``CfnCampaign.TemplateConfigurationProperty.VoiceTemplate``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-voicetemplate
             '''
@@ -7221,10 +7203,9 @@ class CfnCampaign(
             name: typing.Optional[builtins.str] = None,
             version: typing.Optional[builtins.str] = None,
         ) -> None:
-            '''Specifies the name and version of the message template to use for the message.
-
-            :param name: The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
-            :param version: The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the `Template Versions <https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html>`_ resource. If you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
+            '''
+            :param name: ``CfnCampaign.TemplateProperty.Name``.
+            :param version: ``CfnCampaign.TemplateProperty.Version``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html
             :exampleMetadata: fixture=_generated
@@ -7252,9 +7233,7 @@ class CfnCampaign(
 
         @builtins.property
         def name(self) -> typing.Optional[builtins.str]:
-            '''The name of the message template to use for the message.
-
-            If specified, this value must match the name of an existing message template.
+            '''``CfnCampaign.TemplateProperty.Name``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-name
             '''
@@ -7263,11 +7242,7 @@ class CfnCampaign(
 
         @builtins.property
         def version(self) -> typing.Optional[builtins.str]:
-            '''The unique identifier for the version of the message template to use for the message.
-
-            If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the `Template Versions <https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html>`_ resource.
-
-            If you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
+            '''``CfnCampaign.TemplateProperty.Version``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-version
             '''
@@ -7314,11 +7289,11 @@ class CfnCampaign(
 
             A *treatment* is a variation of a campaign that's used for A/B testing of a campaign.
 
-            :param custom_delivery_configuration: The delivery configuration settings for sending the treatment through a custom channel. This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
+            :param custom_delivery_configuration: ``CfnCampaign.WriteTreatmentResourceProperty.CustomDeliveryConfiguration``.
             :param message_configuration: The message configuration settings for the treatment.
             :param schedule: The schedule settings for the treatment.
             :param size_percent: The allocated percentage of users (segment members) to send the treatment to.
-            :param template_configuration: The message template to use for the treatment.
+            :param template_configuration: ``CfnCampaign.WriteTreatmentResourceProperty.TemplateConfiguration``.
             :param treatment_description: A custom description of the treatment.
             :param treatment_name: A custom name for the treatment.
 
@@ -7565,9 +7540,7 @@ class CfnCampaign(
         def custom_delivery_configuration(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.CustomDeliveryConfigurationProperty"]]:
-            '''The delivery configuration settings for sending the treatment through a custom channel.
-
-            This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
+            '''``CfnCampaign.WriteTreatmentResourceProperty.CustomDeliveryConfiguration``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration
             '''
@@ -7609,7 +7582,7 @@ class CfnCampaign(
         def template_configuration(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateConfigurationProperty"]]:
-            '''The message template to use for the treatment.
+            '''``CfnCampaign.WriteTreatmentResourceProperty.TemplateConfiguration``.
 
             :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration
             '''
@@ -7701,7 +7674,7 @@ class CfnCampaignProps:
         :param segment_id: The unique identifier for the segment to associate with the campaign.
         :param additional_treatments: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
         :param campaign_hook: Specifies the Lambda function to use as a code hook for a campaign.
-        :param custom_delivery_configuration: The delivery configuration settings for sending the treatment through a custom channel. This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
+        :param custom_delivery_configuration: ``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
         :param description: A custom description of the campaign.
         :param holdout_percent: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
         :param is_paused: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to ``false`` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.
@@ -7710,7 +7683,7 @@ class CfnCampaignProps:
         :param priority: An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest. If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
         :param segment_version: The version of the segment to associate with the campaign.
         :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
-        :param template_configuration: The message template to use for the treatment.
+        :param template_configuration: ``AWS::Pinpoint::Campaign.TemplateConfiguration``.
         :param treatment_description: A custom description of the default treatment for the campaign.
         :param treatment_name: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A *treatment* is a variation of a campaign that's used for A/B testing.
 
@@ -8274,9 +8247,7 @@ class CfnCampaignProps:
     def custom_delivery_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnCampaign.CustomDeliveryConfigurationProperty]]:
-        '''The delivery configuration settings for sending the treatment through a custom channel.
-
-        This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
+        '''``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration
         '''
@@ -8371,7 +8342,7 @@ class CfnCampaignProps:
     def template_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnCampaign.TemplateConfigurationProperty]]:
-        '''The message template to use for the treatment.
+        '''``AWS::Pinpoint::Campaign.TemplateConfiguration``.
 
         :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration
         '''