UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,207 lines 254 kB
import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { ADMChannelReference, APNSChannelReference, APNSSandboxChannelReference, APNSVoipChannelReference, APNSVoipSandboxChannelReference, ApplicationSettingsReference, AppReference, BaiduChannelReference, CampaignReference, EmailChannelReference, EmailTemplateReference, EventStreamReference, GCMChannelReference, IADMChannelRef, IAPNSChannelRef, IAPNSSandboxChannelRef, IAPNSVoipChannelRef, IAPNSVoipSandboxChannelRef, IApplicationSettingsRef, IAppRef, IBaiduChannelRef, ICampaignRef, IEmailChannelRef, IEmailTemplateRef, IEventStreamRef, IGCMChannelRef, IInAppTemplateRef, InAppTemplateReference, IPushTemplateRef, ISegmentRef, ISMSChannelRef, ISmsTemplateRef, IVoiceChannelRef, PushTemplateReference, SegmentReference, SMSChannelReference, SmsTemplateReference, VoiceChannelReference } from "../../interfaces/generated/aws-pinpoint-interfaces.generated"; /** * A *channel* is a type of platform that you can deliver messages to. * * You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM) service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application. * * The ADMChannel resource represents the status and authentication settings for the ADM channel for an application. * * @cloudformationResource AWS::Pinpoint::ADMChannel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html */ export declare class CfnADMChannel extends cdk.CfnResource implements cdk.IInspectable, IADMChannelRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnADMChannel from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnADMChannel; /** * Checks whether the given object is a CfnADMChannel */ static isCfnADMChannel(x: any): x is CfnADMChannel; /** * The unique identifier for the Amazon Pinpoint application that the ADM channel applies to. */ private _applicationId; /** * The Client ID that you received from Amazon to send messages by using ADM. */ private _clientId; /** * The Client Secret that you received from Amazon to send messages by using ADM. */ private _clientSecret; /** * Specifies whether to enable the ADM channel for the application. */ private _enabled?; /** * Create a new `AWS::Pinpoint::ADMChannel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnADMChannelProps); get admChannelRef(): ADMChannelReference; /** * The unique identifier for the Amazon Pinpoint application that the ADM channel applies to. */ get applicationId(): string; /** * The unique identifier for the Amazon Pinpoint application that the ADM channel applies to. */ set applicationId(value: string); /** * The Client ID that you received from Amazon to send messages by using ADM. */ get clientId(): string; /** * The Client ID that you received from Amazon to send messages by using ADM. */ set clientId(value: string); /** * The Client Secret that you received from Amazon to send messages by using ADM. */ get clientSecret(): string; /** * The Client Secret that you received from Amazon to send messages by using ADM. */ set clientSecret(value: string); /** * Specifies whether to enable the ADM channel for the application. */ get enabled(): boolean | cdk.IResolvable | undefined; /** * Specifies whether to enable the ADM channel for the application. */ set enabled(value: boolean | cdk.IResolvable | undefined); /** * (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility. * * @cloudformationAttribute Id */ get attrId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnADMChannel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html */ export interface CfnADMChannelProps { /** * The unique identifier for the Amazon Pinpoint application that the ADM channel applies to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-applicationid */ readonly applicationId: string; /** * The Client ID that you received from Amazon to send messages by using ADM. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-clientid */ readonly clientId: string; /** * The Client Secret that you received from Amazon to send messages by using ADM. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-clientsecret */ readonly clientSecret: string; /** * Specifies whether to enable the ADM channel for the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-enabled */ readonly enabled?: boolean | cdk.IResolvable; } /** * A *channel* is a type of platform that you can deliver messages to. * * 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. * * @cloudformationResource AWS::Pinpoint::APNSChannel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html */ export declare class CfnAPNSChannel extends cdk.CfnResource implements cdk.IInspectable, IAPNSChannelRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAPNSChannel from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAPNSChannel; /** * Checks whether the given object is a CfnAPNSChannel */ static isCfnAPNSChannel(x: any): x is CfnAPNSChannel; /** * The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. */ private _applicationId; /** * The bundle identifier that's assigned to your iOS app. */ private _bundleId?; /** * The APNs client certificate that you received from Apple. */ private _certificate?; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ private _defaultAuthenticationMethod?; /** * Specifies whether to enable the APNs channel for the application. */ private _enabled?; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ private _privateKey?; /** * The identifier that's assigned to your Apple Developer Account team. */ private _teamId?; /** * The authentication key to use for APNs tokens. */ private _tokenKey?; /** * The key identifier that's assigned to your APNs signing key. */ private _tokenKeyId?; /** * Create a new `AWS::Pinpoint::APNSChannel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAPNSChannelProps); get apnsChannelRef(): APNSChannelReference; /** * The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. */ get applicationId(): string; /** * The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. */ set applicationId(value: string); /** * The bundle identifier that's assigned to your iOS app. */ get bundleId(): string | undefined; /** * The bundle identifier that's assigned to your iOS app. */ set bundleId(value: string | undefined); /** * The APNs client certificate that you received from Apple. */ get certificate(): string | undefined; /** * The APNs client certificate that you received from Apple. */ set certificate(value: string | undefined); /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ get defaultAuthenticationMethod(): string | undefined; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ set defaultAuthenticationMethod(value: string | undefined); /** * Specifies whether to enable the APNs channel for the application. */ get enabled(): boolean | cdk.IResolvable | undefined; /** * Specifies whether to enable the APNs channel for the application. */ set enabled(value: boolean | cdk.IResolvable | undefined); /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ get privateKey(): string | undefined; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ set privateKey(value: string | undefined); /** * The identifier that's assigned to your Apple Developer Account team. */ get teamId(): string | undefined; /** * The identifier that's assigned to your Apple Developer Account team. */ set teamId(value: string | undefined); /** * The authentication key to use for APNs tokens. */ get tokenKey(): string | undefined; /** * The authentication key to use for APNs tokens. */ set tokenKey(value: string | undefined); /** * The key identifier that's assigned to your APNs signing key. */ get tokenKeyId(): string | undefined; /** * The key identifier that's assigned to your APNs signing key. */ set tokenKeyId(value: string | undefined); /** * (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility. * * @cloudformationAttribute Id */ get attrId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnAPNSChannel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html */ export interface CfnAPNSChannelProps { /** * The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-applicationid */ readonly applicationId: string; /** * The bundle identifier that's assigned to your iOS app. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-bundleid */ readonly bundleId?: string; /** * The APNs client certificate that you received from Apple. * * Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-certificate */ readonly certificate?: string; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. * * Valid options are `key` or `certificate` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-defaultauthenticationmethod */ readonly defaultAuthenticationMethod?: string; /** * Specifies whether to enable the APNs channel for the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-enabled */ readonly enabled?: boolean | cdk.IResolvable; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-privatekey */ readonly privateKey?: string; /** * The identifier that's assigned to your Apple Developer Account team. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-teamid */ readonly teamId?: string; /** * The authentication key to use for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-tokenkey */ readonly tokenKey?: string; /** * The key identifier that's assigned to your APNs signing key. * * Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-tokenkeyid */ readonly tokenKeyId?: string; } /** * A *channel* is a type of platform that you can deliver messages to. * * You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint application. * * The APNSSandboxChannel resource represents the status and authentication settings of the APNs sandbox channel for an application. * * @cloudformationResource AWS::Pinpoint::APNSSandboxChannel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html */ export declare class CfnAPNSSandboxChannel extends cdk.CfnResource implements cdk.IInspectable, IAPNSSandboxChannelRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAPNSSandboxChannel from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAPNSSandboxChannel; /** * Checks whether the given object is a CfnAPNSSandboxChannel */ static isCfnAPNSSandboxChannel(x: any): x is CfnAPNSSandboxChannel; /** * The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to. */ private _applicationId; /** * The bundle identifier that's assigned to your iOS app. */ private _bundleId?; /** * The APNs client certificate that you received from Apple. */ private _certificate?; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ private _defaultAuthenticationMethod?; /** * Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. */ private _enabled?; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ private _privateKey?; /** * The identifier that's assigned to your Apple Developer Account team. */ private _teamId?; /** * The authentication key to use for APNs tokens. */ private _tokenKey?; /** * The key identifier that's assigned to your APNs signing key. */ private _tokenKeyId?; /** * Create a new `AWS::Pinpoint::APNSSandboxChannel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAPNSSandboxChannelProps); get apnsSandboxChannelRef(): APNSSandboxChannelReference; /** * The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to. */ get applicationId(): string; /** * The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to. */ set applicationId(value: string); /** * The bundle identifier that's assigned to your iOS app. */ get bundleId(): string | undefined; /** * The bundle identifier that's assigned to your iOS app. */ set bundleId(value: string | undefined); /** * The APNs client certificate that you received from Apple. */ get certificate(): string | undefined; /** * The APNs client certificate that you received from Apple. */ set certificate(value: string | undefined); /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ get defaultAuthenticationMethod(): string | undefined; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ set defaultAuthenticationMethod(value: string | undefined); /** * Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. */ get enabled(): boolean | cdk.IResolvable | undefined; /** * Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. */ set enabled(value: boolean | cdk.IResolvable | undefined); /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ get privateKey(): string | undefined; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ set privateKey(value: string | undefined); /** * The identifier that's assigned to your Apple Developer Account team. */ get teamId(): string | undefined; /** * The identifier that's assigned to your Apple Developer Account team. */ set teamId(value: string | undefined); /** * The authentication key to use for APNs tokens. */ get tokenKey(): string | undefined; /** * The authentication key to use for APNs tokens. */ set tokenKey(value: string | undefined); /** * The key identifier that's assigned to your APNs signing key. */ get tokenKeyId(): string | undefined; /** * The key identifier that's assigned to your APNs signing key. */ set tokenKeyId(value: string | undefined); /** * (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility. * * @cloudformationAttribute Id */ get attrId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnAPNSSandboxChannel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html */ export interface CfnAPNSSandboxChannelProps { /** * The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-applicationid */ readonly applicationId: string; /** * The bundle identifier that's assigned to your iOS app. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-bundleid */ readonly bundleId?: string; /** * The APNs client certificate that you received from Apple. * * Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-certificate */ readonly certificate?: string; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. * * Valid options are `key` or `certificate` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-defaultauthenticationmethod */ readonly defaultAuthenticationMethod?: string; /** * Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-enabled */ readonly enabled?: boolean | cdk.IResolvable; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-privatekey */ readonly privateKey?: string; /** * The identifier that's assigned to your Apple Developer Account team. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-teamid */ readonly teamId?: string; /** * The authentication key to use for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-tokenkey */ readonly tokenKey?: string; /** * The key identifier that's assigned to your APNs signing key. * * Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-tokenkeyid */ readonly tokenKeyId?: string; } /** * A *channel* is a type of platform that you can deliver messages to. * * You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint application. * * The APNSVoipChannel resource represents the status and authentication settings of the APNs VoIP channel for an application. * * @cloudformationResource AWS::Pinpoint::APNSVoipChannel * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html */ export declare class CfnAPNSVoipChannel extends cdk.CfnResource implements cdk.IInspectable, IAPNSVoipChannelRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAPNSVoipChannel from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAPNSVoipChannel; /** * Checks whether the given object is a CfnAPNSVoipChannel */ static isCfnAPNSVoipChannel(x: any): x is CfnAPNSVoipChannel; /** * The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to. */ private _applicationId; /** * The bundle identifier that's assigned to your iOS app. */ private _bundleId?; /** * The APNs client certificate that you received from Apple. */ private _certificate?; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ private _defaultAuthenticationMethod?; /** * Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. */ private _enabled?; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ private _privateKey?; /** * The identifier that's assigned to your Apple Developer Account team. */ private _teamId?; /** * The authentication key to use for APNs tokens. */ private _tokenKey?; /** * The key identifier that's assigned to your APNs signing key. */ private _tokenKeyId?; /** * Create a new `AWS::Pinpoint::APNSVoipChannel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAPNSVoipChannelProps); get apnsVoipChannelRef(): APNSVoipChannelReference; /** * The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to. */ get applicationId(): string; /** * The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to. */ set applicationId(value: string); /** * The bundle identifier that's assigned to your iOS app. */ get bundleId(): string | undefined; /** * The bundle identifier that's assigned to your iOS app. */ set bundleId(value: string | undefined); /** * The APNs client certificate that you received from Apple. */ get certificate(): string | undefined; /** * The APNs client certificate that you received from Apple. */ set certificate(value: string | undefined); /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ get defaultAuthenticationMethod(): string | undefined; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ set defaultAuthenticationMethod(value: string | undefined); /** * Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. */ get enabled(): boolean | cdk.IResolvable | undefined; /** * Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. */ set enabled(value: boolean | cdk.IResolvable | undefined); /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ get privateKey(): string | undefined; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. */ set privateKey(value: string | undefined); /** * The identifier that's assigned to your Apple Developer Account team. */ get teamId(): string | undefined; /** * The identifier that's assigned to your Apple Developer Account team. */ set teamId(value: string | undefined); /** * The authentication key to use for APNs tokens. */ get tokenKey(): string | undefined; /** * The authentication key to use for APNs tokens. */ set tokenKey(value: string | undefined); /** * The key identifier that's assigned to your APNs signing key. */ get tokenKeyId(): string | undefined; /** * The key identifier that's assigned to your APNs signing key. */ set tokenKeyId(value: string | undefined); /** * (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility. * * @cloudformationAttribute Id */ get attrId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnAPNSVoipChannel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html */ export interface CfnAPNSVoipChannelProps { /** * The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-applicationid */ readonly applicationId: string; /** * The bundle identifier that's assigned to your iOS app. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-bundleid */ readonly bundleId?: string; /** * The APNs client certificate that you received from Apple. * * Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-certificate */ readonly certificate?: string; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. * * Valid options are `key` or `certificate` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-defaultauthenticationmethod */ readonly defaultAuthenticationMethod?: string; /** * Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-enabled */ readonly enabled?: boolean | cdk.IResolvable; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-privatekey */ readonly privateKey?: string; /** * The identifier that's assigned to your Apple Developer Account team. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-teamid */ readonly teamId?: string; /** * The authentication key to use for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkey */ readonly tokenKey?: string; /** * The key identifier that's assigned to your APNs signing key. * * Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkeyid */ readonly tokenKeyId?: string; } /** * A *channel* is a type of platform that you can deliver messages to. * * 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 * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html */ export declare class CfnAPNSVoipSandboxChannel extends cdk.CfnResource implements cdk.IInspectable, IAPNSVoipSandboxChannelRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAPNSVoipSandboxChannel from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAPNSVoipSandboxChannel; /** * Checks whether the given object is a CfnAPNSVoipSandboxChannel */ static isCfnAPNSVoipSandboxChannel(x: any): x is CfnAPNSVoipSandboxChannel; /** * The unique identifier for the application that the APNs VoIP sandbox channel applies to. */ private _applicationId; /** * The bundle identifier that's assigned to your iOS app. */ private _bundleId?; /** * The APNs client certificate that you received from Apple. */ private _certificate?; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ private _defaultAuthenticationMethod?; /** * Specifies whether the APNs VoIP sandbox channel is enabled for the application. */ private _enabled?; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. */ private _privateKey?; /** * The identifier that's assigned to your Apple developer account team. */ private _teamId?; /** * The authentication key to use for APNs tokens. */ private _tokenKey?; /** * The key identifier that's assigned to your APNs signing key. */ private _tokenKeyId?; /** * Create a new `AWS::Pinpoint::APNSVoipSandboxChannel`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAPNSVoipSandboxChannelProps); get apnsVoipSandboxChannelRef(): APNSVoipSandboxChannelReference; /** * The unique identifier for the application that the APNs VoIP sandbox channel applies to. */ get applicationId(): string; /** * The unique identifier for the application that the APNs VoIP sandbox channel applies to. */ set applicationId(value: string); /** * The bundle identifier that's assigned to your iOS app. */ get bundleId(): string | undefined; /** * The bundle identifier that's assigned to your iOS app. */ set bundleId(value: string | undefined); /** * The APNs client certificate that you received from Apple. */ get certificate(): string | undefined; /** * The APNs client certificate that you received from Apple. */ set certificate(value: string | undefined); /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ get defaultAuthenticationMethod(): string | undefined; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. */ set defaultAuthenticationMethod(value: string | undefined); /** * Specifies whether the APNs VoIP sandbox channel is enabled for the application. */ get enabled(): boolean | cdk.IResolvable | undefined; /** * Specifies whether the APNs VoIP sandbox channel is enabled for the application. */ set enabled(value: boolean | cdk.IResolvable | undefined); /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. */ get privateKey(): string | undefined; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. */ set privateKey(value: string | undefined); /** * The identifier that's assigned to your Apple developer account team. */ get teamId(): string | undefined; /** * The identifier that's assigned to your Apple developer account team. */ set teamId(value: string | undefined); /** * The authentication key to use for APNs tokens. */ get tokenKey(): string | undefined; /** * The authentication key to use for APNs tokens. */ set tokenKey(value: string | undefined); /** * The key identifier that's assigned to your APNs signing key. */ get tokenKeyId(): string | undefined; /** * The key identifier that's assigned to your APNs signing key. */ set tokenKeyId(value: string | undefined); /** * (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility. * * @cloudformationAttribute Id */ get attrId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnAPNSVoipSandboxChannel` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html */ export interface CfnAPNSVoipSandboxChannelProps { /** * The unique identifier for the application that the APNs VoIP sandbox channel applies to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-applicationid */ readonly applicationId: string; /** * The bundle identifier that's assigned to your iOS app. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-bundleid */ readonly bundleId?: string; /** * The APNs client certificate that you received from Apple. * * Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-certificate */ readonly certificate?: string; /** * The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. * * Valid options are `key` or `certificate` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-defaultauthenticationmethod */ readonly defaultAuthenticationMethod?: string; /** * Specifies whether the APNs VoIP sandbox channel is enabled for the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-enabled */ readonly enabled?: boolean | cdk.IResolvable; /** * The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-privatekey */ readonly privateKey?: string; /** * The identifier that's assigned to your Apple developer account team. * * This identifier is used for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-teamid */ readonly teamId?: string; /** * The authentication key to use for APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkey */ readonly tokenKey?: string; /** * The key identifier that's assigned to your APNs signing key. * * Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkeyid */ readonly tokenKeyId?: string; } /** * An *app* is an Amazon Pinpoint application, also referred to as a *project* . * * An application is a collection of related settings, customer information, segments, campaigns, and other types of Amazon Pinpoint resources. * * The App resource represents an Amazon Pinpoint application. * * @cloudformationResource AWS::Pinpoint::App * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html */ export declare class CfnApp extends cdk.CfnResource implements cdk.IInspectable, IAppRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnApp from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApp; /** * Checks whether the given object is a CfnApp */ static isCfnApp(x: any): x is CfnApp; /** * Creates a new IAppRef from an ARN */ static fromAppArn(scope: constructs.Construct, id: string, arn: string): IAppRef; /** * Creates a new IAppRef from a appId */ static fromAppId(scope: constructs.Construct, id: string, appId: string): IAppRef; static arnForApp(resource: IAppRef): string; /** * The display name of the application. */ private _name; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * An array of key-value pairs to apply to this resource. */ private _tagsRaw?; /** * Create a new `AWS::Pinpoint::App`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAppProps); get appRef(): AppReference; /** * The display name of the application. */ get name(): string; /** * The display name of the application. */ set name(value: string); /** * An array of key-value pairs to apply to this resource. */ get tagsRaw(): any | undefined; /** * An array of key-value pairs to apply to this resource. */ set tagsRaw(value: any | undefined); /** * The Amazon Resource Name (ARN) of the application. * * @cloudformationAttribute Arn */ get attrArn(): string; /** * The unique identifier for the application. This identifier is displayed as the *Project ID* on the Amazon Pinpoint console. * * @cloudformationAttribute Id */ get attrId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnApp` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html */ export interface CfnAppProps { /** * The display name of the application. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-name */ readonly name: string; /** * An array of key-value pairs to apply to this resource. * * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-tags */ readonly tags?: any; } /** * Specifies the settings for an Amazon Pinpoint application. * * In Amazon Pinpoint, an *application* (also referred to as an *app* or *project* ) is a collection of related settings, customer information, segments, and campaigns, and other types of Amazon Pinpoint resources. * * @cloudformationResource AWS::Pinpoint::ApplicationSettings * @stability external * @see http://docs.aws.amazon.com/AWSClou