View a markdown version of this page

AWS::SageMaker::InferenceComponent MetricsEndpoint - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SageMaker::InferenceComponent MetricsEndpoint

Specifies a metrics endpoint for a container, including the path where the container exposes Prometheus-formatted metrics and the frequency at which to publish them to Amazon CloudWatch.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "MetricPublishFrequencyInSeconds" : Integer,
  "MetricsEndpointPath" : String
}

Properties

MetricPublishFrequencyInSeconds

The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch. Valid values: 10, 30, 60, 120, 180, 240, 300. Defaults to 60.

Required: No

Type: Integer

Minimum: 10

Maximum: 300

Update requires: No interruption

MetricsEndpointPath

The path to the metrics endpoint exposed by the container. For example, /metrics or /server/metrics. The path must start with / and can contain alphanumeric characters, forward slashes, underscores, hyphens, and periods. Maximum length is 256 characters. If not specified, defaults to /metrics.

Required: Yes

Type: String

Pattern: ^/(?!.*\.\.)[a-zA-Z0-9/_.\-]+$

Maximum: 256

Update requires: No interruption