actions

package

v0.10.0-pre Latest Latest Go to latest Published: Feb 22, 2021 License: AGPL-3.0 Imports: 21 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/YaleSpinup/rds-api

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func App() *buffalo.App
func DatabasesDelete(c buffalo.Context) error
func DatabasesGet(c buffalo.Context) error
func DatabasesList(c buffalo.Context) error
func DatabasesPost(c buffalo.Context) error
func DatabasesPut(c buffalo.Context) error
func DatabasesPutState(c buffalo.Context) error
func ErrCode(msg string, err error) error
func PingPong(c buffalo.Context) error
func VersionHandler(c buffalo.Context) error
type DatabaseCreateInput
type DatabaseCreateOutput
type DatabaseDeleteOutput
type DatabaseModifyInput
type DatabaseModifyOutput
type DatabaseStateInput

Constants ¶

This section is empty.

Variables ¶

View Source

var (

	// ENV is used to help switch settings based on where the
	// application is being run. Default is "development".
	ENV = envy.Get("GO_ENV", "development")

	// AppConfig holds the configuration information for the app
	AppConfig common.Config

	// RDS is a global map of RDS clients
	RDS = make(map[string]rds.Client)

	// Version is the main version number
	Version = rdsapi.Version

	// VersionPrerelease is a prerelease marker
	VersionPrerelease = rdsapi.VersionPrerelease

	// BuildStamp is the timestamp the binary was built, it should be set at buildtime with ldflags
	BuildStamp = rdsapi.BuildStamp

	// GitHash is the git sha of the built binary, it should be set at buildtime with ldflags
	GitHash = rdsapi.GitHash
)

Functions ¶

func App ¶

func App() *buffalo.App

App is where all routes and middleware for buffalo should be defined

func DatabasesDelete ¶

func DatabasesDelete(c buffalo.Context) error

DatabasesDelete deletes a database in a given account

func DatabasesGet ¶

func DatabasesGet(c buffalo.Context) error

DatabasesGet gets details about a specific database If the `all=true` parameter is passed it will return a list of clusters in addition to instances.

func DatabasesList ¶ added in v0.0.7

func DatabasesList(c buffalo.Context) error

DatabasesList gets a list of databases for a given account If the `all=true` parameter is passed it will return a list of clusters in addition to instances.

func DatabasesPost ¶

func DatabasesPost(c buffalo.Context) error

DatabasesPost creates a database in a given account

func DatabasesPut ¶ added in v0.2.0

func DatabasesPut(c buffalo.Context) error

DatabasesPut modifies a database in a given account

func DatabasesPutState ¶ added in v0.8.0

func DatabasesPutState(c buffalo.Context) error

DatabasesPutState stops or starts a database in a given account

func ErrCode ¶ added in v0.10.0

func ErrCode(msg string, err error) error

func VersionHandler ¶ added in v0.5.0

func VersionHandler(c buffalo.Context) error

VersionHandler returns the app version.

Types ¶

type DatabaseCreateInput ¶ added in v0.0.7

type DatabaseCreateInput struct {
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#CreateDBClusterInput
	Cluster *rds.CreateDBClusterInput
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#CreateDBInstanceInput
	Instance *rds.CreateDBInstanceInput
}

DatabaseCreateInput is the input for creating a new database The Instance part is required and defines the database instance properties The Cluster is optional if the created database instance belongs to a new cluster

type DatabaseCreateOutput ¶ added in v0.9.0

type DatabaseCreateOutput struct {
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#CreateDBClusterOutput
	Cluster *rds.CreateDBClusterOutput
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#CreateDBInstanceOutput
	Instance *rds.CreateDBInstanceOutput
}

DatabaseCreateOutput is the output from creating a new database

type DatabaseDeleteOutput ¶ added in v0.9.0

type DatabaseDeleteOutput struct {
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#DeleteDBClusterOutput
	Cluster *rds.DeleteDBClusterOutput
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#DeleteDBInstanceOutput
	Instance *rds.DeleteDBInstanceOutput
}

DatabaseDeleteOutput is the output from deleting a database

type DatabaseModifyInput ¶ added in v0.2.0

type DatabaseModifyInput struct {
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#ModifyDBClusterInput
	Cluster *rds.ModifyDBClusterInput
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#ModifyDBInstanceInput
	Instance *rds.ModifyDBInstanceInput
	Tags     []*rds.Tag
}

DatabaseModifyInput is the input for modifying an existing database

type DatabaseModifyOutput ¶ added in v0.9.0

type DatabaseModifyOutput struct {
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#ModifyDBClusterOutput
	Cluster *rds.ModifyDBClusterOutput
	// https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#ModifyDBInstanceOutput
	Instance *rds.ModifyDBInstanceOutput
}

DatabaseModifyOutput is the output from modifying an existing database

type DatabaseStateInput ¶ added in v0.8.0

type DatabaseStateInput struct {
	State string
}

DatabaseStateInput is the input for changing the database state

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL