Class 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>",
    });
}

}

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>",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

PlatformApplication

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Sns

Assembly: Pulumi.Aws.dll

Syntax

public class PlatformApplication : CustomResource

Constructors

PlatformApplication(String, PlatformApplicationArgs, CustomResourceOptions)

Create a PlatformApplication resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
PlatformApplicationArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

The ARN of the SNS platform application

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

EventDeliveryFailureTopicArn

SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure.

Declaration

public Output<string> EventDeliveryFailureTopicArn { get; }

Property Value

Type	Description
Output<System.String>

EventEndpointCreatedTopicArn

SNS Topic triggered when a new platform endpoint is added to your platform application.

Declaration

public Output<string> EventEndpointCreatedTopicArn { get; }

Property Value

Type	Description
Output<System.String>

EventEndpointDeletedTopicArn

SNS Topic triggered when an existing platform endpoint is deleted from your platform application.

Declaration

public Output<string> EventEndpointDeletedTopicArn { get; }

Property Value

Type	Description
Output<System.String>

EventEndpointUpdatedTopicArn

SNS Topic triggered when an existing platform endpoint is changed from your platform application.

Declaration

public Output<string> EventEndpointUpdatedTopicArn { get; }

Property Value

Type	Description
Output<System.String>

FailureFeedbackRoleArn

The IAM role permitted to receive failure feedback for this application.

Declaration

public Output<string> FailureFeedbackRoleArn { get; }

Property Value

Type	Description
Output<System.String>

Name

The friendly name for the SNS platform application

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Platform

The platform that the app is registered with. See Platform for supported platforms.

Declaration

public Output<string> Platform { get; }

Property Value

Type	Description
Output<System.String>

PlatformCredential

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.

Declaration

public Output<string> PlatformCredential { get; }

Property Value

Type	Description
Output<System.String>

PlatformPrincipal

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.

Declaration

public Output<string> PlatformPrincipal { get; }

Property Value

Type	Description
Output<System.String>

SuccessFeedbackRoleArn

The IAM role permitted to receive success feedback for this application.

Declaration

public Output<string> SuccessFeedbackRoleArn { get; }

Property Value

Type	Description
Output<System.String>

SuccessFeedbackSampleRate

The percentage of success to sample (0-100)

Declaration

public Output<string> SuccessFeedbackSampleRate { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, PlatformApplicationState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
PlatformApplicationState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
PlatformApplication