interface MetricPolicyProperty

Language	Type name
.NET	`Amazon.CDK.AWS.MediaStore.CfnContainer.MetricPolicyProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediastore#CfnContainer_MetricPolicyProperty`
Java	`software.amazon.awscdk.services.mediastore.CfnContainer.MetricPolicyProperty`
Python	`aws_cdk.aws_mediastore.CfnContainer.MetricPolicyProperty`
TypeScript	`aws-cdk-lib` » `aws_mediastore` » `CfnContainer` » `MetricPolicyProperty`

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 { aws_mediastore as mediastore } from 'aws-cdk-lib';
const metricPolicyProperty: mediastore.CfnContainer.MetricPolicyProperty = {
  containerLevelMetrics: 'containerLevelMetrics',

  // the properties below are optional
  metricPolicyRules: [{
    objectGroup: 'objectGroup',
    objectGroupName: 'objectGroupName',
  }],
};

Properties

Name	Type	Description
containerLevelMetrics	`string`	A setting to enable or disable metrics at the container level.
metricPolicyRules?	`IResolvable` `\|` `IResolvable` `\|` `MetricPolicyRuleProperty[]`	A parameter that holds an array of rules that enable metrics at the object level.

containerLevelMetrics

Type: string

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

metricPolicyRules?

Type: IResolvable | IResolvable | MetricPolicyRuleProperty[] (optional)

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.