Class CfnAPNSVoipSandboxChannel
A channel is a type of platform that you can deliver messages to.
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.
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(Construct, string, ICfnAPNSVoipSandboxChannelProps) | A channel is a type of platform that you can deliver messages to. |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
Certificate | The APNs client certificate that you received from Apple. |
CfnProperties | A channel is a type of platform that you can deliver messages to. |
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>) | A channel is a type of platform that you can deliver messages to. |
Constructors
CfnAPNSVoipSandboxChannel(Construct, string, ICfnAPNSVoipSandboxChannelProps)
A channel is a type of platform that you can deliver messages to.
public CfnAPNSVoipSandboxChannel(Construct scope, string id, ICfnAPNSVoipSandboxChannelProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnAPNSVoipSandboxChannelProps
Resource properties.
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
Properties
ApplicationId
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
public virtual string ApplicationId { get; set; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
AttrId
(Deprecated) An identifier for the APNs VoIP sandbox channel.
public virtual string AttrId { get; }
Property Value
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
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
Certificate
The APNs client certificate that you received from Apple.
public virtual string? Certificate { get; set; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
CfnProperties
A channel is a type of platform that you can deliver messages to.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
DefaultAuthenticationMethod
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
public virtual string? DefaultAuthenticationMethod { get; set; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
Enabled
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
public virtual object? Enabled { get; set; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
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
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
TeamId
The identifier that's assigned to your Apple developer account team.
public virtual string? TeamId { get; set; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
TokenKey
The authentication key to use for APNs tokens.
public virtual string? TokenKey { get; set; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
TokenKeyId
The key identifier that's assigned to your APNs signing key.
public virtual string? TokenKeyId { get; set; }
Property Value
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
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.
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
A channel is a type of platform that you can deliver messages to.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
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.
CloudformationResource: AWS::Pinpoint::APNSVoipSandboxChannel
ExampleMetadata: fixture=_generated