aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,113 lines • 209 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* 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 {
/**
* 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;
/**
* (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The unique identifier for the Amazon Pinpoint application that the ADM channel applies to.
*/
applicationId: string;
/**
* The Client ID that you received from Amazon to send messages by using ADM.
*/
clientId: string;
/**
* The Client Secret that you received from Amazon to send messages by using ADM.
*/
clientSecret: string;
/**
* Specifies whether to enable the ADM channel for the application.
*/
enabled?: boolean | cdk.IResolvable;
/**
* @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);
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 {
/**
* 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;
/**
* (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.
*/
applicationId: string;
/**
* The bundle identifier that's assigned to your iOS app.
*/
bundleId?: string;
/**
* The APNs client certificate that you received from Apple.
*/
certificate?: string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
*/
defaultAuthenticationMethod?: string;
/**
* Specifies whether to enable the APNs channel for the application.
*/
enabled?: boolean | cdk.IResolvable;
/**
* The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
*/
privateKey?: string;
/**
* The identifier that's assigned to your Apple Developer Account team.
*/
teamId?: string;
/**
* The authentication key to use for APNs tokens.
*/
tokenKey?: string;
/**
* The key identifier that's assigned to your APNs signing key.
*/
tokenKeyId?: string;
/**
* @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);
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 {
/**
* 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;
/**
* (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to.
*/
applicationId: string;
/**
* The bundle identifier that's assigned to your iOS app.
*/
bundleId?: string;
/**
* The APNs client certificate that you received from Apple.
*/
certificate?: string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
*/
defaultAuthenticationMethod?: string;
/**
* Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application.
*/
enabled?: boolean | cdk.IResolvable;
/**
* The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
*/
privateKey?: string;
/**
* The identifier that's assigned to your Apple Developer Account team.
*/
teamId?: string;
/**
* The authentication key to use for APNs tokens.
*/
tokenKey?: string;
/**
* The key identifier that's assigned to your APNs signing key.
*/
tokenKeyId?: string;
/**
* @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);
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 {
/**
* 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;
/**
* (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
*/
applicationId: string;
/**
* The bundle identifier that's assigned to your iOS app.
*/
bundleId?: string;
/**
* The APNs client certificate that you received from Apple.
*/
certificate?: string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
*/
defaultAuthenticationMethod?: string;
/**
* Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
*/
enabled?: boolean | cdk.IResolvable;
/**
* The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
*/
privateKey?: string;
/**
* The identifier that's assigned to your Apple Developer Account team.
*/
teamId?: string;
/**
* The authentication key to use for APNs tokens.
*/
tokenKey?: string;
/**
* The key identifier that's assigned to your APNs signing key.
*/
tokenKeyId?: string;
/**
* @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);
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 {
/**
* 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;
/**
* (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The unique identifier for the application that the APNs VoIP sandbox channel applies to.
*/
applicationId: string;
/**
* The bundle identifier that's assigned to your iOS app.
*/
bundleId?: string;
/**
* The APNs client certificate that you received from Apple.
*/
certificate?: string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
*/
defaultAuthenticationMethod?: string;
/**
* Specifies whether the APNs VoIP sandbox channel is enabled for the application.
*/
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.
*/
privateKey?: string;
/**
* The identifier that's assigned to your Apple developer account team.
*/
teamId?: string;
/**
* The authentication key to use for APNs tokens.
*/
tokenKey?: string;
/**
* The key identifier that's assigned to your APNs signing key.
*/
tokenKeyId?: string;
/**
* @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);
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, 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;
/**
* The Amazon Resource Name (ARN) of the application.
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* The unique identifier for the application. This identifier is displayed as the *Project ID* on the Amazon Pinpoint console.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The display name of the application.
*/
name: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* An array of key-value pairs to apply to this resource.
*/
tagsRaw?: any;
/**
* @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);
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/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html
*/
export declare class CfnApplicationSettings extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnApplicationSettings 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): CfnApplicationSettings;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The unique identifier for the Amazon Pinpoint application.
*/
applicationId: string;
/**
* The settings for the Lambda function to use by default as a code hook for campaigns in the application.
*/
campaignHook?: CfnApplicationSettings.CampaignHookProperty | cdk.IResolvable;
cloudWatchMetricsEnabled?: boolean | cdk.IResolvable;
/**
* The default sending limits for campaigns in the application.
*/
limits?: cdk.IResolvable | CfnApplicationSettings.LimitsProperty;
/**
* The default quiet time for campaigns in the application.
*/
quietTime?: cdk.IResolvable | CfnApplicationSettings.QuietTimeProperty;
/**
* @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: CfnApplicationSettingsProps);
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>;
}
export declare namespace CfnApplicationSettings {
/**
* Specifies the start and end times that define a time range when messages aren't sent to endpoints.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html
*/
interface QuietTimeProperty {
/**
* The specific time when quiet time ends.
*
* This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-end
*/
readonly end: string;
/**
* The specific time when quiet time begins.
*
* This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-start
*/
readonly start: string;
}
/**
* Specifies the default sending limits for campaigns in the application.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html
*/
interface LimitsProperty {
/**
* The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
*
* The maximum value is 100.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-daily
*/
readonly daily?: number;
/**
* The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
*
* The minimum value is 60 seconds.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-maximumduration
*/
readonly maximumDuration?: number;
/**
* The maximum number of messages that a campaign can send each second.
*
* The minimum value is 1. The maximum value is 20,000.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-messagespersecond
*/
readonly messagesPerSecond?: number;
/**
* The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.
*
* The maximum value is 100.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-total
*/
readonly total?: number;
}
/**
* Specifies the Lambda function to use by default as a code hook for campaigns in the application.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html
*/
interface CampaignHookProperty {
/**
* The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-lambdafunctionname
*/
readonly lambdaFunctionName?: string;
/**
* The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:.
*
* - `FILTER` - Invoke the function to customize the segment that's used by a campaign.
* - `DELIVERY` - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the `CustomDeliveryConfiguration` and `CampaignCustomMessage` objects of the campaign.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-mode
*/
readonly mode?: string;
/**
* The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-weburl
*/
readonly webUrl?: string;
}
}
/**
* Properties for defining a `CfnApplicationSettings`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html
*/
export interface CfnApplicationSettingsProps {
/**
* The unique identifier for the Amazon Pinpoint application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-applicationid
*/
readonly applicationId: string;
/**
* The settings for the Lambda function to use by default as a code hook for campaigns in the application.
*
* To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-campaignhook
*/
readonly campaignHook?: CfnApplicationSettings.CampaignHookProperty | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-cloudwatchmetricsenabled
*/
readonly cloudWatchMetricsEnabled?: boolean | cdk.IResolvable;
/**
* The default sending limits for campaigns in the application.
*
* To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-limits
*/
readonly limits?: cdk.IResolvable | CfnApplicationSettings.LimitsProperty;
/**
* The default quiet time for campaigns in the application.
*
* Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
*
* - The `EndpointDemographic.Timezone` property of the endpoint is set to a valid value.
*
* - The current time in the endpoint's time zone is later than or equal to the time specified by the `QuietTime.Start` property for the application (or a campaign that has custom quiet time settings).
*
* - The current time in the endpoint's time zone is earlier than or equal to the time specified by the `QuietTime.End` property for the application (or a campaign that has custom quiet time settings).
*
* If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
*
* To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-quiettime
*/
readonly quietTime?: cdk.IResolvable | CfnApplicationSettings.QuietTimeProperty;
}
/**
* A *channel* is a type of platform that you can deliver messages to.
*
* You can use the Baidu channel to send notifications to the Baidu Cloud Push notification service. Before you can use Amazon Pinpoint to send notifications to the Baidu Cloud Push service, you have to enable the Baidu channel for an Amazon Pinpoint application.
*
* The BaiduChannel resource represents the status and authentication settings of the Baidu channel for an application.
*
* @cloudformationResource AWS::Pinpoint::BaiduChannel
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html
*/
export declare class CfnBaiduChannel extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnBaiduChannel 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): CfnBaiduChannel;
/**
* (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
*
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The API key that you received from the Baidu Cloud Push service to communicate with the service.
*/
apiKey: string;
/**
* The unique identifier for the Amazon Pinpoint application that you're configuring the Baidu channel for.
*/
applicationId: string;
/**
* Specifies whether to enable the Baidu channel for the application.
*/
enabled?: boolean | cdk.IResolvable;
/**
* The secret key that you received from the Baidu Cloud Push service to communicate with the service.
*/
secretKey: string;
/**
* @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: CfnBaiduChannelProps);
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 `CfnBaiduChannel`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html
*/
export interface CfnBaiduChannelProps {
/**
* The API key that you received from the Baidu Cloud Push service to communicate with the service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-apikey
*/
readonly apiKey: string;
/**
* The unique identifier for the Amazon Pinpoint application that you're configuring the Baidu channel for.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-applicationid
*/
readonly applicationId: string;
/**
* Specifies whether to enable the Baidu channel for the application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-enabled
*/
readonly enabled?: boolean | cdk.IResolvable;
/**
* The secret key that you