CfnCampaign

class aws_cdk.aws_pinpoint.CfnCampaign(scope, id, *, 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: aws_cdk.core.CfnResource

A CloudFormation AWS::Pinpoint::Campaign.

See

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

CloudformationResource

AWS::Pinpoint::Campaign

Create a new AWS::Pinpoint::Campaign.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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, List[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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Pinpoint::Campaign'
additional_treatments

AWS::Pinpoint::Campaign.AdditionalTreatments.

See

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.

See

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

Return type

str

attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_campaign_id

CampaignId

Type

cloudformationAttribute

Return type

str

campaign_hook

AWS::Pinpoint::Campaign.CampaignHook.

See

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

Return type

Union[IResolvable, CampaignHookProperty, None]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

description

AWS::Pinpoint::Campaign.Description.

See

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.

See

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.

See

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.

See

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

Return type

Union[IResolvable, LimitsProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

message_configuration

AWS::Pinpoint::Campaign.MessageConfiguration.

See

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.

See

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

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

schedule

AWS::Pinpoint::Campaign.Schedule.

See

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.

See

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.

See

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

Return type

Union[int, float, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::Pinpoint::Campaign.Tags.

See

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

Return type

TagManager

treatment_description

AWS::Pinpoint::Campaign.TreatmentDescription.

See

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.

See

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

Return type

Optional[str]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AttributeDimensionProperty

class CfnCampaign.AttributeDimensionProperty(*, attribute_type=None, values=None)

Bases: object

Parameters
  • attribute_type (Optional[str]) – CfnCampaign.AttributeDimensionProperty.AttributeType.

  • values (Optional[List[str]]) – CfnCampaign.AttributeDimensionProperty.Values.

See

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

Attributes

attribute_type

CfnCampaign.AttributeDimensionProperty.AttributeType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-attributetype

Return type

Optional[str]

values

CfnCampaign.AttributeDimensionProperty.Values.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-values

Return type

Optional[List[str]]

CampaignEmailMessageProperty

class CfnCampaign.CampaignEmailMessageProperty(*, body=None, from_address=None, html_body=None, title=None)

Bases: object

Parameters
  • body (Optional[str]) – CfnCampaign.CampaignEmailMessageProperty.Body.

  • from_address (Optional[str]) – CfnCampaign.CampaignEmailMessageProperty.FromAddress.

  • html_body (Optional[str]) – CfnCampaign.CampaignEmailMessageProperty.HtmlBody.

  • title (Optional[str]) – CfnCampaign.CampaignEmailMessageProperty.Title.

See

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

Attributes

body

CfnCampaign.CampaignEmailMessageProperty.Body.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-body

Return type

Optional[str]

from_address

CfnCampaign.CampaignEmailMessageProperty.FromAddress.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-fromaddress

Return type

Optional[str]

html_body

CfnCampaign.CampaignEmailMessageProperty.HtmlBody.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-htmlbody

Return type

Optional[str]

title

CfnCampaign.CampaignEmailMessageProperty.Title.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-title

Return type

Optional[str]

CampaignEventFilterProperty

class CfnCampaign.CampaignEventFilterProperty(*, dimensions=None, filter_type=None)

Bases: object

Parameters
  • dimensions (Union[IResolvable, EventDimensionsProperty, None]) – CfnCampaign.CampaignEventFilterProperty.Dimensions.

  • filter_type (Optional[str]) – CfnCampaign.CampaignEventFilterProperty.FilterType.

See

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

Attributes

dimensions

CfnCampaign.CampaignEventFilterProperty.Dimensions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-dimensions

Return type

Union[IResolvable, EventDimensionsProperty, None]

filter_type

CfnCampaign.CampaignEventFilterProperty.FilterType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-filtertype

Return type

Optional[str]

CampaignHookProperty

class CfnCampaign.CampaignHookProperty(*, lambda_function_name=None, mode=None, web_url=None)

Bases: object

Parameters
  • lambda_function_name (Optional[str]) – CfnCampaign.CampaignHookProperty.LambdaFunctionName.

  • mode (Optional[str]) – CfnCampaign.CampaignHookProperty.Mode.

  • web_url (Optional[str]) – CfnCampaign.CampaignHookProperty.WebUrl.

See

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

Attributes

lambda_function_name

CfnCampaign.CampaignHookProperty.LambdaFunctionName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-lambdafunctionname

Return type

Optional[str]

mode

CfnCampaign.CampaignHookProperty.Mode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-mode

Return type

Optional[str]

web_url

CfnCampaign.CampaignHookProperty.WebUrl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-weburl

Return type

Optional[str]

CampaignSmsMessageProperty

class CfnCampaign.CampaignSmsMessageProperty(*, body=None, message_type=None, sender_id=None)

Bases: object

Parameters
  • body (Optional[str]) – CfnCampaign.CampaignSmsMessageProperty.Body.

  • message_type (Optional[str]) – CfnCampaign.CampaignSmsMessageProperty.MessageType.

  • sender_id (Optional[str]) – CfnCampaign.CampaignSmsMessageProperty.SenderId.

See

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

Attributes

body

CfnCampaign.CampaignSmsMessageProperty.Body.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-body

Return type

Optional[str]

message_type

CfnCampaign.CampaignSmsMessageProperty.MessageType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-messagetype

Return type

Optional[str]

sender_id

CfnCampaign.CampaignSmsMessageProperty.SenderId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-senderid

Return type

Optional[str]

EventDimensionsProperty

class CfnCampaign.EventDimensionsProperty(*, attributes=None, event_type=None, metrics=None)

Bases: object

Parameters
  • attributes (Optional[Any]) – CfnCampaign.EventDimensionsProperty.Attributes.

  • event_type (Union[IResolvable, SetDimensionProperty, None]) – CfnCampaign.EventDimensionsProperty.EventType.

  • metrics (Optional[Any]) – CfnCampaign.EventDimensionsProperty.Metrics.

See

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

Attributes

attributes

CfnCampaign.EventDimensionsProperty.Attributes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-attributes

Return type

Any

event_type

CfnCampaign.EventDimensionsProperty.EventType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-eventtype

Return type

Union[IResolvable, SetDimensionProperty, None]

metrics

CfnCampaign.EventDimensionsProperty.Metrics.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-metrics

Return type

Any

LimitsProperty

class CfnCampaign.LimitsProperty(*, daily=None, maximum_duration=None, messages_per_second=None, total=None)

Bases: object

Parameters
  • daily (Union[int, float, None]) – CfnCampaign.LimitsProperty.Daily.

  • maximum_duration (Union[int, float, None]) – CfnCampaign.LimitsProperty.MaximumDuration.

  • messages_per_second (Union[int, float, None]) – CfnCampaign.LimitsProperty.MessagesPerSecond.

  • total (Union[int, float, None]) – CfnCampaign.LimitsProperty.Total.

See

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

Attributes

daily

CfnCampaign.LimitsProperty.Daily.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-daily

Return type

Union[int, float, None]

maximum_duration

CfnCampaign.LimitsProperty.MaximumDuration.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-maximumduration

Return type

Union[int, float, None]

messages_per_second

CfnCampaign.LimitsProperty.MessagesPerSecond.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-messagespersecond

Return type

Union[int, float, None]

total

CfnCampaign.LimitsProperty.Total.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-total

Return type

Union[int, float, None]

MessageConfigurationProperty

class CfnCampaign.MessageConfigurationProperty(*, adm_message=None, apns_message=None, baidu_message=None, default_message=None, email_message=None, gcm_message=None, sms_message=None)

Bases: object

Parameters
See

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

Attributes

adm_message

CfnCampaign.MessageConfigurationProperty.ADMMessage.

See

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

Return type

Union[IResolvable, MessageProperty, None]

apns_message

CfnCampaign.MessageConfigurationProperty.APNSMessage.

See

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

Return type

Union[IResolvable, MessageProperty, None]

baidu_message

CfnCampaign.MessageConfigurationProperty.BaiduMessage.

See

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

Return type

Union[IResolvable, MessageProperty, None]

default_message

CfnCampaign.MessageConfigurationProperty.DefaultMessage.

See

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

Return type

Union[IResolvable, MessageProperty, None]

email_message

CfnCampaign.MessageConfigurationProperty.EmailMessage.

See

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

Return type

Union[IResolvable, CampaignEmailMessageProperty, None]

gcm_message

CfnCampaign.MessageConfigurationProperty.GCMMessage.

See

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

Return type

Union[IResolvable, MessageProperty, None]

sms_message

CfnCampaign.MessageConfigurationProperty.SMSMessage.

See

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

Return type

Union[IResolvable, CampaignSmsMessageProperty, None]

MessageProperty

class CfnCampaign.MessageProperty(*, action=None, body=None, image_icon_url=None, image_small_icon_url=None, image_url=None, json_body=None, media_url=None, raw_content=None, silent_push=None, time_to_live=None, title=None, url=None)

Bases: object

Parameters
  • action (Optional[str]) – CfnCampaign.MessageProperty.Action.

  • body (Optional[str]) – CfnCampaign.MessageProperty.Body.

  • image_icon_url (Optional[str]) – CfnCampaign.MessageProperty.ImageIconUrl.

  • image_small_icon_url (Optional[str]) – CfnCampaign.MessageProperty.ImageSmallIconUrl.

  • image_url (Optional[str]) – CfnCampaign.MessageProperty.ImageUrl.

  • json_body (Optional[str]) – CfnCampaign.MessageProperty.JsonBody.

  • media_url (Optional[str]) – CfnCampaign.MessageProperty.MediaUrl.

  • raw_content (Optional[str]) – CfnCampaign.MessageProperty.RawContent.

  • silent_push (Union[bool, IResolvable, None]) – CfnCampaign.MessageProperty.SilentPush.

  • time_to_live (Union[int, float, None]) – CfnCampaign.MessageProperty.TimeToLive.

  • title (Optional[str]) – CfnCampaign.MessageProperty.Title.

  • url (Optional[str]) – CfnCampaign.MessageProperty.Url.

See

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

Attributes

action

CfnCampaign.MessageProperty.Action.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-action

Return type

Optional[str]

body

CfnCampaign.MessageProperty.Body.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-body

Return type

Optional[str]

image_icon_url

CfnCampaign.MessageProperty.ImageIconUrl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageiconurl

Return type

Optional[str]

image_small_icon_url

CfnCampaign.MessageProperty.ImageSmallIconUrl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imagesmalliconurl

Return type

Optional[str]

image_url

CfnCampaign.MessageProperty.ImageUrl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageurl

Return type

Optional[str]

json_body

CfnCampaign.MessageProperty.JsonBody.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-jsonbody

Return type

Optional[str]

media_url

CfnCampaign.MessageProperty.MediaUrl.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-mediaurl

Return type

Optional[str]

raw_content

CfnCampaign.MessageProperty.RawContent.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-rawcontent

Return type

Optional[str]

silent_push

CfnCampaign.MessageProperty.SilentPush.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-silentpush

Return type

Union[bool, IResolvable, None]

time_to_live

CfnCampaign.MessageProperty.TimeToLive.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-timetolive

Return type

Union[int, float, None]

title

CfnCampaign.MessageProperty.Title.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-title

Return type

Optional[str]

url

CfnCampaign.MessageProperty.Url.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-url

Return type

Optional[str]

MetricDimensionProperty

class CfnCampaign.MetricDimensionProperty(*, comparison_operator=None, value=None)

Bases: object

Parameters
  • comparison_operator (Optional[str]) – CfnCampaign.MetricDimensionProperty.ComparisonOperator.

  • value (Union[int, float, None]) – CfnCampaign.MetricDimensionProperty.Value.

See

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

Attributes

comparison_operator

CfnCampaign.MetricDimensionProperty.ComparisonOperator.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-comparisonoperator

Return type

Optional[str]

value

CfnCampaign.MetricDimensionProperty.Value.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-value

Return type

Union[int, float, None]

QuietTimeProperty

class CfnCampaign.QuietTimeProperty(*, end, start)

Bases: object

Parameters
  • end (str) – CfnCampaign.QuietTimeProperty.End.

  • start (str) – CfnCampaign.QuietTimeProperty.Start.

See

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

Attributes

end

CfnCampaign.QuietTimeProperty.End.

See

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

Return type

str

start

CfnCampaign.QuietTimeProperty.Start.

See

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

Return type

str

ScheduleProperty

class CfnCampaign.ScheduleProperty(*, end_time=None, event_filter=None, frequency=None, is_local_time=None, quiet_time=None, start_time=None, time_zone=None)

Bases: object

Parameters
  • end_time (Optional[str]) – CfnCampaign.ScheduleProperty.EndTime.

  • event_filter (Union[IResolvable, CampaignEventFilterProperty, None]) – CfnCampaign.ScheduleProperty.EventFilter.

  • frequency (Optional[str]) – CfnCampaign.ScheduleProperty.Frequency.

  • is_local_time (Union[bool, IResolvable, None]) – CfnCampaign.ScheduleProperty.IsLocalTime.

  • quiet_time (Union[IResolvable, QuietTimeProperty, None]) – CfnCampaign.ScheduleProperty.QuietTime.

  • start_time (Optional[str]) – CfnCampaign.ScheduleProperty.StartTime.

  • time_zone (Optional[str]) – CfnCampaign.ScheduleProperty.TimeZone.

See

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

Attributes

end_time

CfnCampaign.ScheduleProperty.EndTime.

See

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

Return type

Optional[str]

event_filter

CfnCampaign.ScheduleProperty.EventFilter.

See

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

Return type

Union[IResolvable, CampaignEventFilterProperty, None]

frequency

CfnCampaign.ScheduleProperty.Frequency.

See

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

Return type

Optional[str]

is_local_time

CfnCampaign.ScheduleProperty.IsLocalTime.

See

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

Return type

Union[bool, IResolvable, None]

quiet_time

CfnCampaign.ScheduleProperty.QuietTime.

See

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

Return type

Union[IResolvable, QuietTimeProperty, None]

start_time

CfnCampaign.ScheduleProperty.StartTime.

See

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

Return type

Optional[str]

time_zone

CfnCampaign.ScheduleProperty.TimeZone.

See

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

Return type

Optional[str]

SetDimensionProperty

class CfnCampaign.SetDimensionProperty(*, dimension_type=None, values=None)

Bases: object

Parameters
  • dimension_type (Optional[str]) – CfnCampaign.SetDimensionProperty.DimensionType.

  • values (Optional[List[str]]) – CfnCampaign.SetDimensionProperty.Values.

See

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

Attributes

dimension_type

CfnCampaign.SetDimensionProperty.DimensionType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-dimensiontype

Return type

Optional[str]

values

CfnCampaign.SetDimensionProperty.Values.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-values

Return type

Optional[List[str]]

WriteTreatmentResourceProperty

class CfnCampaign.WriteTreatmentResourceProperty(*, message_configuration=None, schedule=None, size_percent=None, treatment_description=None, treatment_name=None)

Bases: object

Parameters
  • message_configuration (Union[IResolvable, MessageConfigurationProperty, None]) – CfnCampaign.WriteTreatmentResourceProperty.MessageConfiguration.

  • schedule (Union[IResolvable, ScheduleProperty, None]) – CfnCampaign.WriteTreatmentResourceProperty.Schedule.

  • size_percent (Union[int, float, None]) – CfnCampaign.WriteTreatmentResourceProperty.SizePercent.

  • treatment_description (Optional[str]) – CfnCampaign.WriteTreatmentResourceProperty.TreatmentDescription.

  • treatment_name (Optional[str]) – CfnCampaign.WriteTreatmentResourceProperty.TreatmentName.

See

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

Attributes

message_configuration

CfnCampaign.WriteTreatmentResourceProperty.MessageConfiguration.

See

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

Return type

Union[IResolvable, MessageConfigurationProperty, None]

schedule

CfnCampaign.WriteTreatmentResourceProperty.Schedule.

See

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

Return type

Union[IResolvable, ScheduleProperty, None]

size_percent

CfnCampaign.WriteTreatmentResourceProperty.SizePercent.

See

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

Return type

Union[int, float, None]

treatment_description

CfnCampaign.WriteTreatmentResourceProperty.TreatmentDescription.

See

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

Return type

Optional[str]

treatment_name

CfnCampaign.WriteTreatmentResourceProperty.TreatmentName.

See

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

Return type

Optional[str]