Skip to main content

PutCloudWatchMetric

Description

Publishes metrics to Amazon CloudWatch. Metric can be either a single value, or a StatisticSet comprised of minimum, maximum, sum and sample count.

Tags

amazon, aws, cloudwatch, metrics, publish, put

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Namespace *NamespaceThe namespace for the metric data for CloudWatch

Supports Expression Language, using FlowFile attributes and Environment variables.
Metric Name *MetricNameThe name of the metric

Supports Expression Language, using FlowFile attributes and Environment variables.
Region *RegionUS West (Oregon)
  • AWS GovCloud (US-East)
  • AWS GovCloud (US-West)
  • Africa (Cape Town)
  • Asia Pacific (Hong Kong)
  • Asia Pacific (Hyderabad)
  • Asia Pacific (Jakarta)
  • Asia Pacific (Malaysia)
  • Asia Pacific (Melbourne)
  • Asia Pacific (Mumbai)
  • Asia Pacific (Osaka)
  • Asia Pacific (Seoul)
  • Asia Pacific (Singapore)
  • Asia Pacific (Sydney)
  • Asia Pacific (Tokyo)
  • Canada (Central)
  • Canada West (Calgary)
  • China (Beijing)
  • China (Ningxia)
  • EU ISOE West
  • Europe (Frankfurt)
  • Europe (Ireland)
  • Europe (London)
  • Europe (Milan)
  • Europe (Paris)
  • Europe (Spain)
  • Europe (Stockholm)
  • Europe (Zurich)
  • Israel (Tel Aviv)
  • Middle East (Bahrain)
  • Middle East (UAE)
  • South America (Sao Paulo)
  • US East (N. Virginia)
  • US East (Ohio)
  • US ISO East
  • US ISO WEST
  • US ISOB East (Ohio)
  • US West (N. California)
  • US West (Oregon)
  • aws-cn-global
  • aws-global
  • aws-iso-b-global
  • aws-iso-global
  • aws-us-gov-global
AWS Credentials Provider Service *AWS Credentials Provider serviceController Service:
AWSCredentialsProviderService

Implementations:
AWSCredentialsProviderControllerService
The Controller Service that is used to obtain AWS credentials provider
ValueValueThe value for the metric. Must be a double

Supports Expression Language, using FlowFile attributes and Environment variables.
MaximummaximumThe maximum value of the sample set. Must be a double

Supports Expression Language, using FlowFile attributes and Environment variables.
MinimumminimumThe minimum value of the sample set. Must be a double

Supports Expression Language, using FlowFile attributes and Environment variables.
Sample CountsampleCountThe number of samples used for the statistic set. Must be a double

Supports Expression Language, using FlowFile attributes and Environment variables.
SumsumThe sum of values for the sample set. Must be a double

Supports Expression Language, using FlowFile attributes and Environment variables.
TimestampTimestampA point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If not specified, the default value is set to the time the metric data was received

Supports Expression Language, using FlowFile attributes and Environment variables.
UnitUnitThe unit of the metric. (e.g Seconds, Bytes, Megabytes, Percent, Count, Kilobytes/Second, Terabits/Second, Count/Second) For details see http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html

Supports Expression Language, using FlowFile attributes and Environment variables.
Communications Timeout *Communications Timeout30 secs
SSL Context ServiceSSL Context ServiceController Service:
SSLContextService

Implementations:
StandardRestrictedSSLContextService
StandardSSLContextService
Specifies an optional SSL Context Service that, if provided, will be used to create connections
Endpoint Override URLEndpoint Override URLEndpoint URL to use instead of the AWS default including scheme, host, port, and path. The AWS libraries select an endpoint URL based on the AWS region, but this property overrides the selected endpoint URL, allowing use with other S3-compatible endpoints.

Supports Expression Language, using Environment variables.
Proxy Configuration Serviceproxy-configuration-serviceController Service:
ProxyConfigurationService

Implementations:
StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Dynamic Properties

NameValueDescription
Dimension NameDimension ValueAllows dimension name/value pairs to be added to the metric. AWS supports a maximum of 10 dimensions.

Supports Expression Language: Yes, evaluated using FlowFile Attributes and Environment variables.

Relationships

NameDescription
failureFlowFiles are routed to failure relationship
successFlowFiles are routed to success relationship

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

This component requires an incoming relationship.

System Resource Considerations

This component does not specify system resource considerations.

See Also