Interface CfnCampaign.IWriteTreatmentResourceProperty

Specifies the settings for a campaign treatment.

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IWriteTreatmentResourceProperty

Syntax (vb)

Public Interface IWriteTreatmentResourceProperty

Remarks

A treatment is a variation of a campaign that's used for A/B testing of a campaign.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var attributes;
var customConfig;
var metrics;

var writeTreatmentResourceProperty = new WriteTreatmentResourceProperty {
    CustomDeliveryConfiguration = new CustomDeliveryConfigurationProperty {
        DeliveryUri = "deliveryUri",
        EndpointTypes = new [] { "endpointTypes" }
    },
    MessageConfiguration = new MessageConfigurationProperty {
        AdmMessage = new MessageProperty {
            Action = "action",
            Body = "body",
            ImageIconUrl = "imageIconUrl",
            ImageSmallIconUrl = "imageSmallIconUrl",
            ImageUrl = "imageUrl",
            JsonBody = "jsonBody",
            MediaUrl = "mediaUrl",
            RawContent = "rawContent",
            SilentPush = false,
            TimeToLive = 123,
            Title = "title",
            Url = "url"
        },
        ApnsMessage = new MessageProperty {
            Action = "action",
            Body = "body",
            ImageIconUrl = "imageIconUrl",
            ImageSmallIconUrl = "imageSmallIconUrl",
            ImageUrl = "imageUrl",
            JsonBody = "jsonBody",
            MediaUrl = "mediaUrl",
            RawContent = "rawContent",
            SilentPush = false,
            TimeToLive = 123,
            Title = "title",
            Url = "url"
        },
        BaiduMessage = new MessageProperty {
            Action = "action",
            Body = "body",
            ImageIconUrl = "imageIconUrl",
            ImageSmallIconUrl = "imageSmallIconUrl",
            ImageUrl = "imageUrl",
            JsonBody = "jsonBody",
            MediaUrl = "mediaUrl",
            RawContent = "rawContent",
            SilentPush = false,
            TimeToLive = 123,
            Title = "title",
            Url = "url"
        },
        CustomMessage = new CampaignCustomMessageProperty {
            Data = "data"
        },
        DefaultMessage = new MessageProperty {
            Action = "action",
            Body = "body",
            ImageIconUrl = "imageIconUrl",
            ImageSmallIconUrl = "imageSmallIconUrl",
            ImageUrl = "imageUrl",
            JsonBody = "jsonBody",
            MediaUrl = "mediaUrl",
            RawContent = "rawContent",
            SilentPush = false,
            TimeToLive = 123,
            Title = "title",
            Url = "url"
        },
        EmailMessage = new CampaignEmailMessageProperty {
            Body = "body",
            FromAddress = "fromAddress",
            HtmlBody = "htmlBody",
            Title = "title"
        },
        GcmMessage = new MessageProperty {
            Action = "action",
            Body = "body",
            ImageIconUrl = "imageIconUrl",
            ImageSmallIconUrl = "imageSmallIconUrl",
            ImageUrl = "imageUrl",
            JsonBody = "jsonBody",
            MediaUrl = "mediaUrl",
            RawContent = "rawContent",
            SilentPush = false,
            TimeToLive = 123,
            Title = "title",
            Url = "url"
        },
        InAppMessage = new CampaignInAppMessageProperty {
            Content = new [] { new InAppMessageContentProperty {
                BackgroundColor = "backgroundColor",
                BodyConfig = new InAppMessageBodyConfigProperty {
                    Alignment = "alignment",
                    Body = "body",
                    TextColor = "textColor"
                },
                HeaderConfig = new InAppMessageHeaderConfigProperty {
                    Alignment = "alignment",
                    Header = "header",
                    TextColor = "textColor"
                },
                ImageUrl = "imageUrl",
                PrimaryBtn = new InAppMessageButtonProperty {
                    Android = new OverrideButtonConfigurationProperty {
                        ButtonAction = "buttonAction",
                        Link = "link"
                    },
                    DefaultConfig = new DefaultButtonConfigurationProperty {
                        BackgroundColor = "backgroundColor",
                        BorderRadius = 123,
                        ButtonAction = "buttonAction",
                        Link = "link",
                        Text = "text",
                        TextColor = "textColor"
                    },
                    Ios = new OverrideButtonConfigurationProperty {
                        ButtonAction = "buttonAction",
                        Link = "link"
                    },
                    Web = new OverrideButtonConfigurationProperty {
                        ButtonAction = "buttonAction",
                        Link = "link"
                    }
                },
                SecondaryBtn = new InAppMessageButtonProperty {
                    Android = new OverrideButtonConfigurationProperty {
                        ButtonAction = "buttonAction",
                        Link = "link"
                    },
                    DefaultConfig = new DefaultButtonConfigurationProperty {
                        BackgroundColor = "backgroundColor",
                        BorderRadius = 123,
                        ButtonAction = "buttonAction",
                        Link = "link",
                        Text = "text",
                        TextColor = "textColor"
                    },
                    Ios = new OverrideButtonConfigurationProperty {
                        ButtonAction = "buttonAction",
                        Link = "link"
                    },
                    Web = new OverrideButtonConfigurationProperty {
                        ButtonAction = "buttonAction",
                        Link = "link"
                    }
                }
            } },
            CustomConfig = customConfig,
            Layout = "layout"
        },
        SmsMessage = new CampaignSmsMessageProperty {
            Body = "body",
            EntityId = "entityId",
            MessageType = "messageType",
            OriginationNumber = "originationNumber",
            SenderId = "senderId",
            TemplateId = "templateId"
        }
    },
    Schedule = new ScheduleProperty {
        EndTime = "endTime",
        EventFilter = new CampaignEventFilterProperty {
            Dimensions = new EventDimensionsProperty {
                Attributes = attributes,
                EventType = new SetDimensionProperty {
                    DimensionType = "dimensionType",
                    Values = new [] { "values" }
                },
                Metrics = metrics
            },
            FilterType = "filterType"
        },
        Frequency = "frequency",
        IsLocalTime = false,
        QuietTime = new QuietTimeProperty {
            End = "end",
            Start = "start"
        },
        StartTime = "startTime",
        TimeZone = "timeZone"
    },
    SizePercent = 123,
    TemplateConfiguration = new TemplateConfigurationProperty {
        EmailTemplate = new TemplateProperty {
            Name = "name",
            Version = "version"
        },
        PushTemplate = new TemplateProperty {
            Name = "name",
            Version = "version"
        },
        SmsTemplate = new TemplateProperty {
            Name = "name",
            Version = "version"
        },
        VoiceTemplate = new TemplateProperty {
            Name = "name",
            Version = "version"
        }
    },
    TreatmentDescription = "treatmentDescription",
    TreatmentName = "treatmentName"
};

Synopsis

Properties

CustomDeliveryConfiguration	The delivery configuration settings for sending the treatment through a custom channel.
MessageConfiguration	The message configuration settings for the treatment.
Schedule	The schedule settings for the treatment.
SizePercent	The allocated percentage of users (segment members) to send the treatment to.
TemplateConfiguration	The message template to use for the treatment.
TreatmentDescription	A custom description of the treatment.
TreatmentName	A custom name for the treatment.

Properties

CustomDeliveryConfiguration

The delivery configuration settings for sending the treatment through a custom channel.

virtual object CustomDeliveryConfiguration { get; }

Property Value

System.Object

Remarks

This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration

MessageConfiguration

The message configuration settings for the treatment.

virtual object MessageConfiguration { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration

Schedule

The schedule settings for the treatment.

virtual object Schedule { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-schedule

SizePercent

The allocated percentage of users (segment members) to send the treatment to.

virtual Nullable<double> SizePercent { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-sizepercent

TemplateConfiguration

The message template to use for the treatment.

virtual object TemplateConfiguration { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration

TreatmentDescription

A custom description of the treatment.

virtual string TreatmentDescription { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription

TreatmentName

A custom name for the treatment.

virtual string TreatmentName { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentname