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

Interface CfnEndpointConfigPropsMixin.MetricsConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointConfigPropsMixin.MetricsConfigProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfigPropsMixin

@Stability(Stable)
public static interface CfnEndpointConfigPropsMixin.MetricsConfigProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics.

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.*;
 MetricsConfigProperty metricsConfigProperty = MetricsConfigProperty.builder()
         .enableDetailedObservability(false)
         .enableEnhancedMetrics(false)
         .metricPublishFrequencyInSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEndpointConfigPropsMixin.MetricsConfigProperty.Builder	builder()
default Object	getEnableDetailedObservability()	Specifies whether to enable detailed observability for the endpoint.
default Object	getEnableEnhancedMetrics()	Specifies whether to enable enhanced metrics for the endpoint.
default Number	getMetricPublishFrequencyInSeconds()	The interval, in seconds, at which the endpoint publishes metrics to Amazon CloudWatch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnableDetailedObservability

@Stability(Stable)
@Nullable
default Object getEnableDetailedObservability()

Specifies whether to enable detailed observability for the endpoint.

When set to true, the endpoint publishes container-level inference metrics, per-GPU metrics, per-instance host metrics, and inference component placement metrics.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-metricsconfig.html#cfn-sagemaker-endpointconfig-metricsconfig-enabledetailedobservability

getEnableEnhancedMetrics

@Stability(Stable)
@Nullable
default Object getEnableEnhancedMetrics()

Specifies whether to enable enhanced metrics for the endpoint.

Enhanced metrics provide utilization and invocation data at instance and container granularity.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-metricsconfig.html#cfn-sagemaker-endpointconfig-metricsconfig-enableenhancedmetrics

getMetricPublishFrequencyInSeconds

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

The interval, in seconds, at which the endpoint publishes metrics to Amazon CloudWatch.

Valid values are 10, 30, 60, 120, 180, 240, and 300. The default is 60.

See Also:

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

builder

@Stability(Stable)
static CfnEndpointConfigPropsMixin.MetricsConfigProperty.Builder builder()

Returns:

a CfnEndpointConfigPropsMixin.MetricsConfigProperty.Builder of CfnEndpointConfigPropsMixin.MetricsConfigProperty