You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaStore::Types::MetricPolicy

Inherits:

Struct

Object
Struct
Aws::MediaStore::Types::MetricPolicy

show all

Defined in:: (unknown)

Overview

Note:

When passing MetricPolicy as input to an Aws::Client method, you can use a vanilla Hash:

{
  container_level_metrics: "ENABLED", # required, accepts ENABLED, DISABLED
  metric_policy_rules: [
    {
      object_group: "ObjectGroup", # required
      object_group_name: "ObjectGroupName", # required
    },
  ],
}

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.

Returned by:

Instance Attribute Summary collapse

#container_level_metrics ⇒ String
A setting to enable or disable metrics at the container level.
#metric_policy_rules ⇒ Array<Types::MetricPolicyRule>
A parameter that holds an array of rules that enable metrics at the object level.

Instance Attribute Details

#container_level_metrics ⇒ `String`

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

Possible values:

ENABLED
DISABLED

Returns:

(String) —
A setting to enable or disable metrics at the container level.

#metric_policy_rules ⇒ `Array<Types::MetricPolicyRule>`

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.