Variable $MsgVpnDistributedCacheClusterConst

Type declaration

• properties: {
      cacheName: {
          description: "The name of the Distributed Cache.";
          type: "string";
      };
      clusterName: {
          description: "The name of the Cache Cluster.";
          type: "string";
      };
      deliverToOneOverrideEnabled: {
          description: "Enable or disable deliver-to-one override for the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      };
      enabled: {
          description: "Enable or disable the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
          type: "boolean";
      };
      eventDataByteRateThreshold: {
          type: "EventThresholdByValue";
      };
      eventDataMsgRateThreshold: {
          type: "EventThresholdByValue";
      };
      eventMaxMemoryThreshold: {
          type: "EventThresholdByPercent";
      };
      eventMaxTopicsThreshold: {
          type: "EventThresholdByPercent";
      };
      eventRequestQueueDepthThreshold: {
          type: "EventThresholdByPercent";
      };
      eventRequestRateThreshold: {
          type: "EventThresholdByValue";
      };
      eventResponseRateThreshold: {
          type: "EventThresholdByValue";
      };
      globalCachingEnabled: {
          description: "Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
          type: "boolean";
      };
      globalCachingHeartbeat: {
          description: "The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
          format: "int64";
          type: "number";
      };
      globalCachingTopicLifetime: {
          description: "The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`.";
          format: "int64";
          type: "number";
      };
      maxMemory: {
          description: "The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`.";
          format: "int64";
          type: "number";
      };
      maxMsgsPerTopic: {
          description: "The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.";
          format: "int64";
          type: "number";
      };
      maxRequestQueueDepth: {
          description: "The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`.";
          format: "int64";
          type: "number";
      };
      maxTopicCount: {
          description: "The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000000`.";
          format: "int64";
          type: "number";
      };
      msgLifetime: {
          description: "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
          format: "int64";
          type: "number";
      };
      msgVpnName: {
          description: "The name of the Message VPN.";
          type: "string";
      };
      newTopicAdvertisementEnabled: {
          description: "Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
          type: "boolean";
      };
  }

  • cacheName: {
        description: "The name of the Distributed Cache.";
        type: "string";
    }

    • description: "The name of the Distributed Cache."

    • type: "string"

  • clusterName: {
        description: "The name of the Cache Cluster.";
        type: "string";
    }

    • description: "The name of the Cache Cluster."

    • type: "string"

  • deliverToOneOverrideEnabled: {
        description: "Enable or disable deliver-to-one override for the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
        type: "boolean";
    }

    • description: "Enable or disable deliver-to-one override for the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."

    • type: "boolean"

  • enabled: {
        description: "Enable or disable the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."

    • type: "boolean"

  • eventDataByteRateThreshold: {
        type: "EventThresholdByValue";
    }

    • type: "EventThresholdByValue"

  • eventDataMsgRateThreshold: {
        type: "EventThresholdByValue";
    }

    • type: "EventThresholdByValue"

  • eventMaxMemoryThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • eventMaxTopicsThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • eventRequestQueueDepthThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • eventRequestRateThreshold: {
        type: "EventThresholdByValue";
    }

    • type: "EventThresholdByValue"

  • eventResponseRateThreshold: {
        type: "EventThresholdByValue";
    }

    • type: "EventThresholdByValue"

  • globalCachingEnabled: {
        description: "Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."

    • type: "boolean"

  • globalCachingHeartbeat: {
        description: "The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
        format: "int64";
        type: "number";
    }

    • description: "The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`."

    • format: "int64"

    • type: "number"

  • globalCachingTopicLifetime: {
        description: "The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`.";
        format: "int64";
        type: "number";
    }

    • description: "The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`."

    • format: "int64"

    • type: "number"

  • maxMemory: {
        description: "The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`."

    • format: "int64"

    • type: "number"

  • maxMsgsPerTopic: {
        description: "The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`."

    • format: "int64"

    • type: "number"

  • maxRequestQueueDepth: {
        description: "The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`."

    • format: "int64"

    • type: "number"

  • maxTopicCount: {
        description: "The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000000`.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum number of topics for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000000`."

    • format: "int64"

    • type: "number"

  • msgLifetime: {
        description: "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
        format: "int64";
        type: "number";
    }

    • description: "The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`."

    • format: "int64"

    • type: "number"

  • msgVpnName: {
        description: "The name of the Message VPN.";
        type: "string";
    }

    • description: "The name of the Message VPN."

    • type: "string"

  • newTopicAdvertisementEnabled: {
        description: "Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."

    • type: "boolean"