/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

The settings for a custom message activity. This type of activity calls an * AWS Lambda function or web hook that sends messages to * participants.

See Also:

AWS * API Reference

*/ class CustomMessageActivity { public: AWS_PINPOINT_API CustomMessageActivity(); AWS_PINPOINT_API CustomMessageActivity(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API CustomMessageActivity& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline const Aws::String& GetDeliveryUri() const{ return m_deliveryUri; } /** *

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.

*/ inline bool DeliveryUriHasBeenSet() const { return m_deliveryUriHasBeenSet; } /** *

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.

*/ inline void SetDeliveryUri(const Aws::String& value) { m_deliveryUriHasBeenSet = true; m_deliveryUri = value; } /** *

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.

*/ inline void SetDeliveryUri(Aws::String&& value) { m_deliveryUriHasBeenSet = true; m_deliveryUri = std::move(value); } /** *

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.

*/ inline void SetDeliveryUri(const char* value) { m_deliveryUriHasBeenSet = true; m_deliveryUri.assign(value); } /** *

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.

*/ inline CustomMessageActivity& WithDeliveryUri(const Aws::String& value) { SetDeliveryUri(value); return *this;} /** *

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.

*/ inline CustomMessageActivity& WithDeliveryUri(Aws::String&& value) { SetDeliveryUri(std::move(value)); return *this;} /** *

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.

*/ inline CustomMessageActivity& WithDeliveryUri(const char* value) { SetDeliveryUri(value); return *this;} /** *

The types of endpoints to send the custom message 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.

*/ inline const Aws::Vector<__EndpointTypesElement>& GetEndpointTypes() const{ return m_endpointTypes; } /** *

The types of endpoints to send the custom message 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.

*/ inline bool EndpointTypesHasBeenSet() const { return m_endpointTypesHasBeenSet; } /** *

The types of endpoints to send the custom message 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.

*/ inline void SetEndpointTypes(const Aws::Vector<__EndpointTypesElement>& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes = value; } /** *

The types of endpoints to send the custom message 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.

*/ inline void SetEndpointTypes(Aws::Vector<__EndpointTypesElement>&& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes = std::move(value); } /** *

The types of endpoints to send the custom message 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.

*/ inline CustomMessageActivity& WithEndpointTypes(const Aws::Vector<__EndpointTypesElement>& value) { SetEndpointTypes(value); return *this;} /** *

The types of endpoints to send the custom message 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.

*/ inline CustomMessageActivity& WithEndpointTypes(Aws::Vector<__EndpointTypesElement>&& value) { SetEndpointTypes(std::move(value)); return *this;} /** *

The types of endpoints to send the custom message 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.

*/ inline CustomMessageActivity& AddEndpointTypes(const __EndpointTypesElement& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes.push_back(value); return *this; } /** *

The types of endpoints to send the custom message 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.

*/ inline CustomMessageActivity& AddEndpointTypes(__EndpointTypesElement&& value) { m_endpointTypesHasBeenSet = true; m_endpointTypes.push_back(std::move(value)); return *this; } /** *

Specifies the message data included in a custom channel message that's sent * to participants in a journey.

*/ inline const JourneyCustomMessage& GetMessageConfig() const{ return m_messageConfig; } /** *

Specifies the message data included in a custom channel message that's sent * to participants in a journey.

*/ inline bool MessageConfigHasBeenSet() const { return m_messageConfigHasBeenSet; } /** *

Specifies the message data included in a custom channel message that's sent * to participants in a journey.

*/ inline void SetMessageConfig(const JourneyCustomMessage& value) { m_messageConfigHasBeenSet = true; m_messageConfig = value; } /** *

Specifies the message data included in a custom channel message that's sent * to participants in a journey.

*/ inline void SetMessageConfig(JourneyCustomMessage&& value) { m_messageConfigHasBeenSet = true; m_messageConfig = std::move(value); } /** *

Specifies the message data included in a custom channel message that's sent * to participants in a journey.

*/ inline CustomMessageActivity& WithMessageConfig(const JourneyCustomMessage& value) { SetMessageConfig(value); return *this;} /** *

Specifies the message data included in a custom channel message that's sent * to participants in a journey.

*/ inline CustomMessageActivity& WithMessageConfig(JourneyCustomMessage&& value) { SetMessageConfig(std::move(value)); return *this;} /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline const Aws::String& GetNextActivity() const{ return m_nextActivity; } /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline bool NextActivityHasBeenSet() const { return m_nextActivityHasBeenSet; } /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline void SetNextActivity(const Aws::String& value) { m_nextActivityHasBeenSet = true; m_nextActivity = value; } /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline void SetNextActivity(Aws::String&& value) { m_nextActivityHasBeenSet = true; m_nextActivity = std::move(value); } /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline void SetNextActivity(const char* value) { m_nextActivityHasBeenSet = true; m_nextActivity.assign(value); } /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline CustomMessageActivity& WithNextActivity(const Aws::String& value) { SetNextActivity(value); return *this;} /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline CustomMessageActivity& WithNextActivity(Aws::String&& value) { SetNextActivity(std::move(value)); return *this;} /** *

The unique identifier for the next activity to perform, after Amazon Pinpoint * calls the AWS Lambda function or web hook.

*/ inline CustomMessageActivity& WithNextActivity(const char* value) { SetNextActivity(value); return *this;} /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline const Aws::String& GetTemplateName() const{ return m_templateName; } /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline bool TemplateNameHasBeenSet() const { return m_templateNameHasBeenSet; } /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline void SetTemplateName(const Aws::String& value) { m_templateNameHasBeenSet = true; m_templateName = value; } /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline void SetTemplateName(Aws::String&& value) { m_templateNameHasBeenSet = true; m_templateName = std::move(value); } /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline void SetTemplateName(const char* value) { m_templateNameHasBeenSet = true; m_templateName.assign(value); } /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline CustomMessageActivity& WithTemplateName(const Aws::String& value) { SetTemplateName(value); return *this;} /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline CustomMessageActivity& WithTemplateName(Aws::String&& value) { SetTemplateName(std::move(value)); return *this;} /** *

The name of the custom message template to use for the message. If specified, * this value must match the name of an existing message template.

*/ inline CustomMessageActivity& WithTemplateName(const char* value) { SetTemplateName(value); return *this;} /** *

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 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.

*/ inline const Aws::String& GetTemplateVersion() const{ return m_templateVersion; } /** *

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 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.

*/ inline bool TemplateVersionHasBeenSet() const { return m_templateVersionHasBeenSet; } /** *

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 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.

*/ inline void SetTemplateVersion(const Aws::String& value) { m_templateVersionHasBeenSet = true; m_templateVersion = value; } /** *

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 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.

*/ inline void SetTemplateVersion(Aws::String&& value) { m_templateVersionHasBeenSet = true; m_templateVersion = std::move(value); } /** *

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 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.

*/ inline void SetTemplateVersion(const char* value) { m_templateVersionHasBeenSet = true; m_templateVersion.assign(value); } /** *

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 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.

*/ inline CustomMessageActivity& WithTemplateVersion(const Aws::String& value) { SetTemplateVersion(value); return *this;} /** *

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 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.

*/ inline CustomMessageActivity& WithTemplateVersion(Aws::String&& value) { SetTemplateVersion(std::move(value)); return *this;} /** *

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 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.

*/ inline CustomMessageActivity& WithTemplateVersion(const char* value) { SetTemplateVersion(value); return *this;} private: Aws::String m_deliveryUri; bool m_deliveryUriHasBeenSet = false; Aws::Vector<__EndpointTypesElement> m_endpointTypes; bool m_endpointTypesHasBeenSet = false; JourneyCustomMessage m_messageConfig; bool m_messageConfigHasBeenSet = false; Aws::String m_nextActivity; bool m_nextActivityHasBeenSet = false; Aws::String m_templateName; bool m_templateNameHasBeenSet = false; Aws::String m_templateVersion; bool m_templateVersionHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws