Amplify Toolbox
    Preparing search index...

    Type Alias AmplifyNotificationsProps

    Properties for the framework-agnostic AmplifyNotifications CDK construct. Selects attach vs. create-from-scratch mode (via domainName) and carries the optional APNs / FCM push-channel configuration and create-mode tuning (instanceAlias, expirationDays). All values are plain (non-secret) inputs; the defineNotifications Gen2 factory resolves any Amplify secret() values before constructing this.

    type AmplifyNotificationsProps = {
        apnsChannel?: {
            bundleId: string;
            sandbox?: boolean;
            teamId: string;
            tokenKey: string;
            tokenKeyId: string;
        };
        domainName?: string;
        expirationDays?: number;
        fcmChannel?: { serviceJson: string };
        instanceAlias?: string;
    }
    Index

    Properties

    apnsChannel? domainName? expirationDays? fcmChannel? instanceAlias?

    Properties

    apnsChannel?: {
        bundleId: string;
        sandbox?: boolean;
        teamId: string;
        tokenKey: string;
        tokenKeyId: string;
    }

    OPTIONAL APNs channel configuration (token / .p8 auth). When provided, the construct enables the APNs channel on the created End User Messaging (Pinpoint) application. All values are plain strings — the Amplify Gen2 factory resolves the .p8 key from an Amplify secret() before passing it here, keeping this construct framework-agnostic. When omitted, no APNs channel is configured.

    Type Declaration

    • ReadonlybundleId: string

      The iOS app bundle identifier.

    • Optional Readonlysandbox?: boolean

      Configure the APNs sandbox channel instead of the production channel.

      false
    • ReadonlyteamId: string

      The Apple Developer account team identifier.

    • ReadonlytokenKey: string

      The APNs token signing key contents (the AuthKey_<tokenKeyId>.p8 file).

    • ReadonlytokenKeyId: string

      The 10-character key identifier assigned to the APNs signing key (CFN TokenKeyId).

    domainName?: string

    Name of an EXISTING Customer Profiles domain to attach to — e.g. the domain Amazon Connect auto-creates when Customer Profiles is enabled on an instance. When provided, the construct runs in ATTACH mode: it registers the AmplifyProfile object type INTO this domain and never creates an instance or a domain.

    OMIT this to run in the default CREATE-FROM-SCRATCH mode: the construct provisions a brand-new Amazon Connect instance AND a brand-new Customer Profiles domain (with generated, stable names) and wires everything into that new domain — so a caller needs zero pre-existing Connect setup.

    expirationDays?: number

    Profile / object-type expiration in days. Default: 366.

    fcmChannel?: { serviceJson: string }

    OPTIONAL FCM/GCM channel configuration (FCM HTTP v1 auth). When provided, the construct enables the GCM channel on the created End User Messaging (Pinpoint) application. The value is a plain string — the Amplify Gen2 factory resolves the service-account JSON from an Amplify secret() before passing it here. When omitted, no GCM channel is configured.

    Type Declaration

    • ReadonlyserviceJson: string

      The FCM HTTP v1 service-account JSON credential contents.

    instanceAlias?: string

    CREATE mode only: override the auto-generated Amazon Connect instance alias. Ignored in attach mode. When omitted, a deterministic-yet-unique alias is derived from the construct's scope so it is stable across deploy/delete and unique per app. Lowercase alphanumeric characters + hyphens; must not start with d-.

    Settings

    Member Visibility

    On This Page

    Properties