cloudwatch

Documentation

Overview

Package cloudwatch provides a client to make API requests to Amazon CloudWatch Service.

Index

• type AlarmDescription
• type AlarmStatus
• type CloudWatch
  • func New(s *session.Session) *CloudWatch
  • func (cw *CloudWatch) AlarmDescriptions(alarmNames []string) ([]*AlarmDescription, error)
  • func (cw *CloudWatch) AlarmStatuses(opts ...DescribeAlarmOpts) ([]AlarmStatus, error)
  • func (cw *CloudWatch) AlarmsWithTags(tags map[string]string) ([]AlarmStatus, error)
• type DescribeAlarmOpts
  • func WithNames(names []string) DescribeAlarmOpts
  • func WithPrefix(prefix string) DescribeAlarmOpts

Types

type AlarmDescription

type AlarmDescription struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Environment string `json:"environment"`
}

AlarmDescription contains CloudWatch alarm config. Also available: MetricName, ComparisonOperator, DatapointsToAlarm, EvaluationPeriods, Threshold, Unit.

type AlarmStatus

type AlarmStatus struct {
	Arn          string    `json:"arn"`
	Name         string    `json:"name"`
	Condition    string    `json:"condition"`
	Status       string    `json:"status"`
	Type         string    `json:"type"`
	UpdatedTimes time.Time `json:"updatedTimes"`
}

AlarmStatus contains CloudWatch alarm status.

type CloudWatch

type CloudWatch struct {
	// contains filtered or unexported fields
}

CloudWatch wraps an Amazon CloudWatch client.

func New

func New(s *session.Session) *CloudWatch

New returns a CloudWatch struct configured against the input session.

func (*CloudWatch) AlarmDescriptions

func (cw *CloudWatch) AlarmDescriptions(alarmNames []string) ([]*AlarmDescription, error)

AlarmDescriptions returns the config of alarms filtered by name.

func (*CloudWatch) AlarmStatuses

func (cw *CloudWatch) AlarmStatuses(opts ...DescribeAlarmOpts) ([]AlarmStatus, error)

AlarmStatuses returns the statuses of alarms optionally filtered (by name, prefix, etc.). If the optional parameter is passed in but is nil, the statuses of ALL alarms in the account will be returned!

func (*CloudWatch) AlarmsWithTags

func (cw *CloudWatch) AlarmsWithTags(tags map[string]string) ([]AlarmStatus, error)

AlarmsWithTags returns the statuses of all the CloudWatch alarms that have the resource tags.

type DescribeAlarmOpts

type DescribeAlarmOpts func(input *cloudwatch.DescribeAlarmsInput)

DescribeAlarmOpts sets the optional parameter for DescribeAlarms

func WithNames

func WithNames(names []string) DescribeAlarmOpts

WithNames sets DescribeAlarms to filter on alarm names.

func WithPrefix

func WithPrefix(prefix string) DescribeAlarmOpts

WithPrefix sets DescribeAlarms to filter on a name prefix.