Class CfnAPNSChannel

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAPNSChannel

Implements

IInspectable

IAPNSChannelRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAPNSChannel : CfnResource, IInspectable, IAPNSChannelRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnAPNSChannel Inherits CfnResource Implements IInspectable, IAPNSChannelRef, IConstruct, IDependable, IEnvironmentAware

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

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 cfnAPNSChannel = new CfnAPNSChannel(this, "MyCfnAPNSChannel", new CfnAPNSChannelProps {
                 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

CfnAPNSChannel(Construct, string, ICfnAPNSChannelProps)

Create a new AWS::Pinpoint::APNSChannel.

Properties

ApnsChannelRef	A reference to a APNSChannel resource.
ApplicationId	The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.
AttrId	(Deprecated) An identifier for the APNs 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 to enable the APNs channel for the application.
PrivateKey	The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
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.
IsCfnAPNSChannel(object)	Checks whether the given object is a CfnAPNSChannel.
RenderProperties(IDictionary<string, object>)	A channel is a type of platform that you can deliver messages to.

Constructors

CfnAPNSChannel(Construct, string, ICfnAPNSChannelProps)

Create a new AWS::Pinpoint::APNSChannel.

public CfnAPNSChannel(Construct scope, string id, ICfnAPNSChannelProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnAPNSChannelProps

Resource properties.

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

Properties

ApnsChannelRef

A reference to a APNSChannel resource.

public virtual IAPNSChannelReference ApnsChannelRef { get; }

Property Value

IAPNSChannelReference

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

ApplicationId

The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.

public virtual string ApplicationId { get; set; }

Property Value

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

AttrId

(Deprecated) An identifier for the APNs channel.

public virtual string AttrId { get; }

Property Value

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

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

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

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

Certificate

The APNs client certificate that you received from Apple.

public virtual string? Certificate { get; set; }

Property Value

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

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

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

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

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

Enabled

Specifies whether to enable the APNs channel for the application.

public virtual object? Enabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

PrivateKey

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

public virtual string? PrivateKey { get; set; }

Property Value

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

TeamId

The identifier that's assigned to your Apple Developer Account team.

public virtual string? TeamId { get; set; }

Property Value

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

TokenKey

The authentication key to use for APNs tokens.

public virtual string? TokenKey { get; set; }

Property Value

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

TokenKeyId

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

public virtual string? TokenKeyId { get; set; }

Property Value

string

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

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 channel to send push notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint application.

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

IsCfnAPNSChannel(object)

Checks whether the given object is a CfnAPNSChannel.

public static bool IsCfnAPNSChannel(object x)

Parameters

x object

Returns

bool

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

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

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

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

CloudformationResource: AWS::Pinpoint::APNSChannel

ExampleMetadata: fixture=_generated

Implements

IInspectable

IAPNSChannelRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware