Package software.amazon.awscdk.services.sagemaker

Interface CfnInferenceComponent.MetricsEndpointProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInferenceComponent.MetricsEndpointProperty.Jsii$Proxy

Enclosing class:

CfnInferenceComponent

@Stability(Stable)
public static interface CfnInferenceComponent.MetricsEndpointProperty
extends software.amazon.jsii.JsiiSerializable

A metrics endpoint exposed by the container.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 MetricsEndpointProperty metricsEndpointProperty = MetricsEndpointProperty.builder()
         .metricsEndpointPath("metricsEndpointPath")
         // the properties below are optional
         .metricPublishFrequencyInSeconds(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-metricsendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInferenceComponent.MetricsEndpointProperty.Builder	A builder for CfnInferenceComponent.MetricsEndpointProperty
static final class	CfnInferenceComponent.MetricsEndpointProperty.Jsii$Proxy	An implementation for CfnInferenceComponent.MetricsEndpointProperty

Method Summary

Modifier and Type	Method	Description
static CfnInferenceComponent.MetricsEndpointProperty.Builder	builder()
default Number	getMetricPublishFrequencyInSeconds()	The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch.
String	getMetricsEndpointPath()	The path to the Prometheus formatted metrics endpoint exposed by the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricsEndpointPath

@Stability(Stable)
@NotNull
String getMetricsEndpointPath()

The path to the Prometheus formatted metrics endpoint exposed by the container.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-metricsendpoint.html#cfn-sagemaker-inferencecomponent-metricsendpoint-metricsendpointpath

getMetricPublishFrequencyInSeconds

@Stability(Stable)
@Nullable
default Number getMetricPublishFrequencyInSeconds()

The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch.

Valid values per the SageMaker API Reference are 10, 30, 60, 120, 180, 240 and 300; the service validates the value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-inferencecomponent-metricsendpoint.html#cfn-sagemaker-inferencecomponent-metricsendpoint-metricpublishfrequencyinseconds

builder

@Stability(Stable)
static CfnInferenceComponent.MetricsEndpointProperty.Builder builder()

Returns:

a CfnInferenceComponent.MetricsEndpointProperty.Builder of CfnInferenceComponent.MetricsEndpointProperty