This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Pinpoint::PushTemplate APNSPushNotificationTemplate
<a name="aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate"></a>

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.

## Syntax
<a name="aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate-syntax.json"></a>

```
{
  "[Action](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-action)" : String,
  "[Body](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-body)" : String,
  "[MediaUrl](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-mediaurl)" : String,
  "[Sound](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-sound)" : String,
  "[Title](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-title)" : String,
  "[Url](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-url)" : String
}
```

### YAML
<a name="aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate-syntax.yaml"></a>

```
  [Action](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-action): String
  [Body](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-body): String
  [MediaUrl](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-mediaurl): String
  [Sound](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-sound): String
  [Title](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-title): String
  [Url](#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-url): String
```

## Properties
<a name="aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate-properties"></a>

`Action`  <a name="cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-action"></a>
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.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Body`  <a name="cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-body"></a>
The message body to use in push notifications that are based on the message template.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MediaUrl`  <a name="cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-mediaurl"></a>
The URL of an image or video to display in push notifications that are based on the message template.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Sound`  <a name="cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-sound"></a>
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.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Title`  <a name="cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-title"></a>
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.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Url`  <a name="cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-url"></a>
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`.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)