docdb

package

v0.8.2 Latest Latest Go to latest Published: Jul 27, 2022 License: AGPL-3.0 Imports: 11 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 ¶

Index ¶

func ErrCode(msg string, err error) error
type DocDB
- func New(opts ...DocDBOption) DocDB
type DocDBOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ErrCode ¶ added in v0.6.0

func ErrCode(msg string, err error) error

Types ¶

type DocDB ¶

type DocDB struct {
	Service         docdbiface.DocDBAPI
	DefaultKMSKeyId string
	// contains filtered or unexported fields
}

DocDB is a wrapper around the aws docdb service

func New ¶

func New(opts ...DocDBOption) DocDB

func (*DocDB) CreateDBCluster ¶

func (d *DocDB) CreateDBCluster(ctx context.Context, input *docdb.CreateDBClusterInput) (*docdb.DBCluster, error)

CreateDBCluster creates a documentDB cluster

func (*DocDB) CreateDBInstance ¶

func (d *DocDB) CreateDBInstance(ctx context.Context, input *docdb.CreateDBInstanceInput) (*docdb.DBInstance, error)

CreateDBInstance creates a documentDB instance

func (*DocDB) CreateDBSubnetGroup ¶

func (d *DocDB) CreateDBSubnetGroup(ctx context.Context, input *docdb.CreateDBSubnetGroupInput) (*docdb.DBSubnetGroup, error)

CreateDBSubnetGroup creates a documentDB DBSubnetGroup

func (*DocDB) DeleteDBCluster ¶

func (d *DocDB) DeleteDBCluster(ctx context.Context, input *docdb.DeleteDBClusterInput) (*docdb.DeleteDBClusterOutput, error)

DeleteDBCluster deletes a documentDB cluster

func (*DocDB) DeleteDBInstance ¶

func (d *DocDB) DeleteDBInstance(ctx context.Context, input *docdb.DeleteDBInstanceInput) (*docdb.DeleteDBInstanceOutput, error)

DeleteDBInstance deletes a documentDB instance

func (*DocDB) GetDBSubnetGroup ¶

func (d *DocDB) GetDBSubnetGroup(ctx context.Context, name string) ([]*docdb.DBSubnetGroup, error)

GetDBSubnetGroup gets documentDB DBSubnetGroup by name

func (*DocDB) GetDocDBDetails ¶ added in v0.3.0

func (d *DocDB) GetDocDBDetails(ctx context.Context, name string) (*docdb.DBCluster, error)

GetDocDBDetails gets information about a documentDB cluster

func (*DocDB) GetDocDBInstances ¶ added in v0.4.1

func (d *DocDB) GetDocDBInstances(ctx context.Context, name string) ([]*docdb.DBInstance, error)

GetDocDBInstances gets information about all instances in a documentDB cluster

func (*DocDB) GetDocDBTags ¶ added in v0.3.0

func (d *DocDB) GetDocDBTags(ctx context.Context, arn *string) ([]*docdb.Tag, error)

GetDocDBTags gets the tags for a documentDB cluster

func (*DocDB) ListDocDBClusters ¶ added in v0.2.0

func (d *DocDB) ListDocDBClusters(ctx context.Context) ([]string, error)

ListDocDBs lists all documentDB clusters

func (*DocDB) ModifyDBCluster ¶ added in v0.5.0

func (d *DocDB) ModifyDBCluster(ctx context.Context, input *docdb.ModifyDBClusterInput) (*docdb.DBCluster, error)

ModifyDBCluster modifies a documentDB cluster

func (*DocDB) ModifyDBInstance ¶ added in v0.5.0

func (d *DocDB) ModifyDBInstance(ctx context.Context, input *docdb.ModifyDBInstanceInput) (*docdb.DBInstance, error)

ModifyDBInstance modifies a documentDB instance

type DocDBOption ¶

type DocDBOption func(*DocDB)

func WithCredentials ¶

func WithCredentials(key, secret, token, region string) DocDBOption

func WithDefaultKMSKeyId ¶

func WithDefaultKMSKeyId(keyId string) DocDBOption

func WithSession ¶

func WithSession(sess *session.Session) DocDBOption

Source Files ¶

View all Source files

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