Class 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. Read more about sensitive data in state.

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"),
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ApnsVoipChannel

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Pinpoint

Assembly: Pulumi.Aws.dll

Syntax

public class ApnsVoipChannel : CustomResource

Constructors

ApnsVoipChannel(String, ApnsVoipChannelArgs, CustomResourceOptions)

Create a ApnsVoipChannel resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ApnsVoipChannelArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApplicationId

The application ID.

Declaration

public Output<string> ApplicationId { get; }

Property Value

Type	Description
Output<System.String>

BundleId

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.

Declaration

public Output<string> BundleId { get; }

Property Value

Type	Description
Output<System.String>

Certificate

The pem encoded TLS Certificate from Apple.

Declaration

public Output<string> Certificate { get; }

Property Value

Type	Description
Output<System.String>

DefaultAuthenticationMethod

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.

Declaration

public Output<string> DefaultAuthenticationMethod { get; }

Property Value

Type	Description
Output<System.String>

Enabled

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

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

PrivateKey

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

Declaration

public Output<string> PrivateKey { get; }

Property Value

Type	Description
Output<System.String>

TeamId

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

Declaration

public Output<string> TeamId { get; }

Property Value

Type	Description
Output<System.String>

TokenKey

The .p8 file that you download from your Apple developer account when you create an authentication key.

Declaration

public Output<string> TokenKey { get; }

Property Value

Type	Description
Output<System.String>

TokenKeyId

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

Declaration

public Output<string> TokenKeyId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ApnsVoipChannelState, CustomResourceOptions)

Get an existing ApnsVoipChannel resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ApnsVoipChannel Get(string name, Input<string> id, ApnsVoipChannelState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ApnsVoipChannelState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ApnsVoipChannel