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

aws.pinpoint.ApnsVoipChannel

Explore with Pulumi AI

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

    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

    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 apnsVoip = new aws.pinpoint.ApnsVoipChannel("apns_voip", {
    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_voip = aws.pinpoint.ApnsVoipChannel("apns_voip",
    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/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.NewApnsVoipChannel(ctx, "apns_voip", &pinpoint.ApnsVoipChannelArgs{
			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 apnsVoip = new Aws.Pinpoint.ApnsVoipChannel("apns_voip", 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.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(StdFunctions.file(FileArgs.builder()
                .input("./certificate.pem")
                .build()).result())
            .privateKey(StdFunctions.file(FileArgs.builder()
                .input("./private_key.key")
                .build()).result())
            .build());

    }
}

    resources:
  apnsVoip:
    type: aws:pinpoint:ApnsVoipChannel
    name: apns_voip
    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

    Create ApnsVoipChannel Resource

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

    Constructor syntax

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

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

    Parameters

    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.

    Constructor example

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

    var apnsVoipChannelResource = new Aws.Pinpoint.ApnsVoipChannel("apnsVoipChannelResource", new()
{
    ApplicationId = "string",
    BundleId = "string",
    Certificate = "string",
    DefaultAuthenticationMethod = "string",
    Enabled = false,
    PrivateKey = "string",
    TeamId = "string",
    TokenKey = "string",
    TokenKeyId = "string",
});

    example, err := pinpoint.NewApnsVoipChannel(ctx, "apnsVoipChannelResource", &pinpoint.ApnsVoipChannelArgs{
	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"),
})

    var apnsVoipChannelResource = new ApnsVoipChannel("apnsVoipChannelResource", ApnsVoipChannelArgs.builder()
    .applicationId("string")
    .bundleId("string")
    .certificate("string")
    .defaultAuthenticationMethod("string")
    .enabled(false)
    .privateKey("string")
    .teamId("string")
    .tokenKey("string")
    .tokenKeyId("string")
    .build());

    apns_voip_channel_resource = aws.pinpoint.ApnsVoipChannel("apnsVoipChannelResource",
    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")

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

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

    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

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

    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.

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

    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 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 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 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 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 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 Channel using the application-id. For example:

    $ pulumi import aws:pinpoint/apnsVoipChannel:ApnsVoipChannel apns_voip 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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws