api

Documentation

Overview

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/>.

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 DocDBModifyRequest
• type DocDBResponse
• type LogWriter
  • func (w LogWriter) Write(p []byte) (n int, err error)
• type Tag
• type Tags

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

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

DocDBCreateRequest is data used to create a documentDB

type DocDBModifyRequest

type DocDBModifyRequest struct {
	BackupRetentionPeriod  *int64
	DBInstanceClass        *string
	EngineVersion          *string
	MasterUserPassword     *string
	NewDBClusterIdentifier *string
	Tags                   Tags
	VpcSecurityGroupIds    []*string
}

DocDBModifyRequest is data used to modify a documentDB

type DocDBResponse

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 `json:",omitempty"`
	Tags      Tags                `json:",omitempty"`
}

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
}

type Tags

type Tags []Tag