Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. pinpoint
  5. ApnsVoipChannel
aws logo
AWS Classic v5.41.0, May 15 23

aws.pinpoint.ApnsVoipChannel

Explore with Pulumi AI

Provides a Pinpoint APNs VoIP Channel resource.

Example Usage

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

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

    var apnsVoip = new Aws.Pinpoint.ApnsVoipChannel("apnsVoip", new()
    {
        ApplicationId = app.ApplicationId,
        Certificate = File.ReadAllText("./certificate.pem"),
        PrivateKey = File.ReadAllText("./private_key.key"),
    });

});

package main

import (
	"os"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/pinpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		app, err := pinpoint.NewApp(ctx, "app", nil)
		if err != nil {
			return err
		}
		_, err = pinpoint.NewApnsVoipChannel(ctx, "apnsVoip", &pinpoint.ApnsVoipChannelArgs{
			ApplicationId: app.ApplicationId,
			Certificate:   readFileOrPanic("./certificate.pem"),
			PrivateKey:    readFileOrPanic("./private_key.key"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.ApnsVoipChannel;
import com.pulumi.aws.pinpoint.ApnsVoipChannelArgs;
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 apnsVoip = new ApnsVoipChannel("apnsVoip", ApnsVoipChannelArgs.builder()        
            .applicationId(app.applicationId())
            .certificate(Files.readString(Paths.get("./certificate.pem")))
            .privateKey(Files.readString(Paths.get("./private_key.key")))
            .build());

    }
}

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
apns_voip = aws.pinpoint.ApnsVoipChannel("apnsVoip",
    application_id=app.application_id,
    certificate=(lambda path: open(path).read())("./certificate.pem"),
    private_key=(lambda path: open(path).read())("./private_key.key"))

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

const app = new aws.pinpoint.App("app", {});
const apnsVoip = new aws.pinpoint.ApnsVoipChannel("apnsVoip", {
    applicationId: app.applicationId,
    certificate: fs.readFileSync("./certificate.pem"),
    privateKey: fs.readFileSync("./private_key.key"),
});

resources:
  apnsVoip:
    type: aws:pinpoint:ApnsVoipChannel
    properties:
      applicationId: ${app.applicationId}
      certificate:
        fn::readFile: ./certificate.pem
      privateKey:
        fn::readFile: ./private_key.key
  app:
    type: aws:pinpoint:App

Create ApnsVoipChannel Resource

new ApnsVoipChannel(name: string, args: ApnsVoipChannelArgs, opts?: CustomResourceOptions);
@overload
def ApnsVoipChannel(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)
@overload
def ApnsVoipChannel(resource_name: str,
                    args: ApnsVoipChannelArgs,
                    opts: Optional[ResourceOptions] = None)
func NewApnsVoipChannel(ctx *Context, name string, args ApnsVoipChannelArgs, opts ...ResourceOption) (*ApnsVoipChannel, error)
public ApnsVoipChannel(string name, ApnsVoipChannelArgs args, CustomResourceOptions? opts = null)
public ApnsVoipChannel(String name, ApnsVoipChannelArgs args)
public ApnsVoipChannel(String name, ApnsVoipChannelArgs args, CustomResourceOptions options)

type: aws:pinpoint:ApnsVoipChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApnsVoipChannelArgs
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 ApnsVoipChannelArgs
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 ApnsVoipChannelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApnsVoipChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ApnsVoipChannelArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ApnsVoipChannel Resource Properties

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

Inputs

The ApnsVoipChannel resource accepts the following input properties:

ApplicationId 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.

Enabled bool

Whether the channel is enabled or disabled. Defaults to true.

PrivateKey string

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

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 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.

Enabled bool

Whether the channel is enabled or disabled. Defaults to true.

PrivateKey string

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

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 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.

enabled Boolean

Whether the channel is enabled or disabled. Defaults to true.

privateKey String

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

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 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.

enabled boolean

Whether the channel is enabled or disabled. Defaults to true.

privateKey string

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

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 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.

enabled bool

Whether the channel is enabled or disabled. Defaults to true.

private_key str

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

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 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.

enabled Boolean

Whether the channel is enabled or disabled. Defaults to true.

privateKey String

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

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 ApnsVoipChannel 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 ApnsVoipChannel Resource

Get an existing ApnsVoipChannel 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?: ApnsVoipChannelState, opts?: CustomResourceOptions): ApnsVoipChannel
@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) -> ApnsVoipChannel
func GetApnsVoipChannel(ctx *Context, name string, id IDInput, state *ApnsVoipChannelState, opts ...ResourceOption) (*ApnsVoipChannel, error)
public static ApnsVoipChannel Get(string name, Input<string> id, ApnsVoipChannelState? state, CustomResourceOptions? opts = null)
public static ApnsVoipChannel get(String name, Output<String> id, ApnsVoipChannelState 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:
ApplicationId 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.

Enabled bool

Whether the channel is enabled or disabled. Defaults to true.

PrivateKey string

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

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 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.

Enabled bool

Whether the channel is enabled or disabled. Defaults to true.

PrivateKey string

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

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 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.

enabled Boolean

Whether the channel is enabled or disabled. Defaults to true.

privateKey String

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

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 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.

enabled boolean

Whether the channel is enabled or disabled. Defaults to true.

privateKey string

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

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 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.

enabled bool

Whether the channel is enabled or disabled. Defaults to true.

private_key str

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

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 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.

enabled Boolean

Whether the channel is enabled or disabled. Defaults to true.

privateKey String

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

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

Pinpoint APNs VoIP Channel can be imported using the application-id, e.g.,

 $ pulumi import aws:pinpoint/apnsVoipChannel:ApnsVoipChannel apns_voip application-id

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.