https://github.com/shmokmt/awscrondoc

List up cron expressions registered in Amazon Web Services.
https://github.com/shmokmt/awscrondoc

aws-eventbridge aws-glue cron docs-generator go golang

Last synced: 9 days ago
JSON representation

List up cron expressions registered in Amazon Web Services.

• Host: GitHub
• URL: https://github.com/shmokmt/awscrondoc
• Owner: shmokmt
• License: mit
• Created: 2023-04-04T07:24:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-12T22:52:48.000Z (about 2 months ago)
• Last Synced: 2024-09-13T11:54:53.785Z (about 2 months ago)
• Topics: aws-eventbridge, aws-glue, cron, docs-generator, go, golang
• Language: Go
• Homepage: https://pkg.go.dev/github.com/shmokmt/awscrondoc
• Size: 31.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# awscrondoc

[![Go Reference](https://pkg.go.dev/badge/github.com/shmokmt/awscrondoc.svg)](https://pkg.go.dev/github.com/shmokmt/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:

```json

{

  "Version": "2012-10-17",

  "Statement": [

    {

      "Effect": "Allow",

      "Action": ["events:ListRules"],

      "Resource": "*"

    },

    {

      "Effect": "Allow",

      "Action": ["glue:ListTriggers", "glue:GetTrigger"],

      "Resource": "*"

    }

  ]

}

```

## Usage

### Library

```go

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

```