Docs
PackagesTry AWS Native preview for resources not in the classic version.
aws.pinpoint.ApnsVoipSandboxChannel
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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
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 apnsVoipSandbox = new Aws.Pinpoint.ApnsVoipSandboxChannel("apnsVoipSandbox", 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/v6/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.NewApnsVoipSandboxChannel(ctx, "apnsVoipSandbox", &pinpoint.ApnsVoipSandboxChannelArgs{
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.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(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_sandbox = aws.pinpoint.ApnsVoipSandboxChannel("apnsVoipSandbox",
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 apnsVoipSandbox = new aws.pinpoint.ApnsVoipSandboxChannel("apnsVoipSandbox", {
applicationId: app.applicationId,
certificate: fs.readFileSync("./certificate.pem"),
privateKey: fs.readFileSync("./private_key.key"),
});
resources:
apnsVoipSandbox:
type: aws:pinpoint:ApnsVoipSandboxChannel
properties:
applicationId: ${app.applicationId}
certificate:
fn::readFile: ./certificate.pem
privateKey:
fn::readFile: ./private_key.key
app:
type: aws:pinpoint:App
Create ApnsVoipSandboxChannel Resource
new ApnsVoipSandboxChannel(name: string, args: ApnsVoipSandboxChannelArgs, opts?: CustomResourceOptions);@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)
@overload
def ApnsVoipSandboxChannel(resource_name: str,
args: ApnsVoipSandboxChannelArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args ApnsVoipSandboxChannelArgs
- 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 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 string
- The unique name of the resource.
- args ApnsVoipSandboxChannelArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApnsVoipSandboxChannelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApnsVoipSandboxChannelArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The ApnsVoipSandboxChannel resource accepts the following input properties:
- Application
Id string The application ID.
- Bundle
Id 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.
- Default
Authentication stringMethod 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 string The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- Team
Id string The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- Token
Key string The
.p8file that you download from your Apple developer account when you create an authentication key.- Token
Key stringId 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 string The application ID.
- Bundle
Id 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.
- Default
Authentication stringMethod 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 string The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- Team
Id string The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- Token
Key string The
.p8file that you download from your Apple developer account when you create an authentication key.- Token
Key stringId 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 String The application ID.
- bundle
Id 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.
- default
Authentication StringMethod 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.- private
Key String The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- team
Id String The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- token
Key String The
.p8file that you download from your Apple developer account when you create an authentication key.- token
Key StringId 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 string The application ID.
- bundle
Id 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.
- default
Authentication stringMethod 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.- private
Key string The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- team
Id string The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- token
Key string The
.p8file that you download from your Apple developer account when you create an authentication key.- token
Key stringId 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_ strmethod 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.
.keyfile).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
.p8file that you download from your Apple developer account when you create an authentication key.- token_
key_ strid 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 String The application ID.
- bundle
Id 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.
- default
Authentication StringMethod 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.- private
Key String The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- team
Id String The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- token
Key String The
.p8file that you download from your Apple developer account when you create an authentication key.- token
Key StringId 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) -> ApnsVoipSandboxChannelfunc 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)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.
- Application
Id string The application ID.
- Bundle
Id 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.
- Default
Authentication stringMethod 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 string The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- Team
Id string The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- Token
Key string The
.p8file that you download from your Apple developer account when you create an authentication key.- Token
Key stringId 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 string The application ID.
- Bundle
Id 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.
- Default
Authentication stringMethod 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 string The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- Team
Id string The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- Token
Key string The
.p8file that you download from your Apple developer account when you create an authentication key.- Token
Key stringId 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 String The application ID.
- bundle
Id 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.
- default
Authentication StringMethod 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.- private
Key String The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- team
Id String The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- token
Key String The
.p8file that you download from your Apple developer account when you create an authentication key.- token
Key StringId 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 string The application ID.
- bundle
Id 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.
- default
Authentication stringMethod 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.- private
Key string The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- team
Id string The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- token
Key string The
.p8file that you download from your Apple developer account when you create an authentication key.- token
Key stringId 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_ strmethod 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.
.keyfile).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
.p8file that you download from your Apple developer account when you create an authentication key.- token_
key_ strid 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 String The application ID.
- bundle
Id 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.
- default
Authentication StringMethod 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.- private
Key String The Certificate Private Key file (ie.
.keyfile).If you choose to use Key credentials you will have to provide:
- team
Id String The ID assigned to your Apple developer account team. This value is provided on the Membership page.
- token
Key String The
.p8file that you download from your Apple developer account when you create an authentication key.- token
Key StringId The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.
Import
In TODO v1.5.0 and later, use an import block to import Pinpoint APNs VoIP Sandbox Channel using the application-id. For exampleterraform import {
to = aws_pinpoint_apns_voip_sandbox_channel.apns_voip_sandbox
id = “application-id” } Using TODO import, import Pinpoint APNs VoIP Sandbox Channel using the application-id. For exampleconsole % TODO import aws_pinpoint_apns_voip_sandbox_channel.apns_voip_sandbox application-id
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
awsTerraform Provider.
Try AWS Native preview for resources not in the classic version.