Package software.amazon.awscdk.services.mediastore

Interface CfnContainer.MetricPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnContainer.MetricPolicyProperty.Jsii$Proxy

Enclosing class:

CfnContainer

@Stability(Stable)
public static interface CfnContainer.MetricPolicyProperty
extends software.amazon.jsii.JsiiSerializable

The metric policy that is associated with the container.

A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.

To view examples of how to construct a metric policy for your use case, see Example Metric Policies .

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.mediastore.*;
 MetricPolicyProperty metricPolicyProperty = MetricPolicyProperty.builder()
         .containerLevelMetrics("containerLevelMetrics")
         // the properties below are optional
         .metricPolicyRules(List.of(MetricPolicyRuleProperty.builder()
                 .objectGroup("objectGroup")
                 .objectGroupName("objectGroupName")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnContainer.MetricPolicyProperty.Builder	builder()
String	getContainerLevelMetrics()	A setting to enable or disable metrics at the container level.
default Object	getMetricPolicyRules()	A parameter that holds an array of rules that enable metrics at the object level.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerLevelMetrics

@Stability(Stable)
@NotNull
String getContainerLevelMetrics()

A setting to enable or disable metrics at the container level.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html#cfn-mediastore-container-metricpolicy-containerlevelmetrics

getMetricPolicyRules

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

A parameter that holds an array of rules that enable metrics at the object level.

This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html#cfn-mediastore-container-metricpolicy-metricpolicyrules

builder

@Stability(Stable)
static CfnContainer.MetricPolicyProperty.Builder builder()

Returns:

a CfnContainer.MetricPolicyProperty.Builder of CfnContainer.MetricPolicyProperty