PlatformApplication

Provides an SNS platform application resource

Example Usage

Apple Push Notification Service (APNS)

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var apnsApplication = new Aws.Sns.PlatformApplication("apnsApplication", new Aws.Sns.PlatformApplicationArgs
        {
            Platform = "APNS",
            PlatformCredential = "<APNS PRIVATE KEY>",
            PlatformPrincipal = "<APNS CERTIFICATE>",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/sns"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := sns.NewPlatformApplication(ctx, "apnsApplication", &sns.PlatformApplicationArgs{
            Platform:           pulumi.String("APNS"),
            PlatformCredential: pulumi.String("<APNS PRIVATE KEY>"),
            PlatformPrincipal:  pulumi.String("<APNS CERTIFICATE>"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

apns_application = aws.sns.PlatformApplication("apnsApplication",
    platform="APNS",
    platform_credential="<APNS PRIVATE KEY>",
    platform_principal="<APNS CERTIFICATE>")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const apnsApplication = new aws.sns.PlatformApplication("apns_application", {
    platform: "APNS",
    platformCredential: "<APNS PRIVATE KEY>",
    platformPrincipal: "<APNS CERTIFICATE>",
});

Google Cloud Messaging (GCM)

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var gcmApplication = new Aws.Sns.PlatformApplication("gcmApplication", new Aws.Sns.PlatformApplicationArgs
        {
            Platform = "GCM",
            PlatformCredential = "<GCM API KEY>",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/sns"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := sns.NewPlatformApplication(ctx, "gcmApplication", &sns.PlatformApplicationArgs{
            Platform:           pulumi.String("GCM"),
            PlatformCredential: pulumi.String("<GCM API KEY>"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

gcm_application = aws.sns.PlatformApplication("gcmApplication",
    platform="GCM",
    platform_credential="<GCM API KEY>")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const gcmApplication = new aws.sns.PlatformApplication("gcm_application", {
    platform: "GCM",
    platformCredential: "<GCM API KEY>",
});

Create a PlatformApplication Resource

new PlatformApplication(name: string, args: PlatformApplicationArgs, opts?: CustomResourceOptions);

def PlatformApplication(resource_name, opts=None, event_delivery_failure_topic_arn=None, event_endpoint_created_topic_arn=None, event_endpoint_deleted_topic_arn=None, event_endpoint_updated_topic_arn=None, failure_feedback_role_arn=None, name=None, platform=None, platform_credential=None, platform_principal=None, success_feedback_role_arn=None, success_feedback_sample_rate=None, __props__=None);

func NewPlatformApplication(ctx *Context, name string, args PlatformApplicationArgs, opts ...ResourceOption) (*PlatformApplication, error)

public PlatformApplication(string name, PlatformApplicationArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args PlatformApplicationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PlatformApplicationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PlatformApplicationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

PlatformApplication Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The PlatformApplication resource accepts the following input properties:

Platform string: The platform that the app is registered with. See Platform for supported platforms.
PlatformCredential string: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
EventDeliveryFailureTopicArn string: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
EventEndpointCreatedTopicArn string: SNS Topic triggered when a new platform endpoint is added to your platform application.
EventEndpointDeletedTopicArn string: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
EventEndpointUpdatedTopicArn string: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
FailureFeedbackRoleArn string: The IAM role permitted to receive failure feedback for this application.
Name string: The friendly name for the SNS platform application
PlatformPrincipal string: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
SuccessFeedbackRoleArn string: The IAM role permitted to receive success feedback for this application.
SuccessFeedbackSampleRate string: The percentage of success to sample (0-100)

Platform string: The platform that the app is registered with. See Platform for supported platforms.
PlatformCredential string: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
EventDeliveryFailureTopicArn string: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
EventEndpointCreatedTopicArn string: SNS Topic triggered when a new platform endpoint is added to your platform application.
EventEndpointDeletedTopicArn string: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
EventEndpointUpdatedTopicArn string: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
FailureFeedbackRoleArn string: The IAM role permitted to receive failure feedback for this application.
Name string: The friendly name for the SNS platform application
PlatformPrincipal string: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
SuccessFeedbackRoleArn string: The IAM role permitted to receive success feedback for this application.
SuccessFeedbackSampleRate string: The percentage of success to sample (0-100)

platform string: The platform that the app is registered with. See Platform for supported platforms.
platformCredential string: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
eventDeliveryFailureTopicArn string: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
eventEndpointCreatedTopicArn string: SNS Topic triggered when a new platform endpoint is added to your platform application.
eventEndpointDeletedTopicArn string: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
eventEndpointUpdatedTopicArn string: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
failureFeedbackRoleArn string: The IAM role permitted to receive failure feedback for this application.
name string: The friendly name for the SNS platform application
platformPrincipal string: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
successFeedbackRoleArn string: The IAM role permitted to receive success feedback for this application.
successFeedbackSampleRate string: The percentage of success to sample (0-100)

platform str: The platform that the app is registered with. See Platform for supported platforms.
platform_credential str: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
event_delivery_failure_topic_arn str: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
event_endpoint_created_topic_arn str: SNS Topic triggered when a new platform endpoint is added to your platform application.
event_endpoint_deleted_topic_arn str: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
event_endpoint_updated_topic_arn str: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
failure_feedback_role_arn str: The IAM role permitted to receive failure feedback for this application.
name str: The friendly name for the SNS platform application
platform_principal str: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
success_feedback_role_arn str: The IAM role permitted to receive success feedback for this application.
success_feedback_sample_rate str: The percentage of success to sample (0-100)

Outputs

All input properties are implicitly available as output properties. Additionally, the PlatformApplication resource produces the following output properties:

Arn string: The ARN of the SNS platform application
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The ARN of the SNS platform application
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the SNS platform application
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the SNS platform application
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing PlatformApplication Resource

Get an existing PlatformApplication resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PlatformApplicationState, opts?: CustomResourceOptions): PlatformApplication

static get(resource_name, id, opts=None, arn=None, event_delivery_failure_topic_arn=None, event_endpoint_created_topic_arn=None, event_endpoint_deleted_topic_arn=None, event_endpoint_updated_topic_arn=None, failure_feedback_role_arn=None, name=None, platform=None, platform_credential=None, platform_principal=None, success_feedback_role_arn=None, success_feedback_sample_rate=None, __props__=None);

func GetPlatformApplication(ctx *Context, name string, id IDInput, state *PlatformApplicationState, opts ...ResourceOption) (*PlatformApplication, error)

public static PlatformApplication Get(string name, Input<string> id, PlatformApplicationState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The ARN of the SNS platform application
EventDeliveryFailureTopicArn string: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
EventEndpointCreatedTopicArn string: SNS Topic triggered when a new platform endpoint is added to your platform application.
EventEndpointDeletedTopicArn string: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
EventEndpointUpdatedTopicArn string: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
FailureFeedbackRoleArn string: The IAM role permitted to receive failure feedback for this application.
Name string: The friendly name for the SNS platform application
Platform string: The platform that the app is registered with. See Platform for supported platforms.
PlatformCredential string: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
PlatformPrincipal string: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
SuccessFeedbackRoleArn string: The IAM role permitted to receive success feedback for this application.
SuccessFeedbackSampleRate string: The percentage of success to sample (0-100)

Arn string: The ARN of the SNS platform application
EventDeliveryFailureTopicArn string: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
EventEndpointCreatedTopicArn string: SNS Topic triggered when a new platform endpoint is added to your platform application.
EventEndpointDeletedTopicArn string: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
EventEndpointUpdatedTopicArn string: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
FailureFeedbackRoleArn string: The IAM role permitted to receive failure feedback for this application.
Name string: The friendly name for the SNS platform application
Platform string: The platform that the app is registered with. See Platform for supported platforms.
PlatformCredential string: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
PlatformPrincipal string: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
SuccessFeedbackRoleArn string: The IAM role permitted to receive success feedback for this application.
SuccessFeedbackSampleRate string: The percentage of success to sample (0-100)

arn string: The ARN of the SNS platform application
eventDeliveryFailureTopicArn string: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
eventEndpointCreatedTopicArn string: SNS Topic triggered when a new platform endpoint is added to your platform application.
eventEndpointDeletedTopicArn string: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
eventEndpointUpdatedTopicArn string: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
failureFeedbackRoleArn string: The IAM role permitted to receive failure feedback for this application.
name string: The friendly name for the SNS platform application
platform string: The platform that the app is registered with. See Platform for supported platforms.
platformCredential string: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
platformPrincipal string: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
successFeedbackRoleArn string: The IAM role permitted to receive success feedback for this application.
successFeedbackSampleRate string: The percentage of success to sample (0-100)

arn str: The ARN of the SNS platform application
event_delivery_failure_topic_arn str: SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.
event_endpoint_created_topic_arn str: SNS Topic triggered when a new platform endpoint is added to your platform application.
event_endpoint_deleted_topic_arn str: SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
event_endpoint_updated_topic_arn str: SNS Topic triggered when an existing platform endpoint is changed from your platform application.
failure_feedback_role_arn str: The IAM role permitted to receive failure feedback for this application.
name str: The friendly name for the SNS platform application
platform str: The platform that the app is registered with. See Platform for supported platforms.
platform_credential str: Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
platform_principal str: Application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources.
success_feedback_role_arn str: The IAM role permitted to receive success feedback for this application.
success_feedback_sample_rate str: The percentage of success to sample (0-100)

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud