CfnPushTemplate

class aws_cdk.aws_pinpoint.CfnPushTemplate(scope, id, *, template_name, adm=None, apns=None, baidu=None, default=None, default_substitutions=None, gcm=None, tags=None, template_description=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Pinpoint::PushTemplate.

Creates a message template that you can use in messages that are sent through a push notification channel. A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

CloudformationResource

AWS::Pinpoint::PushTemplate

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

# tags: Any

cfn_push_template = pinpoint.CfnPushTemplate(self, "MyCfnPushTemplate",
    template_name="templateName",

    # the properties below are optional
    adm=pinpoint.CfnPushTemplate.AndroidPushNotificationTemplateProperty(
        action="action",
        body="body",
        image_icon_url="imageIconUrl",
        image_url="imageUrl",
        small_image_icon_url="smallImageIconUrl",
        sound="sound",
        title="title",
        url="url"
    ),
    apns=pinpoint.CfnPushTemplate.APNSPushNotificationTemplateProperty(
        action="action",
        body="body",
        media_url="mediaUrl",
        sound="sound",
        title="title",
        url="url"
    ),
    baidu=pinpoint.CfnPushTemplate.AndroidPushNotificationTemplateProperty(
        action="action",
        body="body",
        image_icon_url="imageIconUrl",
        image_url="imageUrl",
        small_image_icon_url="smallImageIconUrl",
        sound="sound",
        title="title",
        url="url"
    ),
    default=pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty(
        action="action",
        body="body",
        sound="sound",
        title="title",
        url="url"
    ),
    default_substitutions="defaultSubstitutions",
    gcm=pinpoint.CfnPushTemplate.AndroidPushNotificationTemplateProperty(
        action="action",
        body="body",
        image_icon_url="imageIconUrl",
        image_url="imageUrl",
        small_image_icon_url="smallImageIconUrl",
        sound="sound",
        title="title",
        url="url"
    ),
    tags=tags,
    template_description="templateDescription"
)

Create a new AWS::Pinpoint::PushTemplate.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • template_name (str) – The name of the message template.

  • adm (Union[IResolvable, AndroidPushNotificationTemplateProperty, None]) – The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels ( Default ).

  • apns (Union[IResolvable, APNSPushNotificationTemplateProperty, None]) – The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels ( Default ).

  • baidu (Union[IResolvable, AndroidPushNotificationTemplateProperty, None]) – The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels ( Default ).

  • default (Union[IResolvable, DefaultPushNotificationTemplateProperty, None]) – The default message template to use for push notification channels.

  • default_substitutions (Optional[str]) – A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that’s based on the template, you can override these defaults with message-specific and address-specific variables and values.

  • gcm (Union[IResolvable, AndroidPushNotificationTemplateProperty, None]) – The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels ( Default ).

  • tags (Optional[Any]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • template_description (Optional[str]) – A custom description of the message template.

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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

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.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

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)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

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::PushTemplate'
adm

The message template to use for the ADM (Amazon Device Messaging) channel.

This message template overrides the default template for push notification channels ( Default ).

Link

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

Return type

Union[IResolvable, AndroidPushNotificationTemplateProperty, None]

apns

The message template to use for the APNs (Apple Push Notification service) channel.

This message template overrides the default template for push notification channels ( Default ).

Link

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

Return type

Union[IResolvable, APNSPushNotificationTemplateProperty, None]

attr_arn

The Amazon Resource Name (ARN) of the message template.

CloudformationAttribute

Arn

Return type

str

baidu

The message template to use for the Baidu (Baidu Cloud Push) channel.

This message template overrides the default template for push notification channels ( Default ).

Link

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

Return type

Union[IResolvable, AndroidPushNotificationTemplateProperty, 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]

default

The default message template to use for push notification channels.

Link

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

Return type

Union[IResolvable, DefaultPushNotificationTemplateProperty, None]

default_substitutions

A JSON object that specifies the default values to use for message variables in the message template.

This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that’s based on the template, you can override these defaults with message-specific and address-specific variables and values.

Link

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

Return type

Optional[str]

gcm

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

This message template overrides the default template for push notification channels ( Default ).

Link

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

Return type

Union[IResolvable, AndroidPushNotificationTemplateProperty, 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.

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

stack

The stack in which this element is defined.

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

Return type

Stack

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link

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

Return type

TagManager

template_description

A custom description of the message template.

Link

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

Return type

Optional[str]

template_name

The name of the message template.

Link

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

Return type

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

APNSPushNotificationTemplateProperty

class CfnPushTemplate.APNSPushNotificationTemplateProperty(*, action=None, body=None, media_url=None, sound=None, title=None, url=None)

Bases: object

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.

Parameters
  • action (Optional[str]) – The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are: - OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. - URL – The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

  • body (Optional[str]) – The message body to use in push notifications that are based on the message template.

  • media_url (Optional[str]) – The URL of an image or video to display in push notifications that are based on the message template.

  • sound (Optional[str]) – The key for the sound to play when the recipient receives a push notification that’s based on the message template. The value for this key is the name of a sound file in your app’s main bundle or the Library/Sounds folder in your app’s data container. If the sound file can’t be found or you specify default for the value, the system plays the default alert sound.

  • title (Optional[str]) – The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient’s device.

  • url (Optional[str]) – The URL to open in the recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

a_pNSPush_notification_template_property = pinpoint.CfnPushTemplate.APNSPushNotificationTemplateProperty(
    action="action",
    body="body",
    media_url="mediaUrl",
    sound="sound",
    title="title",
    url="url"
)

Attributes

action

The action to occur if a recipient taps a push notification that’s based on the message template.

Valid values are:

  • OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

  • URL – The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

Link

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

Return type

Optional[str]

body

The message body to use in push notifications that are based on the message template.

Link

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

Return type

Optional[str]

media_url

The URL of an image or video to display in push notifications that are based on the message template.

Link

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

Return type

Optional[str]

sound

The key for the sound to play when the recipient receives a push notification that’s based on the message template.

The value for this key is the name of a sound file in your app’s main bundle or the Library/Sounds folder in your app’s data container. If the sound file can’t be found or you specify default for the value, the system plays the default alert sound.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-sound

Return type

Optional[str]

title

The title to use in push notifications that are based on the message template.

This title appears above the notification message on a recipient’s device.

Link

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

Return type

Optional[str]

url

The URL to open in the recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL .

Link

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

Return type

Optional[str]

AndroidPushNotificationTemplateProperty

class CfnPushTemplate.AndroidPushNotificationTemplateProperty(*, action=None, body=None, image_icon_url=None, image_url=None, small_image_icon_url=None, sound=None, title=None, url=None)

Bases: object

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

Parameters
  • action (Optional[str]) – The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are: - OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK – Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. - URL – The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

  • body (Optional[str]) – The message body to use in a push notification that’s based on the message template.

  • image_icon_url (Optional[str]) – The URL of the large icon image to display in the content view of a push notification that’s based on the message template.

  • image_url (Optional[str]) – The URL of an image to display in a push notification that’s based on the message template.

  • small_image_icon_url (Optional[str]) – The URL of the small icon image to display in the status bar and the content view of a push notification that’s based on the message template.

  • sound (Optional[str]) – The sound to play when a recipient receives a push notification that’s based on the message template. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/ .

  • title (Optional[str]) – The title to use in a push notification that’s based on the message template. This title appears above the notification message on a recipient’s device.

  • url (Optional[str]) – The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

android_push_notification_template_property = pinpoint.CfnPushTemplate.AndroidPushNotificationTemplateProperty(
    action="action",
    body="body",
    image_icon_url="imageIconUrl",
    image_url="imageUrl",
    small_image_icon_url="smallImageIconUrl",
    sound="sound",
    title="title",
    url="url"
)

Attributes

action

The action to occur if a recipient taps a push notification that’s based on the message template.

Valid values are:

  • OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK – Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

  • URL – The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

Link

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

Return type

Optional[str]

body

The message body to use in a push notification that’s based on the message template.

Link

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

Return type

Optional[str]

image_icon_url

The URL of the large icon image to display in the content view of a push notification that’s based on the message template.

Link

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

Return type

Optional[str]

image_url

The URL of an image to display in a push notification that’s based on the message template.

Link

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

Return type

Optional[str]

small_image_icon_url

The URL of the small icon image to display in the status bar and the content view of a push notification that’s based on the message template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-smallimageiconurl

Return type

Optional[str]

sound

The sound to play when a recipient receives a push notification that’s based on the message template.

You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/ .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-sound

Return type

Optional[str]

title

The title to use in a push notification that’s based on the message template.

This title appears above the notification message on a recipient’s device.

Link

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

Return type

Optional[str]

url

The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL .

Link

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

Return type

Optional[str]

DefaultPushNotificationTemplateProperty

class CfnPushTemplate.DefaultPushNotificationTemplateProperty(*, action=None, body=None, sound=None, title=None, url=None)

Bases: object

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

Parameters
  • action (Optional[str]) – The action to occur if a recipient taps a push notification that’s based on the message template. Valid values are: - OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. - DEEP_LINK – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. - URL – The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

  • body (Optional[str]) – The message body to use in push notifications that are based on the message template.

  • sound (Optional[str]) – The sound to play when a recipient receives a push notification that’s based on the message template. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/ . For an iOS platform, this value is the key for the name of a sound file in your app’s main bundle or the Library/Sounds folder in your app’s data container. If the sound file can’t be found or you specify default for the value, the system plays the default alert sound.

  • title (Optional[str]) – The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient’s device.

  • url (Optional[str]) – The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

default_push_notification_template_property = pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty(
    action="action",
    body="body",
    sound="sound",
    title="title",
    url="url"
)

Attributes

action

The action to occur if a recipient taps a push notification that’s based on the message template.

Valid values are:

  • OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

  • URL – The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

Link

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

Return type

Optional[str]

body

The message body to use in push notifications that are based on the message template.

Link

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

Return type

Optional[str]

sound

The sound to play when a recipient receives a push notification that’s based on the message template.

You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/ .

For an iOS platform, this value is the key for the name of a sound file in your app’s main bundle or the Library/Sounds folder in your app’s data container. If the sound file can’t be found or you specify default for the value, the system plays the default alert sound.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-sound

Return type

Optional[str]

title

The title to use in push notifications that are based on the message template.

This title appears above the notification message on a recipient’s device.

Link

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

Return type

Optional[str]

url

The URL to open in a recipient’s default mobile browser, if a recipient taps a push notification that’s based on the message template and the value of the Action property is URL .

Link

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

Return type

Optional[str]