Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. pinpoint
  5. ApnsVoipSandboxChannel
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.pinpoint.ApnsVoipSandboxChannel

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

Provides a Pinpoint APNs VoIP 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 apnsVoipSandbox = new aws.pinpoint.ApnsVoipSandboxChannel("apns_voip_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),
});
Copy
import pulumi
import pulumi_aws as aws
import pulumi_std as std

app = aws.pinpoint.App("app")
apns_voip_sandbox = aws.pinpoint.ApnsVoipSandboxChannel("apns_voip_sandbox",
    application_id=app.application_id,
    certificate=std.file(input="./certificate.pem").result,
    private_key=std.file(input="./private_key.key").result)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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.NewApnsVoipSandboxChannel(ctx, "apns_voip_sandbox", &pinpoint.ApnsVoipSandboxChannelArgs{
			ApplicationId: app.ApplicationId,
			Certificate:   pulumi.String(invokeFile.Result),
			PrivateKey:    pulumi.String(invokeFile1.Result),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 apnsVoipSandbox = new Aws.Pinpoint.ApnsVoipSandboxChannel("apns_voip_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),
    });

});
Copy
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.ApnsVoipSandboxChannel;
import com.pulumi.aws.pinpoint.ApnsVoipSandboxChannelArgs;
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 app = new App("app");

        var apnsVoipSandbox = new ApnsVoipSandboxChannel("apnsVoipSandbox", ApnsVoipSandboxChannelArgs.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());

    }
}
Copy
resources:
  apnsVoipSandbox:
    type: aws:pinpoint:ApnsVoipSandboxChannel
    name: apns_voip_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
Copy

Create ApnsVoipSandboxChannel Resource

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

Constructor syntax

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

@overload
def ApnsVoipSandboxChannel(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,
                           team_id: Optional[str] = None,
                           token_key: Optional[str] = None,
                           token_key_id: Optional[str] = None)
func NewApnsVoipSandboxChannel(ctx *Context, name string, args ApnsVoipSandboxChannelArgs, opts ...ResourceOption) (*ApnsVoipSandboxChannel, error)
public ApnsVoipSandboxChannel(string name, ApnsVoipSandboxChannelArgs args, CustomResourceOptions? opts = null)
public ApnsVoipSandboxChannel(String name, ApnsVoipSandboxChannelArgs args)
public ApnsVoipSandboxChannel(String name, ApnsVoipSandboxChannelArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApnsVoipSandboxChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApnsVoipSandboxChannelArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApnsVoipSandboxChannelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApnsVoipSandboxChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApnsVoipSandboxChannelArgs
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 apnsVoipSandboxChannelResource = new Aws.Pinpoint.ApnsVoipSandboxChannel("apnsVoipSandboxChannelResource", new()
{
    ApplicationId = "string",
    BundleId = "string",
    Certificate = "string",
    DefaultAuthenticationMethod = "string",
    Enabled = false,
    PrivateKey = "string",
    TeamId = "string",
    TokenKey = "string",
    TokenKeyId = "string",
});
Copy
example, err := pinpoint.NewApnsVoipSandboxChannel(ctx, "apnsVoipSandboxChannelResource", &pinpoint.ApnsVoipSandboxChannelArgs{
	ApplicationId:               pulumi.String("string"),
	BundleId:                    pulumi.String("string"),
	Certificate:                 pulumi.String("string"),
	DefaultAuthenticationMethod: pulumi.String("string"),
	Enabled:                     pulumi.Bool(false),
	PrivateKey:                  pulumi.String("string"),
	TeamId:                      pulumi.String("string"),
	TokenKey:                    pulumi.String("string"),
	TokenKeyId:                  pulumi.String("string"),
})
Copy
var apnsVoipSandboxChannelResource = new ApnsVoipSandboxChannel("apnsVoipSandboxChannelResource", ApnsVoipSandboxChannelArgs.builder()
    .applicationId("string")
    .bundleId("string")
    .certificate("string")
    .defaultAuthenticationMethod("string")
    .enabled(false)
    .privateKey("string")
    .teamId("string")
    .tokenKey("string")
    .tokenKeyId("string")
    .build());
Copy
apns_voip_sandbox_channel_resource = aws.pinpoint.ApnsVoipSandboxChannel("apnsVoipSandboxChannelResource",
    application_id="string",
    bundle_id="string",
    certificate="string",
    default_authentication_method="string",
    enabled=False,
    private_key="string",
    team_id="string",
    token_key="string",
    token_key_id="string")
Copy
const apnsVoipSandboxChannelResource = new aws.pinpoint.ApnsVoipSandboxChannel("apnsVoipSandboxChannelResource", {
    applicationId: "string",
    bundleId: "string",
    certificate: "string",
    defaultAuthenticationMethod: "string",
    enabled: false,
    privateKey: "string",
    teamId: "string",
    tokenKey: "string",
    tokenKeyId: "string",
});
Copy
type: aws:pinpoint:ApnsVoipSandboxChannel
properties:
    applicationId: string
    bundleId: string
    certificate: string
    defaultAuthenticationMethod: string
    enabled: false
    privateKey: string
    teamId: string
    tokenKey: string
    tokenKeyId: string
Copy

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

ApplicationId
This property is required.
Changes to this property will trigger replacement.
string
The application ID.
BundleId string
The 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.
Certificate string
The pem encoded TLS Certificate from Apple.
DefaultAuthenticationMethod string

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

Enabled bool
Whether the channel is enabled or disabled. Defaults to true.
PrivateKey string

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

TeamId string
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
TokenKey string
The .p8 file that you download from your Apple developer account when you create an authentication key.
TokenKeyId string
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
ApplicationId
This property is required.
Changes to this property will trigger replacement.
string
The application ID.
BundleId string
The 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.
Certificate string
The pem encoded TLS Certificate from Apple.
DefaultAuthenticationMethod string

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

Enabled bool
Whether the channel is enabled or disabled. Defaults to true.
PrivateKey string

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

TeamId string
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
TokenKey string
The .p8 file that you download from your Apple developer account when you create an authentication key.
TokenKeyId string
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
applicationId
This property is required.
Changes to this property will trigger replacement.
String
The application ID.
bundleId String
The 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.
certificate String
The pem encoded TLS Certificate from Apple.
defaultAuthenticationMethod String

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled Boolean
Whether the channel is enabled or disabled. Defaults to true.
privateKey String

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

teamId String
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
tokenKey String
The .p8 file that you download from your Apple developer account when you create an authentication key.
tokenKeyId String
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
applicationId
This property is required.
Changes to this property will trigger replacement.
string
The application ID.
bundleId string
The 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.
certificate string
The pem encoded TLS Certificate from Apple.
defaultAuthenticationMethod string

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled boolean
Whether the channel is enabled or disabled. Defaults to true.
privateKey string

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

teamId string
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
tokenKey string
The .p8 file that you download from your Apple developer account when you create an authentication key.
tokenKeyId string
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
application_id
This property is required.
Changes to this property will trigger replacement.
str
The application ID.
bundle_id str
The 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.
certificate str
The pem encoded TLS Certificate from Apple.
default_authentication_method str

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled bool
Whether the channel is enabled or disabled. Defaults to true.
private_key str

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

team_id str
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key str
The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id str
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
applicationId
This property is required.
Changes to this property will trigger replacement.
String
The application ID.
bundleId String
The 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.
certificate String
The pem encoded TLS Certificate from Apple.
defaultAuthenticationMethod String

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled Boolean
Whether the channel is enabled or disabled. Defaults to true.
privateKey String

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

teamId String
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
tokenKey String
The .p8 file that you download from your Apple developer account when you create an authentication key.
tokenKeyId String
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApnsVoipSandboxChannel 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ApnsVoipSandboxChannel Resource

Get an existing ApnsVoipSandboxChannel 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?: ApnsVoipSandboxChannelState, opts?: CustomResourceOptions): ApnsVoipSandboxChannel
@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,
        team_id: Optional[str] = None,
        token_key: Optional[str] = None,
        token_key_id: Optional[str] = None) -> ApnsVoipSandboxChannel
func GetApnsVoipSandboxChannel(ctx *Context, name string, id IDInput, state *ApnsVoipSandboxChannelState, opts ...ResourceOption) (*ApnsVoipSandboxChannel, error)
public static ApnsVoipSandboxChannel Get(string name, Input<string> id, ApnsVoipSandboxChannelState? state, CustomResourceOptions? opts = null)
public static ApnsVoipSandboxChannel get(String name, Output<String> id, ApnsVoipSandboxChannelState state, CustomResourceOptions options)
resources:  _:    type: aws:pinpoint:ApnsVoipSandboxChannel    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
The application ID.
BundleId string
The 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.
Certificate string
The pem encoded TLS Certificate from Apple.
DefaultAuthenticationMethod string

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

Enabled bool
Whether the channel is enabled or disabled. Defaults to true.
PrivateKey string

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

TeamId string
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
TokenKey string
The .p8 file that you download from your Apple developer account when you create an authentication key.
TokenKeyId string
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
ApplicationId Changes to this property will trigger replacement. string
The application ID.
BundleId string
The 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.
Certificate string
The pem encoded TLS Certificate from Apple.
DefaultAuthenticationMethod string

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

Enabled bool
Whether the channel is enabled or disabled. Defaults to true.
PrivateKey string

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

TeamId string
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
TokenKey string
The .p8 file that you download from your Apple developer account when you create an authentication key.
TokenKeyId string
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
applicationId Changes to this property will trigger replacement. String
The application ID.
bundleId String
The 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.
certificate String
The pem encoded TLS Certificate from Apple.
defaultAuthenticationMethod String

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled Boolean
Whether the channel is enabled or disabled. Defaults to true.
privateKey String

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

teamId String
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
tokenKey String
The .p8 file that you download from your Apple developer account when you create an authentication key.
tokenKeyId String
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
applicationId Changes to this property will trigger replacement. string
The application ID.
bundleId string
The 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.
certificate string
The pem encoded TLS Certificate from Apple.
defaultAuthenticationMethod string

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled boolean
Whether the channel is enabled or disabled. Defaults to true.
privateKey string

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

teamId string
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
tokenKey string
The .p8 file that you download from your Apple developer account when you create an authentication key.
tokenKeyId string
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
application_id Changes to this property will trigger replacement. str
The application ID.
bundle_id str
The 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.
certificate str
The pem encoded TLS Certificate from Apple.
default_authentication_method str

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled bool
Whether the channel is enabled or disabled. Defaults to true.
private_key str

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

team_id str
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key str
The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id str
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
applicationId Changes to this property will trigger replacement. String
The application ID.
bundleId String
The 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.
certificate String
The pem encoded TLS Certificate from Apple.
defaultAuthenticationMethod String

The default authentication method used for APNs. NOTE: Amazon Pinpoint 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 Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn't attempt to use the other authentication type.

One of the following sets of credentials is also required.

If you choose to use Certificate credentials you will have to provide:

enabled Boolean
Whether the channel is enabled or disabled. Defaults to true.
privateKey String

The Certificate Private Key file (ie. .key file).

If you choose to use Key credentials you will have to provide:

teamId String
The ID assigned to your Apple developer account team. This value is provided on the Membership page.
tokenKey String
The .p8 file that you download from your Apple developer account when you create an authentication key.
tokenKeyId String
The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

Import

Using pulumi import, import Pinpoint APNs VoIP Sandbox Channel using the application-id. For example:

$ pulumi import aws:pinpoint/apnsVoipSandboxChannel:ApnsVoipSandboxChannel apns_voip_sandbox application-id
Copy

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 v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws