Amplify Toolbox
    Preparing search index...

    Type Alias NotificationsResources

    CDK resources exposed by AmplifyNotifications.

    type NotificationsResources = {
        apiFunction: lambda.IFunction;
        apnsChannel?: CfnAPNSChannel | CfnAPNSSandboxChannel;
        connectInstance?: CfnInstance;
        devicesTable: dynamodb.ITable;
        gcmChannel?: CfnGCMChannel;
        httpApi: apigwv2.HttpApi;
        profileObjectType: CfnObjectType;
        profilesDomain?: CfnDomain;
        pushApplication: CfnApp;
        pushFunction: lambda.IFunction;
    }
    Index

    Properties

    apiFunction apnsChannel? connectInstance? devicesTable gcmChannel? httpApi profileObjectType profilesDomain? pushApplication pushFunction

    Properties

    apiFunction: lambda.IFunction

    The write Lambda function backing the three SigV4 API routes.

    apnsChannel?: CfnAPNSChannel | CfnAPNSSandboxChannel

    The APNs channel enabled on the push application, when apnsChannel is configured. undefined when no APNs configuration was provided. Either the production (CfnAPNSChannel) or sandbox (CfnAPNSSandboxChannel) channel, depending on apnsChannel.sandbox.

    connectInstance?: CfnInstance

    The Amazon Connect instance created in create-from-scratch mode (when domainName is omitted). undefined in attach mode.

    devicesTable: dynamodb.ITable

    The DynamoDB Devices table — the authoritative, strongly-consistent device store (PK = deviceId, GSI on principalId, native TTL on ttl).

    gcmChannel?: CfnGCMChannel

    The GCM/FCM channel enabled on the push application, when fcmChannel is configured. undefined when no FCM configuration was provided.

    httpApi: apigwv2.HttpApi

    The HTTP API fronting the three SigV4 write routes.

    profileObjectType: CfnObjectType

    The AmplifyProfile object type registered on the domain.

    profilesDomain?: CfnDomain

    The Customer Profiles domain created in create-from-scratch mode (when domainName is omitted). undefined in attach mode, where the object types are registered into a pre-existing domain the construct does not own.

    pushApplication: CfnApp

    The AWS End User Messaging / Pinpoint application backing push delivery.

    pushFunction: lambda.IFunction

    The push-delivery Lambda function, wired as the target of a Connect Journey Custom-action (Invoke Lambda).

    Settings

    Member Visibility

    On This Page

    Properties