ApnsVoipChannel

Provides a Pinpoint APNs VoIP Channel resource.

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

Example Usage

using System.IO;
using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var app = new Aws.Pinpoint.App("app", new Aws.Pinpoint.AppArgs
        {
        });
        var apnsVoip = new Aws.Pinpoint.ApnsVoipChannel("apnsVoip", new Aws.Pinpoint.ApnsVoipChannelArgs
        {
            ApplicationId = app.ApplicationId,
            Certificate = File.ReadAllText("./certificate.pem"),
            PrivateKey = File.ReadAllText("./private_key.key"),
        });
    }

}

Coming soon!

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("apns_voip", {
    applicationId: app.applicationId,
    certificate: fs.readFileSync("./certificate.pem", "utf-8"),
    privateKey: fs.readFileSync("./private_key.key", "utf-8"),
});

Create a ApnsVoipChannel Resource

new ApnsVoipChannel(name: string, args: ApnsVoipChannelArgs, opts?: CustomResourceOptions);

def ApnsVoipChannel(resource_name, opts=None, application_id=None, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None, __props__=None);

func NewApnsVoipChannel(ctx *Context, name string, args ApnsVoipChannelArgs, opts ...ResourceOption) (*ApnsVoipChannel, error)

public ApnsVoipChannel(string name, ApnsVoipChannelArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

ApnsVoipChannel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.

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.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, application_id=None, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None, __props__=None);

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)

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.

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.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud