Show / Hide Table of Contents

Class CfnContainerPropsMixin.MetricPolicyProperty

The metric policy that is associated with the container.

Inheritance
object
CfnContainerPropsMixin.MetricPolicyProperty
Implements
CfnContainerPropsMixin.IMetricPolicyProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.MediaStore.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnContainerPropsMixin.MetricPolicyProperty : CfnContainerPropsMixin.IMetricPolicyProperty
Syntax (vb)
Public Class CfnContainerPropsMixin.MetricPolicyProperty Implements CfnContainerPropsMixin.IMetricPolicyProperty
Remarks

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 .

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.MediaStore.Mixins;

             var metricPolicyProperty = new MetricPolicyProperty {
                 ContainerLevelMetrics = "containerLevelMetrics",
                 MetricPolicyRules = new [] { new MetricPolicyRuleProperty {
                     ObjectGroup = "objectGroup",
                     ObjectGroupName = "objectGroupName"
                 } }
             };

Synopsis

Constructors

MetricPolicyProperty()

The metric policy that is associated with the container.

Properties

ContainerLevelMetrics

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

MetricPolicyRules

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

Constructors

MetricPolicyProperty()

The metric policy that is associated with the container.

public MetricPolicyProperty()
Remarks

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 .

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.MediaStore.Mixins;

             var metricPolicyProperty = new MetricPolicyProperty {
                 ContainerLevelMetrics = "containerLevelMetrics",
                 MetricPolicyRules = new [] { new MetricPolicyRuleProperty {
                     ObjectGroup = "objectGroup",
                     ObjectGroupName = "objectGroupName"
                 } }
             };

Properties

ContainerLevelMetrics

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

public string? ContainerLevelMetrics { get; set; }
Property Value

string

Remarks

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

MetricPolicyRules

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

public object? MetricPolicyRules { get; set; }
Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html#cfn-mediastore-container-metricpolicy-metricpolicyrules

Type union: either IResolvable or (either IResolvable or CfnContainerPropsMixin.IMetricPolicyRuleProperty)[]

Implements

CfnContainerPropsMixin.IMetricPolicyProperty
Back to top Generated by DocFX