Class CfnAPNSChannel

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

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnAPNSChannel

Implements

IInspectable

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(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<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.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

Syntax (vb)

Public Class CfnAPNSChannel
    Inherits CfnResource
    Implements IInspectable

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(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAPNSChannel(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnAPNSChannel(Construct, String, ICfnAPNSChannelProps)

Properties

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.
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 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.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAPNSChannel(ByRefValue)

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

protected CfnAPNSChannel(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnAPNSChannel(DeputyBase.DeputyProps)

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

protected CfnAPNSChannel(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnAPNSChannel(Construct, String, ICfnAPNSChannelProps)

public CfnAPNSChannel(Construct scope, string id, ICfnAPNSChannelProps 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 ICfnAPNSChannelProps: Resource properties.

Properties

ApplicationId

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

public virtual string ApplicationId { get; set; }

Property Value

System.String

AttrId

(Deprecated) An identifier for the APNs 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

CfnResource.CfnProperties

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 to enable the APNs channel 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 APNs.

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

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable