Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sns
  5. PlatformApplication
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.sns.PlatformApplication

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an SNS platform application resource

    Example Usage

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

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

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

    import pulumi
import pulumi_aws as aws

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

    package main

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

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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var apnsApplication = new Aws.Sns.PlatformApplication("apns_application", new()
    {
        Name = "apns_application",
        Platform = "APNS",
        PlatformCredential = "<APNS PRIVATE KEY>",
        PlatformPrincipal = "<APNS CERTIFICATE>",
    });

});

    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()
            .name("apns_application")
            .platform("APNS")
            .platformCredential("<APNS PRIVATE KEY>")
            .platformPrincipal("<APNS CERTIFICATE>")
            .build());

    }
}

    resources:
  apnsApplication:
    type: aws:sns:PlatformApplication
    name: apns_application
    properties:
      name: apns_application
      platform: APNS
      platformCredential: <APNS PRIVATE KEY>
      platformPrincipal: <APNS CERTIFICATE>

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

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

const apnsApplication = new aws.sns.PlatformApplication("apns_application", {
    name: "apns_application",
    platform: "APNS",
    platformCredential: "<APNS SIGNING KEY>",
    platformPrincipal: "<APNS SIGNING KEY ID>",
    applePlatformTeamId: "<APPLE TEAM ID>",
    applePlatformBundleId: "<APPLE BUNDLE ID>",
});

    import pulumi
import pulumi_aws as aws

apns_application = aws.sns.PlatformApplication("apns_application",
    name="apns_application",
    platform="APNS",
    platform_credential="<APNS SIGNING KEY>",
    platform_principal="<APNS SIGNING KEY ID>",
    apple_platform_team_id="<APPLE TEAM ID>",
    apple_platform_bundle_id="<APPLE BUNDLE ID>")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sns.NewPlatformApplication(ctx, "apns_application", &sns.PlatformApplicationArgs{
			Name:                  pulumi.String("apns_application"),
			Platform:              pulumi.String("APNS"),
			PlatformCredential:    pulumi.String("<APNS SIGNING KEY>"),
			PlatformPrincipal:     pulumi.String("<APNS SIGNING KEY ID>"),
			ApplePlatformTeamId:   pulumi.String("<APPLE TEAM ID>"),
			ApplePlatformBundleId: pulumi.String("<APPLE BUNDLE ID>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var apnsApplication = new Aws.Sns.PlatformApplication("apns_application", new()
    {
        Name = "apns_application",
        Platform = "APNS",
        PlatformCredential = "<APNS SIGNING KEY>",
        PlatformPrincipal = "<APNS SIGNING KEY ID>",
        ApplePlatformTeamId = "<APPLE TEAM ID>",
        ApplePlatformBundleId = "<APPLE BUNDLE ID>",
    });

});

    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()
            .name("apns_application")
            .platform("APNS")
            .platformCredential("<APNS SIGNING KEY>")
            .platformPrincipal("<APNS SIGNING KEY ID>")
            .applePlatformTeamId("<APPLE TEAM ID>")
            .applePlatformBundleId("<APPLE BUNDLE ID>")
            .build());

    }
}

    resources:
  apnsApplication:
    type: aws:sns:PlatformApplication
    name: apns_application
    properties:
      name: apns_application
      platform: APNS
      platformCredential: <APNS SIGNING KEY>
      platformPrincipal: <APNS SIGNING KEY ID>
      applePlatformTeamId: <APPLE TEAM ID>
      applePlatformBundleId: <APPLE BUNDLE ID>

    Google Cloud Messaging (GCM)

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

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

    import pulumi
import pulumi_aws as aws

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

    package main

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

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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var gcmApplication = new Aws.Sns.PlatformApplication("gcm_application", new()
    {
        Name = "gcm_application",
        Platform = "GCM",
        PlatformCredential = "<GCM API KEY>",
    });

});

    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()
            .name("gcm_application")
            .platform("GCM")
            .platformCredential("<GCM API KEY>")
            .build());

    }
}

    resources:
  gcmApplication:
    type: aws:sns:PlatformApplication
    name: gcm_application
    properties:
      name: gcm_application
      platform: GCM
      platformCredential: <GCM API KEY>

    Create PlatformApplication Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PlatformApplication(name: string, args: PlatformApplicationArgs, opts?: CustomResourceOptions);
    @overload
def PlatformApplication(resource_name: str,
                        args: PlatformApplicationArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def PlatformApplication(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        platform: Optional[str] = None,
                        platform_credential: Optional[str] = None,
                        event_endpoint_created_topic_arn: Optional[str] = None,
                        apple_platform_bundle_id: Optional[str] = None,
                        event_endpoint_deleted_topic_arn: Optional[str] = None,
                        event_endpoint_updated_topic_arn: Optional[str] = None,
                        failure_feedback_role_arn: Optional[str] = None,
                        name: Optional[str] = None,
                        event_delivery_failure_topic_arn: Optional[str] = None,
                        apple_platform_team_id: Optional[str] = None,
                        platform_principal: Optional[str] = None,
                        success_feedback_role_arn: Optional[str] = None,
                        success_feedback_sample_rate: Optional[str] = None)
    func NewPlatformApplication(ctx *Context, name string, args PlatformApplicationArgs, opts ...ResourceOption) (*PlatformApplication, error)
    public PlatformApplication(string name, PlatformApplicationArgs args, CustomResourceOptions? opts = null)
    public PlatformApplication(String name, PlatformApplicationArgs args)
public PlatformApplication(String name, PlatformApplicationArgs args, CustomResourceOptions options)

    type: aws:sns:PlatformApplication
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args PlatformApplicationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args PlatformApplicationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var platformApplicationResource = new Aws.Sns.PlatformApplication("platformApplicationResource", new()
{
    Platform = "string",
    PlatformCredential = "string",
    EventEndpointCreatedTopicArn = "string",
    ApplePlatformBundleId = "string",
    EventEndpointDeletedTopicArn = "string",
    EventEndpointUpdatedTopicArn = "string",
    FailureFeedbackRoleArn = "string",
    Name = "string",
    EventDeliveryFailureTopicArn = "string",
    ApplePlatformTeamId = "string",
    PlatformPrincipal = "string",
    SuccessFeedbackRoleArn = "string",
    SuccessFeedbackSampleRate = "string",
});

    example, err := sns.NewPlatformApplication(ctx, "platformApplicationResource", &sns.PlatformApplicationArgs{
	Platform:                     pulumi.String("string"),
	PlatformCredential:           pulumi.String("string"),
	EventEndpointCreatedTopicArn: pulumi.String("string"),
	ApplePlatformBundleId:        pulumi.String("string"),
	EventEndpointDeletedTopicArn: pulumi.String("string"),
	EventEndpointUpdatedTopicArn: pulumi.String("string"),
	FailureFeedbackRoleArn:       pulumi.String("string"),
	Name:                         pulumi.String("string"),
	EventDeliveryFailureTopicArn: pulumi.String("string"),
	ApplePlatformTeamId:          pulumi.String("string"),
	PlatformPrincipal:            pulumi.String("string"),
	SuccessFeedbackRoleArn:       pulumi.String("string"),
	SuccessFeedbackSampleRate:    pulumi.String("string"),
})

    var platformApplicationResource = new PlatformApplication("platformApplicationResource", PlatformApplicationArgs.builder()
    .platform("string")
    .platformCredential("string")
    .eventEndpointCreatedTopicArn("string")
    .applePlatformBundleId("string")
    .eventEndpointDeletedTopicArn("string")
    .eventEndpointUpdatedTopicArn("string")
    .failureFeedbackRoleArn("string")
    .name("string")
    .eventDeliveryFailureTopicArn("string")
    .applePlatformTeamId("string")
    .platformPrincipal("string")
    .successFeedbackRoleArn("string")
    .successFeedbackSampleRate("string")
    .build());

    platform_application_resource = aws.sns.PlatformApplication("platformApplicationResource",
    platform="string",
    platform_credential="string",
    event_endpoint_created_topic_arn="string",
    apple_platform_bundle_id="string",
    event_endpoint_deleted_topic_arn="string",
    event_endpoint_updated_topic_arn="string",
    failure_feedback_role_arn="string",
    name="string",
    event_delivery_failure_topic_arn="string",
    apple_platform_team_id="string",
    platform_principal="string",
    success_feedback_role_arn="string",
    success_feedback_sample_rate="string")

    const platformApplicationResource = new aws.sns.PlatformApplication("platformApplicationResource", {
    platform: "string",
    platformCredential: "string",
    eventEndpointCreatedTopicArn: "string",
    applePlatformBundleId: "string",
    eventEndpointDeletedTopicArn: "string",
    eventEndpointUpdatedTopicArn: "string",
    failureFeedbackRoleArn: "string",
    name: "string",
    eventDeliveryFailureTopicArn: "string",
    applePlatformTeamId: "string",
    platformPrincipal: "string",
    successFeedbackRoleArn: "string",
    successFeedbackSampleRate: "string",
});

    type: aws:sns:PlatformApplication
properties:
    applePlatformBundleId: string
    applePlatformTeamId: string
    eventDeliveryFailureTopicArn: string
    eventEndpointCreatedTopicArn: string
    eventEndpointDeletedTopicArn: string
    eventEndpointUpdatedTopicArn: string
    failureFeedbackRoleArn: string
    name: string
    platform: string
    platformCredential: string
    platformPrincipal: string
    successFeedbackRoleArn: string
    successFeedbackSampleRate: string

    PlatformApplication Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    ApplePlatformBundleId string
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    ApplePlatformTeamId string
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    EventDeliveryFailureTopicArn string
    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 string
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    EventEndpointDeletedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    EventEndpointUpdatedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    FailureFeedbackRoleArn string
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    SuccessFeedbackSampleRate string

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    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.
    ApplePlatformBundleId string
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    ApplePlatformTeamId string
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    EventDeliveryFailureTopicArn string
    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 string
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    EventEndpointDeletedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    EventEndpointUpdatedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    FailureFeedbackRoleArn string
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    SuccessFeedbackSampleRate string

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    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.
    applePlatformBundleId String
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    applePlatformTeamId String
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    eventDeliveryFailureTopicArn String
    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 String
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    eventEndpointDeletedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    eventEndpointUpdatedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failureFeedbackRoleArn String
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    successFeedbackSampleRate String

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    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.
    applePlatformBundleId string
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    applePlatformTeamId string
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    eventDeliveryFailureTopicArn string
    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 string
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    eventEndpointDeletedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    eventEndpointUpdatedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failureFeedbackRoleArn string
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    successFeedbackSampleRate string

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    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.
    apple_platform_bundle_id str
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    apple_platform_team_id str
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    event_delivery_failure_topic_arn str
    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.
    event_endpoint_created_topic_arn str
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    event_endpoint_deleted_topic_arn str
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    event_endpoint_updated_topic_arn str
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failure_feedback_role_arn str
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    success_feedback_sample_rate str

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    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.
    applePlatformBundleId String
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    applePlatformTeamId String
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    eventDeliveryFailureTopicArn String
    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 String
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    eventEndpointDeletedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    eventEndpointUpdatedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failureFeedbackRoleArn String
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    successFeedbackSampleRate String

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    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 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.
    arn String
    The ARN of the SNS platform application
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apple_platform_bundle_id: Optional[str] = None,
        apple_platform_team_id: Optional[str] = None,
        arn: Optional[str] = None,
        event_delivery_failure_topic_arn: Optional[str] = None,
        event_endpoint_created_topic_arn: Optional[str] = None,
        event_endpoint_deleted_topic_arn: Optional[str] = None,
        event_endpoint_updated_topic_arn: Optional[str] = None,
        failure_feedback_role_arn: Optional[str] = None,
        name: Optional[str] = None,
        platform: Optional[str] = None,
        platform_credential: Optional[str] = None,
        platform_principal: Optional[str] = None,
        success_feedback_role_arn: Optional[str] = None,
        success_feedback_sample_rate: Optional[str] = None) -> PlatformApplication
    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)
    public static PlatformApplication get(String name, Output<String> id, PlatformApplicationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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:
    ApplePlatformBundleId string
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    ApplePlatformTeamId string
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    Arn string
    The ARN of the SNS platform application
    EventDeliveryFailureTopicArn string
    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 string
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    EventEndpointDeletedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    EventEndpointUpdatedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    FailureFeedbackRoleArn string
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    SuccessFeedbackSampleRate string

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    ApplePlatformBundleId string
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    ApplePlatformTeamId string
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    Arn string
    The ARN of the SNS platform application
    EventDeliveryFailureTopicArn string
    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 string
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    EventEndpointDeletedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    EventEndpointUpdatedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    FailureFeedbackRoleArn string
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    SuccessFeedbackSampleRate string

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    applePlatformBundleId String
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    applePlatformTeamId String
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    arn String
    The ARN of the SNS platform application
    eventDeliveryFailureTopicArn String
    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 String
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    eventEndpointDeletedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    eventEndpointUpdatedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failureFeedbackRoleArn String
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    successFeedbackSampleRate String

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    applePlatformBundleId string
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    applePlatformTeamId string
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    arn string
    The ARN of the SNS platform application
    eventDeliveryFailureTopicArn string
    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 string
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    eventEndpointDeletedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    eventEndpointUpdatedTopicArn string
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failureFeedbackRoleArn string
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    successFeedbackSampleRate string

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    apple_platform_bundle_id str
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    apple_platform_team_id str
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    arn str
    The ARN of the SNS platform application
    event_delivery_failure_topic_arn str
    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.
    event_endpoint_created_topic_arn str
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    event_endpoint_deleted_topic_arn str
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    event_endpoint_updated_topic_arn str
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failure_feedback_role_arn str
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    success_feedback_sample_rate str

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    applePlatformBundleId String
    The bundle identifier that's assigned to your iOS app. May only include alphanumeric characters, hyphens (-), and periods (.).
    applePlatformTeamId String
    The identifier that's assigned to your Apple developer account team. Must be 10 alphanumeric characters.
    arn String
    The ARN of the SNS platform application
    eventDeliveryFailureTopicArn String
    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 String
    The ARN of the SNS Topic triggered when a new platform endpoint is added to your platform application.
    eventEndpointDeletedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is deleted from your platform application.
    eventEndpointUpdatedTopicArn String
    The ARN of the SNS Topic triggered when an existing platform endpoint is changed from your platform application.
    failureFeedbackRoleArn String
    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 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 ARN permitted to receive success feedback for this application and give SNS write access to use CloudWatch logs on your behalf.
    successFeedbackSampleRate String

    The sample rate percentage (0-100) of successfully delivered messages.

    The following attributes are needed only when using APNS token credentials:

    Import

    Using pulumi import, import SNS platform applications using the ARN. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws