CfnCampaignProps¶

class aws_cdk.aws_pinpoint.CfnCampaignProps(*, application_id, message_configuration, name, schedule, segment_id, additional_treatments=None, campaign_hook=None, description=None, holdout_percent=None, is_paused=None, limits=None, segment_version=None, tags=None, treatment_description=None, treatment_name=None)¶

Bases: object

Properties for defining a AWS::Pinpoint::Campaign.

Parameters

application_id (str) – AWS::Pinpoint::Campaign.ApplicationId.
message_configuration (Union[IResolvable, MessageConfigurationProperty]) – AWS::Pinpoint::Campaign.MessageConfiguration.
name (str) – AWS::Pinpoint::Campaign.Name.
schedule (Union[IResolvable, ScheduleProperty]) – AWS::Pinpoint::Campaign.Schedule.
segment_id (str) – AWS::Pinpoint::Campaign.SegmentId.
additional_treatments (Union[IResolvable, Sequence[Union[IResolvable, WriteTreatmentResourceProperty]], None]) – AWS::Pinpoint::Campaign.AdditionalTreatments.
campaign_hook (Union[IResolvable, CampaignHookProperty, None]) – AWS::Pinpoint::Campaign.CampaignHook.
description (Optional[str]) – AWS::Pinpoint::Campaign.Description.
holdout_percent (Union[int, float, None]) – AWS::Pinpoint::Campaign.HoldoutPercent.
is_paused (Union[bool, IResolvable, None]) – AWS::Pinpoint::Campaign.IsPaused.
limits (Union[IResolvable, LimitsProperty, None]) – AWS::Pinpoint::Campaign.Limits.
segment_version (Union[int, float, None]) – AWS::Pinpoint::Campaign.SegmentVersion.
tags (Optional[Any]) – AWS::Pinpoint::Campaign.Tags.
treatment_description (Optional[str]) – AWS::Pinpoint::Campaign.TreatmentDescription.
treatment_name (Optional[str]) – AWS::Pinpoint::Campaign.TreatmentName.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html

Attributes

additional_treatments¶

AWS::Pinpoint::Campaign.AdditionalTreatments.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-additionaltreatments
Return type: Union[IResolvable, List[Union[IResolvable, WriteTreatmentResourceProperty]], None]

application_id¶

AWS::Pinpoint::Campaign.ApplicationId.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-applicationid
Return type: str

campaign_hook¶

AWS::Pinpoint::Campaign.CampaignHook.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignhook
Return type: Union[IResolvable, CampaignHookProperty, None]

description¶

AWS::Pinpoint::Campaign.Description.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-description
Return type: Optional[str]

holdout_percent¶

AWS::Pinpoint::Campaign.HoldoutPercent.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-holdoutpercent
Return type: Union[int, float, None]

is_paused¶

AWS::Pinpoint::Campaign.IsPaused.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-ispaused
Return type: Union[bool, IResolvable, None]

limits¶

AWS::Pinpoint::Campaign.Limits.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-limits
Return type: Union[IResolvable, LimitsProperty, None]

message_configuration¶

AWS::Pinpoint::Campaign.MessageConfiguration.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-messageconfiguration
Return type: Union[IResolvable, MessageConfigurationProperty]

name¶

AWS::Pinpoint::Campaign.Name.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-name
Return type: str

schedule¶

AWS::Pinpoint::Campaign.Schedule.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule
Return type: Union[IResolvable, ScheduleProperty]

segment_id¶

AWS::Pinpoint::Campaign.SegmentId.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentid
Return type: str

segment_version¶

AWS::Pinpoint::Campaign.SegmentVersion.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentversion
Return type: Union[int, float, None]

tags¶

AWS::Pinpoint::Campaign.Tags.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-tags
Return type: Any

treatment_description¶

AWS::Pinpoint::Campaign.TreatmentDescription.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription
Return type: Optional[str]

treatment_name¶

AWS::Pinpoint::Campaign.TreatmentName.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentname
Return type: Optional[str]