awscrondoc

README

awscrondoc

A tool to list up cron expressions registered in following AWS services for the company's internal wiki.

• EventBridge Rule
• Glue Trigger

Installation

Library

go get github.com/shmokmt/awscrondoc@latest

CLI

go install github.com/shmokmt/awscrondoc/cmd/awscrondoc@latest

Permissions

It Requires the following minimum set of permissions:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": ["events:ListRules"],
      "Resource": "*"
    },
    {
      "Effect": "Allow",
      "Action": ["glue:ListTriggers", "glue:GetTrigger"],
      "Resource": "*"
    }
  ]
}

Usage

Library

package main

import (
	"fmt"
	"log"

	"github.com/shmokmt/awscrondoc"
)

func main() {
	d, err := awscrondoc.New()
	if err != nil {
		log.Fatal(err)
	}
	md, err := d.MarkdownString()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(md)
}

CLI

awscrondoc

Documentation

Index

• type AwsCronDoc
  • func New() (*AwsCronDoc, error)
  • func (a *AwsCronDoc) MarkdownString() (string, error)
• type GlueTriggerSchedule

Types

type AwsCronDoc

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

func New

func New() (*AwsCronDoc, error)

func (*AwsCronDoc) MarkdownString

func (a *AwsCronDoc) MarkdownString() (string, error)

type GlueTriggerSchedule

type GlueTriggerSchedule struct {
	Name               *string
	WorkflowName       *string
	ScheduleExpression *string
	ScheduleState      string
}