api

package

v0.2.0 Latest Latest Go to latest Published: Aug 9, 2021 License: AGPL-3.0 Imports: 29 Imported by: 0

Details

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

Repository

github.com/YaleSpinup/docdb-api

Links

Open Source Insights

Documentation ¶

Overview ¶

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Copyright © 2021 Yale University ¶

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Copyright © 2021 Yale University ¶

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Copyright © 2021 Yale University ¶

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Index ¶

func NewServer(config common.Config) error
func TokenMiddleware(psk []byte, public map[string]string, h http.Handler) http.Handler
type DocDBCreateRequest
type DocDBResponse
type LogWriter
- func (w LogWriter) Write(p []byte) (n int, err error)
type Tag

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewServer ¶

func NewServer(config common.Config) error

NewServer creates a new server and starts it

func TokenMiddleware ¶

func TokenMiddleware(psk []byte, public map[string]string, h http.Handler) http.Handler

TokenMiddleware checks the tokens for non-public URLs

Types ¶

type DocDBCreateRequest ¶ added in v0.2.0

type DocDBCreateRequest struct {
	BackupRetentionPeriod *int64
	InstanceCount         *int
	DBClusterIdentifier   *string
	DBInstanceClass       *string
	EngineVersion         *string
	MasterUsername        *string
	MasterUserPassword    *string
	SubnetIds             []*string
	Tags                  []*Tag
	VpcSecurityGroupIds   []*string
}

DocDBCreateRequest is data used to create a documentDB

type DocDBResponse ¶ added in v0.2.0

type DocDBResponse struct {
	// https://docs.aws.amazon.com/sdk-for-go/api/service/docdb/#DBCluster
	Cluster *docdb.DBCluster
	// https://docs.aws.amazon.com/sdk-for-go/api/service/docdb/#DBInstance
	Instances []*docdb.DBInstance
}

DocDBResponse is the output from documentDB operations

type LogWriter ¶

type LogWriter struct {
	http.ResponseWriter
}

LogWriter is an http.ResponseWriter

func (LogWriter) Write ¶

func (w LogWriter) Write(p []byte) (n int, err error)

Write log message if http response writer returns an error

type Tag ¶

type Tag struct {
	Key   *string
	Value *string
}

Source Files ¶

View all Source files

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