Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the cloudwatch.services.k8s.aws API. +groupName=cloudwatch.services.k8s.aws
Index ¶
- Variables
- type ActionsSuppressedBy
- type AlarmHistoryItem
- type AlarmType
- type AnomalyDetector
- type AnomalyDetectorStateValue
- type AnomalyDetectorType
- type ComparisonOperator
- type CompositeAlarm
- type Datapoint
- type Dimension
- type DimensionFilter
- type EvaluationState
- type HistoryItemType
- type InsightRuleContributorDatapoint
- type InsightRuleMetricDatapoint
- type ManagedRule
- type Metric
- type MetricAlarm
- type MetricAlarmList
- type MetricAlarmSpec
- type MetricAlarmStatus
- type MetricAlarm_SDK
- type MetricDataQuery
- type MetricDataResult
- type MetricDatum
- type MetricMathAnomalyDetector
- type MetricStat
- type MetricStreamEntry
- type MetricStreamFilter
- type MetricStreamOutputFormat
- type MetricStreamStatisticsMetric
- type Range
- type RecentlyActive
- type ScanBy
- type SingleMetricAnomalyDetector
- type StandardUnit
- type StateValue
- type Statistic
- type StatusCode
- type Tag
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: "cloudwatch.services.k8s.aws", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ActionsSuppressedBy ¶
type ActionsSuppressedBy string
const ( ActionsSuppressedBy_WaitPeriod ActionsSuppressedBy = "WaitPeriod" ActionsSuppressedBy_ExtensionPeriod ActionsSuppressedBy = "ExtensionPeriod" ActionsSuppressedBy_Alarm ActionsSuppressedBy = "Alarm" )
type AlarmHistoryItem ¶
type AlarmHistoryItem struct { AlarmName *string `json:"alarmName,omitempty"` AlarmType *string `json:"alarmType,omitempty"` Timestamp *metav1.Time `json:"timestamp,omitempty"` }
Represents the history of a specific alarm.
func (*AlarmHistoryItem) DeepCopy ¶
func (in *AlarmHistoryItem) DeepCopy() *AlarmHistoryItem
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AlarmHistoryItem.
func (*AlarmHistoryItem) DeepCopyInto ¶
func (in *AlarmHistoryItem) DeepCopyInto(out *AlarmHistoryItem)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AnomalyDetector ¶
type AnomalyDetector struct { Dimensions []*Dimension `json:"dimensions,omitempty"` MetricName *string `json:"metricName,omitempty"` Namespace *string `json:"namespace,omitempty"` }
An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.
func (*AnomalyDetector) DeepCopy ¶
func (in *AnomalyDetector) DeepCopy() *AnomalyDetector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnomalyDetector.
func (*AnomalyDetector) DeepCopyInto ¶
func (in *AnomalyDetector) DeepCopyInto(out *AnomalyDetector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AnomalyDetectorStateValue ¶
type AnomalyDetectorStateValue string
const ( AnomalyDetectorStateValue_PENDING_TRAINING AnomalyDetectorStateValue = "PENDING_TRAINING" AnomalyDetectorStateValue_TRAINED_INSUFFICIENT_DATA AnomalyDetectorStateValue = "TRAINED_INSUFFICIENT_DATA" AnomalyDetectorStateValue_TRAINED AnomalyDetectorStateValue = "TRAINED" )
type AnomalyDetectorType ¶
type AnomalyDetectorType string
const ( AnomalyDetectorType_SINGLE_METRIC AnomalyDetectorType = "SINGLE_METRIC" AnomalyDetectorType_METRIC_MATH AnomalyDetectorType = "METRIC_MATH" )
type ComparisonOperator ¶
type ComparisonOperator string
const ( ComparisonOperator_GreaterThanOrEqualToThreshold ComparisonOperator = "GreaterThanOrEqualToThreshold" ComparisonOperator_GreaterThanThreshold ComparisonOperator = "GreaterThanThreshold" ComparisonOperator_LessThanThreshold ComparisonOperator = "LessThanThreshold" ComparisonOperator_LessThanOrEqualToThreshold ComparisonOperator = "LessThanOrEqualToThreshold" ComparisonOperator_LessThanLowerOrGreaterThanUpperThreshold ComparisonOperator = "LessThanLowerOrGreaterThanUpperThreshold" ComparisonOperator_LessThanLowerThreshold ComparisonOperator = "LessThanLowerThreshold" ComparisonOperator_GreaterThanUpperThreshold ComparisonOperator = "GreaterThanUpperThreshold" )
type CompositeAlarm ¶
type CompositeAlarm struct { ActionsEnabled *bool `json:"actionsEnabled,omitempty"` ActionsSuppressedBy *string `json:"actionsSuppressedBy,omitempty"` ActionsSuppressedReason *string `json:"actionsSuppressedReason,omitempty"` ActionsSuppressor *string `json:"actionsSuppressor,omitempty"` ActionsSuppressorExtensionPeriod *int64 `json:"actionsSuppressorExtensionPeriod,omitempty"` ActionsSuppressorWaitPeriod *int64 `json:"actionsSuppressorWaitPeriod,omitempty"` AlarmActions []*string `json:"alarmActions,omitempty"` AlarmARN *string `json:"alarmARN,omitempty"` AlarmConfigurationUpdatedTimestamp *metav1.Time `json:"alarmConfigurationUpdatedTimestamp,omitempty"` AlarmDescription *string `json:"alarmDescription,omitempty"` AlarmName *string `json:"alarmName,omitempty"` AlarmRule *string `json:"alarmRule,omitempty"` InsufficientDataActions []*string `json:"insufficientDataActions,omitempty"` OKActions []*string `json:"oKActions,omitempty"` StateReason *string `json:"stateReason,omitempty"` StateReasonData *string `json:"stateReasonData,omitempty"` StateTransitionedTimestamp *metav1.Time `json:"stateTransitionedTimestamp,omitempty"` StateUpdatedTimestamp *metav1.Time `json:"stateUpdatedTimestamp,omitempty"` StateValue *string `json:"stateValue,omitempty"` }
The details about a composite alarm.
func (*CompositeAlarm) DeepCopy ¶
func (in *CompositeAlarm) DeepCopy() *CompositeAlarm
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CompositeAlarm.
func (*CompositeAlarm) DeepCopyInto ¶
func (in *CompositeAlarm) DeepCopyInto(out *CompositeAlarm)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Datapoint ¶
type Datapoint struct { Timestamp *metav1.Time `json:"timestamp,omitempty"` Unit *string `json:"unit,omitempty"` }
Encapsulates the statistical data that CloudWatch computes from metric data.
func (*Datapoint) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Datapoint.
func (*Datapoint) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Dimension ¶
type Dimension struct { Name *string `json:"name,omitempty"` Value *string `json:"value,omitempty"` }
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
func (*Dimension) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dimension.
func (*Dimension) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DimensionFilter ¶
type DimensionFilter struct { Name *string `json:"name,omitempty"` Value *string `json:"value,omitempty"` }
Represents filters for a dimension.
func (*DimensionFilter) DeepCopy ¶
func (in *DimensionFilter) DeepCopy() *DimensionFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DimensionFilter.
func (*DimensionFilter) DeepCopyInto ¶
func (in *DimensionFilter) DeepCopyInto(out *DimensionFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EvaluationState ¶
type EvaluationState string
const (
EvaluationState_PARTIAL_DATA EvaluationState = "PARTIAL_DATA"
)
type HistoryItemType ¶
type HistoryItemType string
const ( HistoryItemType_ConfigurationUpdate HistoryItemType = "ConfigurationUpdate" HistoryItemType_StateUpdate HistoryItemType = "StateUpdate" HistoryItemType_Action HistoryItemType = "Action" )
type InsightRuleContributorDatapoint ¶
One data point related to one contributor.
For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) and InsightRuleContributor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html).
func (*InsightRuleContributorDatapoint) DeepCopy ¶
func (in *InsightRuleContributorDatapoint) DeepCopy() *InsightRuleContributorDatapoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InsightRuleContributorDatapoint.
func (*InsightRuleContributorDatapoint) DeepCopyInto ¶
func (in *InsightRuleContributorDatapoint) DeepCopyInto(out *InsightRuleContributorDatapoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InsightRuleMetricDatapoint ¶
One data point from the metric time series returned in a Contributor Insights rule report.
For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html).
func (*InsightRuleMetricDatapoint) DeepCopy ¶
func (in *InsightRuleMetricDatapoint) DeepCopy() *InsightRuleMetricDatapoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InsightRuleMetricDatapoint.
func (*InsightRuleMetricDatapoint) DeepCopyInto ¶
func (in *InsightRuleMetricDatapoint) DeepCopyInto(out *InsightRuleMetricDatapoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ManagedRule ¶
type ManagedRule struct {
Tags []*Tag `json:"tags,omitempty"`
}
Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource.
func (*ManagedRule) DeepCopy ¶
func (in *ManagedRule) DeepCopy() *ManagedRule
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedRule.
func (*ManagedRule) DeepCopyInto ¶
func (in *ManagedRule) DeepCopyInto(out *ManagedRule)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Metric ¶
type Metric struct { Dimensions []*Dimension `json:"dimensions,omitempty"` MetricName *string `json:"metricName,omitempty"` Namespace *string `json:"namespace,omitempty"` }
Represents a specific metric.
func (*Metric) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Metric.
func (*Metric) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricAlarm ¶
type MetricAlarm struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MetricAlarmSpec `json:"spec,omitempty"` Status MetricAlarmStatus `json:"status,omitempty"` }
MetricAlarm is the Schema for the MetricAlarms API +kubebuilder:object:root=true +kubebuilder:subresource:status
func (*MetricAlarm) DeepCopy ¶
func (in *MetricAlarm) DeepCopy() *MetricAlarm
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricAlarm.
func (*MetricAlarm) DeepCopyInto ¶
func (in *MetricAlarm) DeepCopyInto(out *MetricAlarm)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MetricAlarm) DeepCopyObject ¶
func (in *MetricAlarm) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MetricAlarmList ¶
type MetricAlarmList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MetricAlarm `json:"items"` }
MetricAlarmList contains a list of MetricAlarm +kubebuilder:object:root=true
func (*MetricAlarmList) DeepCopy ¶
func (in *MetricAlarmList) DeepCopy() *MetricAlarmList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricAlarmList.
func (*MetricAlarmList) DeepCopyInto ¶
func (in *MetricAlarmList) DeepCopyInto(out *MetricAlarmList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MetricAlarmList) DeepCopyObject ¶
func (in *MetricAlarmList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MetricAlarmSpec ¶
type MetricAlarmSpec struct { // Indicates whether actions should be executed during any changes to the alarm // state. The default is TRUE. ActionsEnabled *bool `json:"actionsEnabled,omitempty"` // The actions to execute when this alarm transitions to the ALARM state from // any other state. Each action is specified as an Amazon Resource Name (ARN). // Valid values: // // EC2 actions: // // - arn:aws:automate:region:ec2:stop // // - arn:aws:automate:region:ec2:terminate // // - arn:aws:automate:region:ec2:reboot // // - arn:aws:automate:region:ec2:recover // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 // // Autoscaling action: // // - arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // SNS notification action: // // - arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // SSM integration actions: // // - arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name // // - arn:aws:ssm-incidents::account-id:responseplan/response-plan-name AlarmActions []*string `json:"alarmActions,omitempty"` // The description for the alarm. AlarmDescription *string `json:"alarmDescription,omitempty"` // The arithmetic operation to use when comparing the specified statistic and // threshold. The specified statistic value is used as the first operand. // // The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, // and GreaterThanUpperThreshold are used only for alarms based on anomaly detection // models. // +kubebuilder:validation:Required ComparisonOperator *string `json:"comparisonOperator"` // The number of data points that must be breaching to trigger the alarm. This // is used only if you are setting an "M out of N" alarm. In that case, this // value is the M. For more information, see Evaluating an Alarm (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) // in the Amazon CloudWatch User Guide. DatapointsToAlarm *int64 `json:"datapointsToAlarm,omitempty"` // The dimensions for the metric specified in MetricName. Dimensions []*Dimension `json:"dimensions,omitempty"` // Used only for alarms based on percentiles. If you specify ignore, the alarm // state does not change during periods with too few data points to be statistically // significant. If you specify evaluate or omit this parameter, the alarm is // always evaluated and possibly changes state no matter how many data points // are available. For more information, see Percentile-Based CloudWatch Alarms // and Low Data Samples (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples). // // Valid Values: evaluate | ignore EvaluateLowSampleCountPercentile *string `json:"evaluateLowSampleCountPercentile,omitempty"` // The number of periods over which data is compared to the specified threshold. // If you are setting an alarm that requires that a number of consecutive data // points be breaching to trigger the alarm, this value specifies that number. // If you are setting an "M out of N" alarm, this value is the N. // // An alarm's total current evaluation period can be no longer than one day, // so this number multiplied by Period cannot be more than 86,400 seconds. // +kubebuilder:validation:Required EvaluationPeriods *int64 `json:"evaluationPeriods"` // The extended statistic for the metric specified in MetricName. When you call // PutMetricAlarm and specify a MetricName, you must specify either Statistic // or ExtendedStatistic but not both. // // If you specify ExtendedStatistic, the following are valid values: // // - p90 // // - tm90 // // - tc90 // // - ts90 // // - wm90 // // - IQM // // - PR(n:m) where n and m are values of the metric // // - TC(X%:X%) where X is between 10 and 90 inclusive. // // - TM(X%:X%) where X is between 10 and 90 inclusive. // // - TS(X%:X%) where X is between 10 and 90 inclusive. // // - WM(X%:X%) where X is between 10 and 90 inclusive. // // For more information about these extended statistics, see CloudWatch statistics // definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html). ExtendedStatistic *string `json:"extendedStatistic,omitempty"` // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA // state from any other state. Each action is specified as an Amazon Resource // Name (ARN). Valid values: // // EC2 actions: // // - arn:aws:automate:region:ec2:stop // // - arn:aws:automate:region:ec2:terminate // // - arn:aws:automate:region:ec2:reboot // // - arn:aws:automate:region:ec2:recover // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 // // Autoscaling action: // // - arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // SNS notification action: // // - arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // SSM integration actions: // // - arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name // // - arn:aws:ssm-incidents::account-id:responseplan/response-plan-name InsufficientDataActions []*string `json:"insufficientDataActions,omitempty"` // The name for the metric associated with the alarm. For each PutMetricAlarm // operation, you must specify either MetricName or a Metrics array. // // If you are creating an alarm based on a math expression, you cannot specify // this parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic, // or ExtendedStatistic parameters. Instead, you specify all this information // in the Metrics array. MetricName *string `json:"metricName,omitempty"` // An array of MetricDataQuery structures that enable you to create an alarm // based on the result of a metric math expression. For each PutMetricAlarm // operation, you must specify either MetricName or a Metrics array. // // Each item in the Metrics array either retrieves a metric or performs a math // expression. // // One item in the Metrics array is the expression that the alarm watches. You // designate this expression by setting ReturnData to true for this object in // the array. For more information, see MetricDataQuery (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html). // // If you use the Metrics parameter, you cannot include the Namespace, MetricName, // Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm // in the same operation. Instead, you retrieve the metrics you are using in // your math expression as part of the Metrics array. Metrics []*MetricDataQuery `json:"metrics,omitempty"` // The name for the alarm. This name must be unique within the Region. // // The name must contain only UTF-8 characters, and can't contain ASCII control // characters // +kubebuilder:validation:Required Name *string `json:"name"` // The namespace for the metric associated specified in MetricName. Namespace *string `json:"namespace,omitempty"` // The actions to execute when this alarm transitions to an OK state from any // other state. Each action is specified as an Amazon Resource Name (ARN). Valid // values: // // EC2 actions: // // - arn:aws:automate:region:ec2:stop // // - arn:aws:automate:region:ec2:terminate // // - arn:aws:automate:region:ec2:reboot // // - arn:aws:automate:region:ec2:recover // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 // // - arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 // // Autoscaling action: // // - arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // SNS notification action: // // - arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // SSM integration actions: // // - arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name // // - arn:aws:ssm-incidents::account-id:responseplan/response-plan-name OKActions []*string `json:"oKActions,omitempty"` // The length, in seconds, used each time the metric specified in MetricName // is evaluated. Valid values are 10, 30, and any multiple of 60. // // Period is required for alarms based on static thresholds. If you are creating // an alarm based on a metric math expression, you specify the period for each // metric within the objects in the Metrics array. // // Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData // call with a StorageResolution of 1. If you specify a period of 10 or 30 for // a metric that does not have sub-minute resolution, the alarm still attempts // to gather data at the period rate that you specify. In this case, it does // not receive data for the attempts that do not correspond to a one-minute // data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. // Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which // has a higher charge than other alarms. For more information about pricing, // see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/). // // An alarm's total current evaluation period can be no longer than one day, // so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds. Period *int64 `json:"period,omitempty"` // The statistic for the metric specified in MetricName, other than percentile. // For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm // and specify a MetricName, you must specify either Statistic or ExtendedStatistic, // but not both. Statistic *string `json:"statistic,omitempty"` // A list of key-value pairs to associate with the alarm. You can associate // as many as 50 tags with an alarm. To be able to associate tags with the alarm // when you create the alarm, you must have the cloudwatch:TagResource permission. // // Tags can help you organize and categorize your resources. You can also use // them to scope user permissions by granting a user permission to access or // change only resources with certain tag values. // // If you are using this operation to update an existing alarm, any tags you // specify in this parameter are ignored. To change the tags of an existing // alarm, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) // or UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html). Tags []*Tag `json:"tags,omitempty"` // The value against which the specified statistic is compared. // // This parameter is required for alarms based on static thresholds, but should // not be used for alarms based on anomaly detection models. Threshold *float64 `json:"threshold,omitempty"` // If this is an alarm based on an anomaly detection model, make this value // match the ID of the ANOMALY_DETECTION_BAND function. // // For an example of how to use this parameter, see the Anomaly Detection Model // Alarm example on this page. // // If your alarm uses this parameter, it cannot have Auto Scaling actions. ThresholdMetricID *string `json:"thresholdMetricID,omitempty"` // Sets how this alarm is to handle missing data points. If TreatMissingData // is omitted, the default behavior of missing is used. For more information, // see Configuring How CloudWatch Alarms Treats Missing Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data). // // Valid Values: breaching | notBreaching | ignore | missing // // Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore // missing data even if you choose a different option for TreatMissingData. // When an AWS/DynamoDB metric has missing data, alarms that evaluate that metric // remain in their current state. TreatMissingData *string `json:"treatMissingData,omitempty"` // The unit of measure for the statistic. For example, the units for the Amazon // EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes // that an instance receives on all network interfaces. You can also specify // a unit when you create a custom metric. Units help provide conceptual meaning // to your data. Metric data points that specify a unit of measure, such as // Percent, are aggregated separately. If you are creating an alarm based on // a metric math expression, you can specify the unit for each metric (if needed) // within the objects in the Metrics array. // // If you don't specify Unit, CloudWatch retrieves all unit types that have // been published for the metric and attempts to evaluate the alarm. Usually, // metrics are published with only one unit, so the alarm works as intended. // // However, if the metric is published with multiple types of units and you // don't specify a unit, the alarm's behavior is not defined and it behaves // unpredictably. // // We recommend omitting Unit so that you don't inadvertently specify an incorrect // unit that is not published for this metric. Doing so causes the alarm to // be stuck in the INSUFFICIENT DATA state. Unit *string `json:"unit,omitempty"` }
MetricAlarmSpec defines the desired state of MetricAlarm.
The details about a metric alarm.
func (*MetricAlarmSpec) DeepCopy ¶
func (in *MetricAlarmSpec) DeepCopy() *MetricAlarmSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricAlarmSpec.
func (*MetricAlarmSpec) DeepCopyInto ¶
func (in *MetricAlarmSpec) DeepCopyInto(out *MetricAlarmSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricAlarmStatus ¶
type MetricAlarmStatus struct { // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member // that is used to contain resource sync state, account ownership, // constructed ARN for the resource // +kubebuilder:validation:Optional ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"` // All CRS managed by ACK have a common `Status.Conditions` member that // contains a collection of `ackv1alpha1.Condition` objects that describe // the various terminal states of the CR and its backend AWS service API // resource // +kubebuilder:validation:Optional Conditions []*ackv1alpha1.Condition `json:"conditions"` }
MetricAlarmStatus defines the observed state of MetricAlarm
func (*MetricAlarmStatus) DeepCopy ¶
func (in *MetricAlarmStatus) DeepCopy() *MetricAlarmStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricAlarmStatus.
func (*MetricAlarmStatus) DeepCopyInto ¶
func (in *MetricAlarmStatus) DeepCopyInto(out *MetricAlarmStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricAlarm_SDK ¶
type MetricAlarm_SDK struct { ActionsEnabled *bool `json:"actionsEnabled,omitempty"` AlarmActions []*string `json:"alarmActions,omitempty"` AlarmARN *string `json:"alarmARN,omitempty"` AlarmConfigurationUpdatedTimestamp *metav1.Time `json:"alarmConfigurationUpdatedTimestamp,omitempty"` AlarmDescription *string `json:"alarmDescription,omitempty"` AlarmName *string `json:"alarmName,omitempty"` ComparisonOperator *string `json:"comparisonOperator,omitempty"` DatapointsToAlarm *int64 `json:"datapointsToAlarm,omitempty"` Dimensions []*Dimension `json:"dimensions,omitempty"` EvaluateLowSampleCountPercentile *string `json:"evaluateLowSampleCountPercentile,omitempty"` EvaluationPeriods *int64 `json:"evaluationPeriods,omitempty"` EvaluationState *string `json:"evaluationState,omitempty"` ExtendedStatistic *string `json:"extendedStatistic,omitempty"` InsufficientDataActions []*string `json:"insufficientDataActions,omitempty"` MetricName *string `json:"metricName,omitempty"` Metrics []*MetricDataQuery `json:"metrics,omitempty"` Namespace *string `json:"namespace,omitempty"` OKActions []*string `json:"oKActions,omitempty"` Period *int64 `json:"period,omitempty"` StateReason *string `json:"stateReason,omitempty"` StateReasonData *string `json:"stateReasonData,omitempty"` StateTransitionedTimestamp *metav1.Time `json:"stateTransitionedTimestamp,omitempty"` StateUpdatedTimestamp *metav1.Time `json:"stateUpdatedTimestamp,omitempty"` StateValue *string `json:"stateValue,omitempty"` Statistic *string `json:"statistic,omitempty"` Threshold *float64 `json:"threshold,omitempty"` ThresholdMetricID *string `json:"thresholdMetricID,omitempty"` TreatMissingData *string `json:"treatMissingData,omitempty"` Unit *string `json:"unit,omitempty"` }
The details about a metric alarm.
func (*MetricAlarm_SDK) DeepCopy ¶
func (in *MetricAlarm_SDK) DeepCopy() *MetricAlarm_SDK
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricAlarm_SDK.
func (*MetricAlarm_SDK) DeepCopyInto ¶
func (in *MetricAlarm_SDK) DeepCopyInto(out *MetricAlarm_SDK)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricDataQuery ¶
type MetricDataQuery struct { AccountID *string `json:"accountID,omitempty"` Expression *string `json:"expression,omitempty"` ID *string `json:"id,omitempty"` Label *string `json:"label,omitempty"` // This structure defines the metric to be returned, along with the statistics, // period, and units. MetricStat *MetricStat `json:"metricStat,omitempty"` Period *int64 `json:"period,omitempty"` ReturnData *bool `json:"returnData,omitempty"` }
This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.
When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData call can include up to 500 MetricDataQuery structures.
When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have true as the value for ReturnData. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the Amazon CloudWatch User Guide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.
func (*MetricDataQuery) DeepCopy ¶
func (in *MetricDataQuery) DeepCopy() *MetricDataQuery
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricDataQuery.
func (*MetricDataQuery) DeepCopyInto ¶
func (in *MetricDataQuery) DeepCopyInto(out *MetricDataQuery)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricDataResult ¶
type MetricDataResult struct { ID *string `json:"id,omitempty"` Label *string `json:"label,omitempty"` }
A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.
func (*MetricDataResult) DeepCopy ¶
func (in *MetricDataResult) DeepCopy() *MetricDataResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricDataResult.
func (*MetricDataResult) DeepCopyInto ¶
func (in *MetricDataResult) DeepCopyInto(out *MetricDataResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricDatum ¶
type MetricDatum struct { Dimensions []*Dimension `json:"dimensions,omitempty"` MetricName *string `json:"metricName,omitempty"` Timestamp *metav1.Time `json:"timestamp,omitempty"` Unit *string `json:"unit,omitempty"` }
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
func (*MetricDatum) DeepCopy ¶
func (in *MetricDatum) DeepCopy() *MetricDatum
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricDatum.
func (*MetricDatum) DeepCopyInto ¶
func (in *MetricDatum) DeepCopyInto(out *MetricDatum)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricMathAnomalyDetector ¶
type MetricMathAnomalyDetector struct {
MetricDataQueries []*MetricDataQuery `json:"metricDataQueries,omitempty"`
}
Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.
func (*MetricMathAnomalyDetector) DeepCopy ¶
func (in *MetricMathAnomalyDetector) DeepCopy() *MetricMathAnomalyDetector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricMathAnomalyDetector.
func (*MetricMathAnomalyDetector) DeepCopyInto ¶
func (in *MetricMathAnomalyDetector) DeepCopyInto(out *MetricMathAnomalyDetector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricStat ¶
type MetricStat struct { // Represents a specific metric. Metric *Metric `json:"metric,omitempty"` Period *int64 `json:"period,omitempty"` Stat *string `json:"stat,omitempty"` Unit *string `json:"unit,omitempty"` }
This structure defines the metric to be returned, along with the statistics, period, and units.
func (*MetricStat) DeepCopy ¶
func (in *MetricStat) DeepCopy() *MetricStat
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricStat.
func (*MetricStat) DeepCopyInto ¶
func (in *MetricStat) DeepCopyInto(out *MetricStat)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricStreamEntry ¶
type MetricStreamEntry struct { CreationDate *metav1.Time `json:"creationDate,omitempty"` LastUpdateDate *metav1.Time `json:"lastUpdateDate,omitempty"` }
This structure contains the configuration information about one metric stream.
func (*MetricStreamEntry) DeepCopy ¶
func (in *MetricStreamEntry) DeepCopy() *MetricStreamEntry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricStreamEntry.
func (*MetricStreamEntry) DeepCopyInto ¶
func (in *MetricStreamEntry) DeepCopyInto(out *MetricStreamEntry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricStreamFilter ¶
type MetricStreamFilter struct {
Namespace *string `json:"namespace,omitempty"`
}
This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric stream or exclude from a metric stream.
A metric stream's filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.
func (*MetricStreamFilter) DeepCopy ¶
func (in *MetricStreamFilter) DeepCopy() *MetricStreamFilter
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricStreamFilter.
func (*MetricStreamFilter) DeepCopyInto ¶
func (in *MetricStreamFilter) DeepCopyInto(out *MetricStreamFilter)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricStreamOutputFormat ¶
type MetricStreamOutputFormat string
const ( MetricStreamOutputFormat_json MetricStreamOutputFormat = "json" MetricStreamOutputFormat_opentelemetry0_7 MetricStreamOutputFormat = "opentelemetry0.7" MetricStreamOutputFormat_opentelemetry1_0 MetricStreamOutputFormat = "opentelemetry1.0" )
type MetricStreamStatisticsMetric ¶
type MetricStreamStatisticsMetric struct { MetricName *string `json:"metricName,omitempty"` Namespace *string `json:"namespace,omitempty"` }
This object contains the information for one metric that is to be streamed with additional statistics.
func (*MetricStreamStatisticsMetric) DeepCopy ¶
func (in *MetricStreamStatisticsMetric) DeepCopy() *MetricStreamStatisticsMetric
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricStreamStatisticsMetric.
func (*MetricStreamStatisticsMetric) DeepCopyInto ¶
func (in *MetricStreamStatisticsMetric) DeepCopyInto(out *MetricStreamStatisticsMetric)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Range ¶
type Range struct { EndTime *metav1.Time `json:"endTime,omitempty"` StartTime *metav1.Time `json:"startTime,omitempty"` }
Specifies one range of days or times to exclude from use for training an anomaly detection model.
func (*Range) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Range.
func (*Range) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RecentlyActive ¶
type RecentlyActive string
const (
RecentlyActive_PT3H RecentlyActive = "PT3H"
)
type SingleMetricAnomalyDetector ¶
type SingleMetricAnomalyDetector struct { Dimensions []*Dimension `json:"dimensions,omitempty"` MetricName *string `json:"metricName,omitempty"` Namespace *string `json:"namespace,omitempty"` }
Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.
func (*SingleMetricAnomalyDetector) DeepCopy ¶
func (in *SingleMetricAnomalyDetector) DeepCopy() *SingleMetricAnomalyDetector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SingleMetricAnomalyDetector.
func (*SingleMetricAnomalyDetector) DeepCopyInto ¶
func (in *SingleMetricAnomalyDetector) DeepCopyInto(out *SingleMetricAnomalyDetector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StandardUnit ¶
type StandardUnit string
const ( StandardUnit_Seconds StandardUnit = "Seconds" StandardUnit_Microseconds StandardUnit = "Microseconds" StandardUnit_Milliseconds StandardUnit = "Milliseconds" StandardUnit_Bytes StandardUnit = "Bytes" StandardUnit_Kilobytes StandardUnit = "Kilobytes" StandardUnit_Megabytes StandardUnit = "Megabytes" StandardUnit_Gigabytes StandardUnit = "Gigabytes" StandardUnit_Terabytes StandardUnit = "Terabytes" StandardUnit_Bits StandardUnit = "Bits" StandardUnit_Kilobits StandardUnit = "Kilobits" StandardUnit_Megabits StandardUnit = "Megabits" StandardUnit_Gigabits StandardUnit = "Gigabits" StandardUnit_Terabits StandardUnit = "Terabits" StandardUnit_Percent StandardUnit = "Percent" StandardUnit_Count StandardUnit = "Count" StandardUnit_Bytes_Second StandardUnit = "Bytes/Second" StandardUnit_Kilobytes_Second StandardUnit = "Kilobytes/Second" StandardUnit_Megabytes_Second StandardUnit = "Megabytes/Second" StandardUnit_Gigabytes_Second StandardUnit = "Gigabytes/Second" StandardUnit_Terabytes_Second StandardUnit = "Terabytes/Second" StandardUnit_Bits_Second StandardUnit = "Bits/Second" StandardUnit_Kilobits_Second StandardUnit = "Kilobits/Second" StandardUnit_Megabits_Second StandardUnit = "Megabits/Second" StandardUnit_Gigabits_Second StandardUnit = "Gigabits/Second" StandardUnit_Terabits_Second StandardUnit = "Terabits/Second" StandardUnit_Count_Second StandardUnit = "Count/Second" StandardUnit_None StandardUnit = "None" )
type StateValue ¶
type StateValue string
const ( StateValue_OK StateValue = "OK" StateValue_ALARM StateValue = "ALARM" StateValue_INSUFFICIENT_DATA StateValue = "INSUFFICIENT_DATA" )
type StatusCode ¶
type StatusCode string
const ( StatusCode_Complete StatusCode = "Complete" StatusCode_InternalError StatusCode = "InternalError" StatusCode_PartialData StatusCode = "PartialData" StatusCode_Forbidden StatusCode = "Forbidden" )
type Tag ¶
A key-value pair associated with a CloudWatch resource.
func (*Tag) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.
func (*Tag) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.