Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. pinpoint
  6. ApnsSandboxChannel
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.pinpoint.ApnsSandboxChannel

aws logo
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Provides an End User Messaging APNs Sandbox Channel resource.

    Note: All arguments, including certificates and tokens, will be stored in the raw state as plain-text.

    Example Usage

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

const app = new aws.pinpoint.App("app", {});
const apnsSandbox = new aws.pinpoint.ApnsSandboxChannel("apns_sandbox", {
    applicationId: app.applicationId,
    certificate: std.file({
        input: "./certificate.pem",
    }).then(invoke => invoke.result),
    privateKey: std.file({
        input: "./private_key.key",
    }).then(invoke => invoke.result),
});

    import pulumi
import pulumi_aws as aws
import pulumi_std as std

app = aws.pinpoint.App("app")
apns_sandbox = aws.pinpoint.ApnsSandboxChannel("apns_sandbox",
    application_id=app.application_id,
    certificate=std.file(input="./certificate.pem").result,
    private_key=std.file(input="./private_key.key").result)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		app, err := pinpoint.NewApp(ctx, "app", nil)
		if err != nil {
			return err
		}
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "./certificate.pem",
		}, nil)
		if err != nil {
			return err
		}
		invokeFile1, err := std.File(ctx, &std.FileArgs{
			Input: "./private_key.key",
		}, nil)
		if err != nil {
			return err
		}
		_, err = pinpoint.NewApnsSandboxChannel(ctx, "apns_sandbox", &pinpoint.ApnsSandboxChannelArgs{
			ApplicationId: app.ApplicationId,
			Certificate:   pulumi.String(invokeFile.Result),
			PrivateKey:    pulumi.String(invokeFile1.Result),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var app = new Aws.Pinpoint.App("app");

    var apnsSandbox = new Aws.Pinpoint.ApnsSandboxChannel("apns_sandbox", new()
    {
        ApplicationId = app.ApplicationId,
        Certificate = Std.File.Invoke(new()
        {
            Input = "./certificate.pem",
        }).Apply(invoke => invoke.Result),
        PrivateKey = Std.File.Invoke(new()
        {
            Input = "./private_key.key",
        }).Apply(invoke => invoke.Result),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.App;
import com.pulumi.aws.pinpoint.ApnsSandboxChannel;
import com.pulumi.aws.pinpoint.ApnsSandboxChannelArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 app = new App("app");

        var apnsSandbox = new ApnsSandboxChannel("apnsSandbox", ApnsSandboxChannelArgs.builder()
            .applicationId(app.applicationId())
            .certificate(StdFunctions.file(FileArgs.builder()
                .input("./certificate.pem")
                .build()).result())
            .privateKey(StdFunctions.file(FileArgs.builder()
                .input("./private_key.key")
                .build()).result())
            .build());

    }
}

    resources:
  apnsSandbox:
    type: aws:pinpoint:ApnsSandboxChannel
    name: apns_sandbox
    properties:
      applicationId: ${app.applicationId}
      certificate:
        fn::invoke:
          function: std:file
          arguments:
            input: ./certificate.pem
          return: result
      privateKey:
        fn::invoke:
          function: std:file
          arguments:
            input: ./private_key.key
          return: result
  app:
    type: aws:pinpoint:App

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
    std = {
      source = "pulumi/std"
    }
  }
}

resource "aws_pinpoint_apnssandboxchannel" "apns_sandbox" {
  application_id = aws_pinpoint_app.app.application_id
  certificate    = file("./certificate.pem")
  private_key    = file("./private_key.key")
}
resource "aws_pinpoint_app" "app" {
}

    Create ApnsSandboxChannel Resource

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

    Constructor syntax

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

@overload
def ApnsSandboxChannel(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       application_id: Optional[str] = None,
                       bundle_id: Optional[str] = None,
                       certificate: Optional[str] = None,
                       default_authentication_method: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       private_key: Optional[str] = None,
                       region: Optional[str] = None,
                       team_id: Optional[str] = None,
                       token_key: Optional[str] = None,
                       token_key_id: Optional[str] = None)
    func NewApnsSandboxChannel(ctx *Context, name string, args ApnsSandboxChannelArgs, opts ...ResourceOption) (*ApnsSandboxChannel, error)
    public ApnsSandboxChannel(string name, ApnsSandboxChannelArgs args, CustomResourceOptions? opts = null)
    public ApnsSandboxChannel(String name, ApnsSandboxChannelArgs args)
public ApnsSandboxChannel(String name, ApnsSandboxChannelArgs args, CustomResourceOptions options)

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


    resource "aws_pinpoint_apnssandboxchannel" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ApnsSandboxChannelArgs
    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 ApnsSandboxChannelArgs
    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 ApnsSandboxChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApnsSandboxChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApnsSandboxChannelArgs
    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 apnsSandboxChannelResource = new Aws.Pinpoint.ApnsSandboxChannel("apnsSandboxChannelResource", new()
{
    ApplicationId = "string",
    BundleId = "string",
    Certificate = "string",
    DefaultAuthenticationMethod = "string",
    Enabled = false,
    PrivateKey = "string",
    Region = "string",
    TeamId = "string",
    TokenKey = "string",
    TokenKeyId = "string",
});

    example, err := pinpoint.NewApnsSandboxChannel(ctx, "apnsSandboxChannelResource", &pinpoint.ApnsSandboxChannelArgs{
	ApplicationId:               pulumi.String("string"),
	BundleId:                    pulumi.String("string"),
	Certificate:                 pulumi.String("string"),
	DefaultAuthenticationMethod: pulumi.String("string"),
	Enabled:                     pulumi.Bool(false),
	PrivateKey:                  pulumi.String("string"),
	Region:                      pulumi.String("string"),
	TeamId:                      pulumi.String("string"),
	TokenKey:                    pulumi.String("string"),
	TokenKeyId:                  pulumi.String("string"),
})

    resource "aws_pinpoint_apnssandboxchannel" "apnsSandboxChannelResource" {
  application_id                = "string"
  bundle_id                     = "string"
  certificate                   = "string"
  default_authentication_method = "string"
  enabled                       = false
  private_key                   = "string"
  region                        = "string"
  team_id                       = "string"
  token_key                     = "string"
  token_key_id                  = "string"
}

    var apnsSandboxChannelResource = new ApnsSandboxChannel("apnsSandboxChannelResource", ApnsSandboxChannelArgs.builder()
    .applicationId("string")
    .bundleId("string")
    .certificate("string")
    .defaultAuthenticationMethod("string")
    .enabled(false)
    .privateKey("string")
    .region("string")
    .teamId("string")
    .tokenKey("string")
    .tokenKeyId("string")
    .build());

    apns_sandbox_channel_resource = aws.pinpoint.ApnsSandboxChannel("apnsSandboxChannelResource",
    application_id="string",
    bundle_id="string",
    certificate="string",
    default_authentication_method="string",
    enabled=False,
    private_key="string",
    region="string",
    team_id="string",
    token_key="string",
    token_key_id="string")

    const apnsSandboxChannelResource = new aws.pinpoint.ApnsSandboxChannel("apnsSandboxChannelResource", {
    applicationId: "string",
    bundleId: "string",
    certificate: "string",
    defaultAuthenticationMethod: "string",
    enabled: false,
    privateKey: "string",
    region: "string",
    teamId: "string",
    tokenKey: "string",
    tokenKeyId: "string",
});

    type: aws:pinpoint:ApnsSandboxChannel
properties:
    applicationId: string
    bundleId: string
    certificate: string
    defaultAuthenticationMethod: string
    enabled: false
    privateKey: string
    region: string
    teamId: string
    tokenKey: string
    tokenKeyId: string

    ApnsSandboxChannel 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 ApnsSandboxChannel resource accepts the following input properties:

    ApplicationId string
    Application ID.
    BundleId string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    Certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    DefaultAuthenticationMethod string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    PrivateKey string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TeamId string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    TokenKey string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    TokenKeyId string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    ApplicationId string
    Application ID.
    BundleId string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    Certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    DefaultAuthenticationMethod string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    PrivateKey string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TeamId string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    TokenKey string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    TokenKeyId string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    application_id string
    Application ID.
    bundle_id string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    default_authentication_method string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    private_key string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    team_id string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    token_key string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    token_key_id string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    applicationId String
    Application ID.
    bundleId String
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate String
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    defaultAuthenticationMethod String
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.
    privateKey String
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    teamId String
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    tokenKey String
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    tokenKeyId String
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    applicationId string
    Application ID.
    bundleId string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    defaultAuthenticationMethod string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled boolean
    Whether the channel is enabled or disabled. Defaults to true.
    privateKey string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    teamId string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    tokenKey string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    tokenKeyId string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    application_id str
    Application ID.
    bundle_id str
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate str
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    default_authentication_method str
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    private_key str
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    team_id str
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    token_key str
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    token_key_id str
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    applicationId String
    Application ID.
    bundleId String
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate String
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    defaultAuthenticationMethod String
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.
    privateKey String
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    teamId String
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    tokenKey String
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    tokenKeyId String
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApnsSandboxChannel Resource

    Get an existing ApnsSandboxChannel 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?: ApnsSandboxChannelState, opts?: CustomResourceOptions): ApnsSandboxChannel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_id: Optional[str] = None,
        bundle_id: Optional[str] = None,
        certificate: Optional[str] = None,
        default_authentication_method: Optional[str] = None,
        enabled: Optional[bool] = None,
        private_key: Optional[str] = None,
        region: Optional[str] = None,
        team_id: Optional[str] = None,
        token_key: Optional[str] = None,
        token_key_id: Optional[str] = None) -> ApnsSandboxChannel
    func GetApnsSandboxChannel(ctx *Context, name string, id IDInput, state *ApnsSandboxChannelState, opts ...ResourceOption) (*ApnsSandboxChannel, error)
    public static ApnsSandboxChannel Get(string name, Input<string> id, ApnsSandboxChannelState? state, CustomResourceOptions? opts = null)
    public static ApnsSandboxChannel get(String name, Output<String> id, ApnsSandboxChannelState state, CustomResourceOptions options)
    resources:  _:    type: aws:pinpoint:ApnsSandboxChannel    get:      id: ${id}
    import {
  to = aws_pinpoint_apnssandboxchannel.example
  id = "${id}"
}
    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:
    ApplicationId string
    Application ID.
    BundleId string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    Certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    DefaultAuthenticationMethod string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    PrivateKey string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TeamId string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    TokenKey string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    TokenKeyId string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    ApplicationId string
    Application ID.
    BundleId string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    Certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    DefaultAuthenticationMethod string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    Enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    PrivateKey string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TeamId string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    TokenKey string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    TokenKeyId string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    application_id string
    Application ID.
    bundle_id string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    default_authentication_method string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    private_key string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    team_id string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    token_key string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    token_key_id string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    applicationId String
    Application ID.
    bundleId String
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate String
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    defaultAuthenticationMethod String
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.
    privateKey String
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    teamId String
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    tokenKey String
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    tokenKeyId String
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    applicationId string
    Application ID.
    bundleId string
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate string
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    defaultAuthenticationMethod string
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled boolean
    Whether the channel is enabled or disabled. Defaults to true.
    privateKey string
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    teamId string
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    tokenKey string
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    tokenKeyId string
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    application_id str
    Application ID.
    bundle_id str
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate str
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    default_authentication_method str
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled bool
    Whether the channel is enabled or disabled. Defaults to true.
    private_key str
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    team_id str
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    token_key str
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    token_key_id str
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.
    applicationId String
    Application ID.
    bundleId String
    ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app. Required if using Key credentials.
    certificate String
    Pem encoded TLS Certificate from Apple. Required if using Certificate credentials.
    defaultAuthenticationMethod String
    Default authentication method used for APNs Sandbox. NOTE: AWS End User Messaging uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the AWS End User Messaging API, the AWS CLI, or an AWS SDK. If your default authentication type fails, AWS End User Messaging doesn't attempt to use the other authentication type.
    enabled Boolean
    Whether the channel is enabled or disabled. Defaults to true.
    privateKey String
    Certificate Private Key file (ie. .key file). Required if using Certificate credentials.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    teamId String
    ID assigned to your Apple developer account team. This value is provided on the Membership page. Required if using Key credentials.
    tokenKey String
    .p8 file that you download from your Apple developer account when you create an authentication key. Required if using Key credentials.
    tokenKeyId String
    ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section. Required if using Key credentials.

    Import

    Using pulumi import, import End User Messaging APNs Sandbox Channel using the application-id. For example:

    $ pulumi import aws:pinpoint/apnsSandboxChannel:ApnsSandboxChannel apns_sandbox application-id

    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
    Viewing docs for AWS v7.32.0
    published on Friday, May 29, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial