Amplify Toolbox
    Preparing search index...

    Type Alias NotificationsFactoryProps

    NotificationsFactoryProps:
        | { apns?: ApnsChannelProps; domainName: string; fcm?: FcmChannelProps }
        | {
            apns?: ApnsChannelProps;
            domainName?: undefined;
            expirationDays?: number;
            fcm?: FcmChannelProps;
            instanceAlias?: string;
        }

    Properties accepted by defineNotifications.

    A DISCRIMINATED UNION on domainName: expirationDays / instanceAlias are meaningful ONLY when creating a new domain, so they cannot be combined with an domainName (attach mode). Calling defineNotifications() with no arguments is the zero-config default (create-from-scratch).

    Type Declaration

    • { apns?: ApnsChannelProps; domainName: string; fcm?: FcmChannelProps }
      • Optionalapns?: ApnsChannelProps

        OPTIONAL APNs (Apple) push-channel configuration. When provided, the APNs channel is enabled on the created End User Messaging (Pinpoint) application using token (.p8) authentication, with the key material sourced from an Amplify secret(). When omitted, the APNs channel is left unset.

      • domainName: string

        Name of an EXISTING Amazon Connect Customer Profiles domain to attach to — e.g. the domain Amazon Connect auto-creates (amazon-connect-<instance>) when Customer Profiles is enabled on your instance. The resource ATTACHES: it registers the object type INTO this existing domain additively and never creates an instance or a domain. (Device records live in a DynamoDB table, not in Customer Profiles.)

      • Optionalfcm?: FcmChannelProps

        OPTIONAL FCM/GCM (Android) push-channel configuration. When provided, the GCM channel is enabled on the created End User Messaging (Pinpoint) application using FCM HTTP v1 authentication, with the service-account credential sourced from an Amplify secret(). When omitted, the GCM channel is left unset.

    • {
          apns?: ApnsChannelProps;
          domainName?: undefined;
          expirationDays?: number;
          fcm?: FcmChannelProps;
          instanceAlias?: string;
      }
      • Optionalapns?: ApnsChannelProps

        OPTIONAL APNs (Apple) push-channel configuration. When provided, the APNs channel is enabled on the created End User Messaging (Pinpoint) application using token (.p8) authentication, with the key material sourced from an Amplify secret(). When omitted, the APNs channel is left unset.

      • OptionaldomainName?: undefined

        CREATE mode: domainName MUST be omitted.

      • OptionalexpirationDays?: number

        CREATE mode only: profile / object-type expiration in days.

        366
      • Optionalfcm?: FcmChannelProps

        OPTIONAL FCM/GCM (Android) push-channel configuration. When provided, the GCM channel is enabled on the created End User Messaging (Pinpoint) application using FCM HTTP v1 authentication, with the service-account credential sourced from an Amplify secret(). When omitted, the GCM channel is left unset.

      • OptionalinstanceAlias?: string

        CREATE mode only: override the auto-generated Amazon Connect instance alias. When omitted, a deterministic-yet-unique alias is derived from the app so it is stable across deploy/delete and unique per app.

    Settings

    Member Visibility