CloudWatch metrics

(Optional) The maximum number of seconds to wait before the component publishes batched metrics for a given namespace. To configure the component to publish metrics as it receives them, which means without batching, specify 0.

The component publishes to CloudWatch after it receives 20 metrics in the same namespace or after the interval that you specify.

This value can be a maximum of 900 seconds.

Default: 10 seconds

(Optional) The maximum number of metrics across all namespaces to save in memory before the component replaces them with newer metrics.

This limit applies when the core device doesn't have a connection to the internet, so the component buffers the metrics to publish later. When the buffer is full, the component replaces the oldest metrics with newer ones. Metrics in a given namespace replace only metrics in the same namespace.

This value must be at least 2,000 metrics.

Default: 5,000 metrics

(Optional) The topic to which the component subscribes to receive messages. If you specify true for PubSubToIoTCore, you can use MQTT wildcards (+ and #) in this topic.

Default: cloudwatch/metric/put

(Optional) The topic to which the component publishes status responses.

Default: cloudwatch/metric/put/status

(Optional) String value that defines whether to publish and subscribe to AWS IoT Core MQTT topics. Supported values are true and false.

Default: false

(Optional) Boolean value that defines whether to use the installer script in this component to install this component's SDK dependencies.

Set this value to false if you want to use a custom script to install dependencies, or if you want to include runtime dependencies in a pre-built Linux image. To use this component, you must install the following libraries, including any dependencies, and make them available to the default Greengrass system user.

Default: true

(Optional) The AWS Region to which to publish CloudWatch metrics. This value overrides the default Region for the core device. This parameter is required only for cross-Region metrics.

(Optional) The object that contains the authorization policy that allows the component to publish and subscribe to the specified topics. If you specify custom values for InputTopic and OutputTopic, you must update the resource values in this object.

Default:

{
  "aws.greengrass.ipc.pubsub": {
    "aws.greengrass.Cloudwatch:pubsub:1": {
      "policyDescription": "Allows access to subscribe to input topics.",
      "operations": [
        "aws.greengrass#SubscribeToTopic"
      ],
      "resources": [
        "cloudwatch/metric/put"
      ]
    },
    "aws.greengrass.Cloudwatch:pubsub:2": {
      "policyDescription": "Allows access to publish to output topics.",
      "operations": [
        "aws.greengrass#PublishToTopic"
      ],
      "resources": [
        "cloudwatch/metric/put/status"
      ]
    }
  },
  "aws.greengrass.ipc.mqttproxy": {
    "aws.greengrass.Cloudwatch:mqttproxy:1": {
      "policyDescription": "Allows access to subscribe to input topics.",
      "operations": [
        "aws.greengrass#SubscribeToIoTCore"
      ],
      "resources": [
        "cloudwatch/metric/put"
      ]
    },
    "aws.greengrass.Cloudwatch:mqttproxy:2": {
      "policyDescription": "Allows access to publish to output topics.",
      "operations": [
        "aws.greengrass#PublishToIoTCore"
      ],
      "resources": [
        "cloudwatch/metric/put/status"
      ]
    }
  }
}

An object that contains the parameters for this component's Lambda function. This object contains the following information:

(Optional) The containerization mode for this component. Choose from the following options:

Default: GreengrassContainer

(Optional) An object that contains the container parameters for this component. The component uses these parameters if you specify GreengrassContainer for containerMode.

This object contains the following information:

(Optional) An object that contains the topics where the component subscribes to receive messages. You can specify each topic and whether the component subscribes to MQTT topics from AWS IoT Core or local publish/subscribe topics.

This object contains the following information: