Class CfnAPNSVoipSandboxChannel

A channel is a type of platform that you can deliver messages to.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnAPNSVoipSandboxChannel
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAPNSVoipSandboxChannel : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAPNSVoipSandboxChannel
    Inherits CfnResource
    Implements IInspectable
Remarks

You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint application.

The APNSVoipSandboxChannel resource represents the status and authentication settings of the APNs VoIP sandbox channel for an application.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html

CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var cfnAPNSVoipSandboxChannel = new CfnAPNSVoipSandboxChannel(this, "MyCfnAPNSVoipSandboxChannel", new CfnAPNSVoipSandboxChannelProps {
    ApplicationId = "applicationId",

    // the properties below are optional
    BundleId = "bundleId",
    Certificate = "certificate",
    DefaultAuthenticationMethod = "defaultAuthenticationMethod",
    Enabled = false,
    PrivateKey = "privateKey",
    TeamId = "teamId",
    TokenKey = "tokenKey",
    TokenKeyId = "tokenKeyId"
});

Synopsis

Constructors

CfnAPNSVoipSandboxChannel(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAPNSVoipSandboxChannel(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnAPNSVoipSandboxChannel(Construct, String, ICfnAPNSVoipSandboxChannelProps)

Properties

ApplicationId

The unique identifier for the application that the APNs VoIP sandbox channel applies to.
AttrId

(Deprecated) An identifier for the APNs VoIP sandbox channel.
BundleId

The bundle identifier that's assigned to your iOS app.
Certificate

The APNs client certificate that you received from Apple.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
DefaultAuthenticationMethod

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
Enabled

Specifies whether the APNs VoIP sandbox channel is enabled for the application.
PrivateKey

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
TeamId

The identifier that's assigned to your Apple developer account team.
TokenKey

The authentication key to use for APNs tokens.
TokenKeyId

The key identifier that's assigned to your APNs signing key.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAPNSVoipSandboxChannel(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAPNSVoipSandboxChannel(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnAPNSVoipSandboxChannel(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAPNSVoipSandboxChannel(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnAPNSVoipSandboxChannel(Construct, String, ICfnAPNSVoipSandboxChannelProps)

public CfnAPNSVoipSandboxChannel(Construct scope, string id, ICfnAPNSVoipSandboxChannelProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnAPNSVoipSandboxChannelProps

Resource properties.

Properties

ApplicationId

The unique identifier for the application that the APNs VoIP sandbox channel applies to.

public virtual string ApplicationId { get; set; }
Property Value

System.String

AttrId

(Deprecated) An identifier for the APNs VoIP sandbox channel.

public virtual string AttrId { get; }
Property Value

System.String

Remarks

This property is retained only for backward compatibility.

CloudformationAttribute: Id

BundleId

The bundle identifier that's assigned to your iOS app.

public virtual string BundleId { get; set; }
Property Value

System.String

Certificate

The APNs client certificate that you received from Apple.

public virtual string Certificate { get; set; }
Property Value

System.String

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

DefaultAuthenticationMethod

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

public virtual string DefaultAuthenticationMethod { get; set; }
Property Value

System.String

Enabled

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

public virtual object Enabled { get; set; }
Property Value

System.Object

PrivateKey

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

public virtual string PrivateKey { get; set; }
Property Value

System.String

TeamId

The identifier that's assigned to your Apple developer account team.

public virtual string TeamId { get; set; }
Property Value

System.String

TokenKey

The authentication key to use for APNs tokens.

public virtual string TokenKey { get; set; }
Property Value

System.String

TokenKeyId

The key identifier that's assigned to your APNs signing key.

public virtual string TokenKeyId { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements