AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CloudwatchAlarmAction

import "github.com/aws/aws-sdk-go/service/iot"

type CloudwatchAlarmAction struct { AlarmName *string `locationName:"alarmName" type:"string" required:"true"` RoleArn *string `locationName:"roleArn" type:"string" required:"true"` StateReason *string `locationName:"stateReason" type:"string" required:"true"` StateValue *string `locationName:"stateValue" type:"string" required:"true"` }

Describes an action that updates a CloudWatch alarm.

AlarmName

Type: *string

The CloudWatch alarm name.

AlarmName is a required field

RoleArn

Type: *string

The IAM role that allows access to the CloudWatch alarm.

RoleArn is a required field

StateReason

Type: *string

The reason for the alarm change.

StateReason is a required field

StateValue

Type: *string

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

StateValue is a required field

Method

GoString

func (s CloudwatchAlarmAction) GoString() string

GoString returns the string representation

SetAlarmName

func (s *CloudwatchAlarmAction) SetAlarmName(v string) *CloudwatchAlarmAction

SetAlarmName sets the AlarmName field's value.

SetRoleArn

func (s *CloudwatchAlarmAction) SetRoleArn(v string) *CloudwatchAlarmAction

SetRoleArn sets the RoleArn field's value.

SetStateReason

func (s *CloudwatchAlarmAction) SetStateReason(v string) *CloudwatchAlarmAction

SetStateReason sets the StateReason field's value.

SetStateValue

func (s *CloudwatchAlarmAction) SetStateValue(v string) *CloudwatchAlarmAction

SetStateValue sets the StateValue field's value.

String

func (s CloudwatchAlarmAction) String() string

String returns the string representation

Validate

func (s *CloudwatchAlarmAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: