pulumi-aws-kotlin/com.pulumi.aws.sns.kotlin/PlatformApplicationArgs

PlatformApplicationArgs

data class PlatformApplicationArgs(val applePlatformBundleId: Output<String>? = null, val applePlatformTeamId: Output<String>? = null, val eventDeliveryFailureTopicArn: Output<String>? = null, val eventEndpointCreatedTopicArn: Output<String>? = null, val eventEndpointDeletedTopicArn: Output<String>? = null, val eventEndpointUpdatedTopicArn: Output<String>? = null, val failureFeedbackRoleArn: Output<String>? = null, val name: Output<String>? = null, val platform: Output<String>? = null, val platformCredential: Output<String>? = null, val platformPrincipal: Output<String>? = null, val successFeedbackRoleArn: Output<String>? = null, val successFeedbackSampleRate: Output<String>? = null) : ConvertibleToJava<PlatformApplicationArgs>

Provides an SNS platform application resource

Example Usage

Apple Push Notification Service (APNS) using certificate-based authentication

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.PlatformApplication;
import com.pulumi.aws.sns.PlatformApplicationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var apnsApplication = new PlatformApplication("apnsApplication", PlatformApplicationArgs.builder()
            .platform("APNS")
            .platformCredential("<APNS PRIVATE KEY>")
            .platformPrincipal("<APNS CERTIFICATE>")
            .build());
    }
}

Apple Push Notification Service (APNS) using token-based authentication

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.PlatformApplication;
import com.pulumi.aws.sns.PlatformApplicationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var apnsApplication = new PlatformApplication("apnsApplication", PlatformApplicationArgs.builder()
            .applePlatformBundleId("<APPLE BUNDLE ID>")
            .applePlatformTeamId("<APPLE TEAM ID>")
            .platform("APNS")
            .platformCredential("<APNS SIGNING KEY>")
            .platformPrincipal("<APNS SIGNING KEY ID>")
            .build());
    }
}

Google Cloud Messaging (GCM)

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.PlatformApplication;
import com.pulumi.aws.sns.PlatformApplicationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var gcmApplication = new PlatformApplication("gcmApplication", PlatformApplicationArgs.builder()
            .platform("GCM")
            .platformCredential("<GCM API KEY>")
            .build());
    }
}

Import

SNS platform applications can be imported using the ARN, e.g.,

$ pulumi import aws:sns/platformApplication:PlatformApplication gcm_application arn:aws:sns:us-west-2:0123456789012:app/GCM/gcm_application

Constructors

PlatformApplicationArgs

constructor(applePlatformBundleId: Output<String>? = null, applePlatformTeamId: Output<String>? = null, eventDeliveryFailureTopicArn: Output<String>? = null, eventEndpointCreatedTopicArn: Output<String>? = null, eventEndpointDeletedTopicArn: Output<String>? = null, eventEndpointUpdatedTopicArn: Output<String>? = null, failureFeedbackRoleArn: Output<String>? = null, name: Output<String>? = null, platform: Output<String>? = null, platformCredential: Output<String>? = null, platformPrincipal: Output<String>? = null, successFeedbackRoleArn: Output<String>? = null, successFeedbackSampleRate: Output<String>? = null)

Properties

applePlatformBundleId

val applePlatformBundleId: Output<String>? = null

The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).

applePlatformTeamId

val applePlatformTeamId: Output<String>? = null

The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.

eventDeliveryFailureTopicArn

val eventDeliveryFailureTopicArn: Output<String>? = null

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

eventEndpointCreatedTopicArn

val eventEndpointCreatedTopicArn: Output<String>? = null

The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.

eventEndpointDeletedTopicArn

val eventEndpointDeletedTopicArn: Output<String>? = null

The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.

eventEndpointUpdatedTopicArn

val eventEndpointUpdatedTopicArn: Output<String>? = null

The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.

failureFeedbackRoleArn

val failureFeedbackRoleArn: Output<String>? = null

The IAM role ARN permitted to receive failure feedback for this application and give SNS write access to use CloudWatch logs on your behalf.

name

val name: Output<String>? = null

The friendly name for the SNS platform application

platform

val platform: Output<String>? = null

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

platformCredential

val platformCredential: Output<String>? = null

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

val platformPrincipal: Output<String>? = null

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

val successFeedbackRoleArn: Output<String>? = null

The IAM role ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.

successFeedbackSampleRate

val successFeedbackSampleRate: Output<String>? = null

The sample rate percentage (0-100) of successfully delivered messages. The following attributes are needed only when using APNS token credentials:

Functions

toJava

open override fun toJava(): PlatformApplicationArgs