Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnInferenceComponentPropsMixin.MetricsEndpointProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInferenceComponentPropsMixin.MetricsEndpointProperty.Jsii$Proxy

Enclosing class:

CfnInferenceComponentPropsMixin

@Stability(Stable)
public static interface CfnInferenceComponentPropsMixin.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.cfnpropertymixins.services.sagemaker.*;
 MetricsEndpointProperty metricsEndpointProperty = MetricsEndpointProperty.builder()
         .metricPublishFrequencyInSeconds(123)
         .metricsEndpointPath("metricsEndpointPath")
         .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	CfnInferenceComponentPropsMixin.MetricsEndpointProperty.Builder	A builder for CfnInferenceComponentPropsMixin.MetricsEndpointProperty
static final class	CfnInferenceComponentPropsMixin.MetricsEndpointProperty.Jsii$Proxy	An implementation for CfnInferenceComponentPropsMixin.MetricsEndpointProperty

Method Summary

Modifier and Type	Method	Description
static CfnInferenceComponentPropsMixin.MetricsEndpointProperty.Builder	builder()
default Number	getMetricPublishFrequencyInSeconds()	The interval, in seconds, at which container metrics scraped from the endpoint are published to Amazon CloudWatch.
default 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

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

getMetricsEndpointPath

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnInferenceComponentPropsMixin.MetricsEndpointProperty.Builder of CfnInferenceComponentPropsMixin.MetricsEndpointProperty