cloudwatchevents

README

Amazon Cloud Watch service

This service is github.com/aws/aws-sdk-go/service/ec2.EC2 proxy

To check all supported method run

    endly -s="aws/cloudwatchevents"

To check method contract run endly -s="aws/cloudwatchevents" -a=methodName

    endly -s="aws/cloudwatchevents" -a='listRules'

Usage:

List Rules

endly aws/cloudwatchevents:listRules credentials=aws-e2e

or with endly workflow

endly list_rules.yaml

@list_rules.yaml

pipeline:
  list:
    action: aws/cloudwatchevents:listRules
    credentials: aws

Get Rule Info

endly aws/cloudwatchevents:getRule credentials=aws name=MyRule

or with endly workflow

endly get_rule.yaml

@get_rule.yaml

pipeline:
  list:
    action: aws/cloudwatchevents:getRule
    name: MyRule
    credentials: aws

Deploy scheduled rule

endly deploy_rule

@deploy_rule.yaml

init:
  event:
    vendor: myvendor
    event: myevent

pipeline:
  deploy:
    action: aws/cloudwatchevents:deployRule
    credentials: aws
    '@name': MyRule
    scheduleexpression: rate(1 minute)
    roleName: AggFnSchduler
    targets:
      - function: AggFn


  putEvent:
    action: aws/cloudwatchevents:putEvents
    entries:
      - source: com.company.app
        detailType: appRequestSubmitted
        detail: $AsJSON($event)
        resource:
          - $deploy.Rule.Arn

Documentation

Index

• Constants
• func GetClient(context *endly.Context) (*cloudwatchevents.CloudWatchEvents, error)
• func New() endly.Service
• type DeleteRuleInput
  • func (i *DeleteRuleInput) Validate() error
• type DeployRuleInput
  • func (i *DeployRuleInput) Init() error
  • func (i DeployRuleInput) Validate() error
• type DeployRuleOutput
• type GetRuleInput
• type GetRuleOutput
• type Target
• type Targets

Constants

const DefaultRolePolicy = `` /* 405-byte string literal not displayed */

DefaultRolePolicy represents defaul role policy

const DefaultTrustRelationship = `` /* 262-byte string literal not displayed */

DefaultTrustRelationship represents default trust relationship

const (
	//ServiceID aws Cloudwatch service id.
	ServiceID = "aws/cloudwatchevents"
)

Functions

func GetClient

func GetClient(context *endly.Context) (*cloudwatchevents.CloudWatchEvents, error)

GetClient returns cloudwatchevents client from context

func New

func New() endly.Service

New creates a new AWS Cloudwatch events service.

Types

type DeleteRuleInput

type DeleteRuleInput struct {
	cloudwatchevents.DeleteRuleInput
	TargetArn *string
}

DeleteRuleInput represents delete rule input

func (*DeleteRuleInput) Validate

func (i *DeleteRuleInput) Validate() error

type DeployRuleInput

type DeployRuleInput struct {
	cloudwatchevents.PutRuleInput
	ciam.SetupRolePolicyInput ` json:",inline"`
	Targets                   Targets
}

DeployRuleInput represents deploy rule input

func (*DeployRuleInput) Init

func (i *DeployRuleInput) Init() error

Init initialises request

func (DeployRuleInput) Validate

func (i DeployRuleInput) Validate() error

Validate checks if input is valid

type DeployRuleOutput

type DeployRuleOutput GetRuleOutput

DeployRuleOutput represents deployRule rule output

type GetRuleInput

type GetRuleInput struct {
	Name *string
}

GetRuleInput represents get rule input

type GetRuleOutput

type GetRuleOutput struct {
	Rule     *cloudwatchevents.Rule
	Targets  []*cloudwatchevents.Target
	RoleInfo *ciam.GetRoleInfoOutput
}

GetRuleOutput represents get rule output

type Target

type Target struct {
	cloudwatchevents.Target
	Function *string `description:"lambda function name"`
}

Target represents target

type Targets

type Targets []*Target

Target represents targets