rds

Documentation

Index

• type Client
  • func NewSession(sess *session.Session, c common.CommonConfig) *Client
  • func (r *Client) DescribeDBClusterSnaphot(ctx buffalo.Context, snapshotId string) (*rds.DBClusterSnapshot, error)
  • func (r *Client) DescribeDBEngineVersions(ctx buffalo.Context, engine, engineVersion string) ([]*rds.DBEngineVersion, error)
  • func (r *Client) DescribeDBSnaphot(ctx buffalo.Context, snapshotId string) (*rds.DBSnapshot, error)
  • func (cl Client) DetermineArn(dbName string) ([]string, error)
  • func (cl Client) DetermineParameterGroupFamily(engine, engineVersion *string) (string, error)
  • func (r *Client) GetSnapshotInfo(c buffalo.Context, snapshotId string) (*SnapshotInfo, error)
  • func (r *Client) ModifyDBSnapshot(c buffalo.Context, snap, engineversion string) (*rds.DBSnapshot, error)
  • func (r *Client) StartDatabase(ctx buffalo.Context, id string) error
  • func (r *Client) StopDatabase(ctx buffalo.Context, id string) error
• type SnapshotInfo

Types

type Client

type Client struct {
	Service                            rdsiface.RDSAPI
	DefaultSubnetGroup                 string
	DefaultDBParameterGroupName        map[string]string
	DefaultDBClusterParameterGroupName map[string]string
}

Client struct contains the initialized RDS service and other RDS-related parameters

func NewSession

func NewSession(sess *session.Session, c common.CommonConfig) *Client

NewSession creates an AWS session for RDS and returns an RDSClient

func (*Client) DescribeDBClusterSnaphot

func (r *Client) DescribeDBClusterSnaphot(ctx buffalo.Context, snapshotId string) (*rds.DBClusterSnapshot, error)

func (*Client) DescribeDBEngineVersions

func (r *Client) DescribeDBEngineVersions(ctx buffalo.Context, engine, engineVersion string) ([]*rds.DBEngineVersion, error)

func (*Client) DescribeDBSnaphot

func (r *Client) DescribeDBSnaphot(ctx buffalo.Context, snapshotId string) (*rds.DBSnapshot, error)

func (Client) DetermineArn

func (cl Client) DetermineArn(dbName string) ([]string, error)

DetermineArn returns the ARN for an RDS instance or cluster given the database name It could return 2 ARNs if a cluster and instance with the same name exist

func (Client) DetermineParameterGroupFamily

func (cl Client) DetermineParameterGroupFamily(engine, engineVersion *string) (string, error)

DetermineParameterGroupFamily returns the DBParameterGroupFamily based on the given database Engine and EngineVersion e.g. given engine "postgres" and engineVersion "10.5" it will return "postgres10"

func (*Client) GetSnapshotInfo

func (r *Client) GetSnapshotInfo(c buffalo.Context, snapshotId string) (*SnapshotInfo, error)

func (*Client) ModifyDBSnapshot

func (r *Client) ModifyDBSnapshot(c buffalo.Context, snap, engineversion string) (*rds.DBSnapshot, error)

func (*Client) StartDatabase

func (r *Client) StartDatabase(ctx buffalo.Context, id string) error

StartDatabase starts an RDS database instance or cluster

func (*Client) StopDatabase

func (r *Client) StopDatabase(ctx buffalo.Context, id string) error

StopDatabase stops an RDS database instance or cluster. SQL server in Multi-AZ configuration is not supported. Note: this operation can take a long time and clusters/instances stopped for more than 7 days will be automatically started so patches can be applied. https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html

type SnapshotInfo

type SnapshotInfo struct {
	Engine, EngineVersion string
}