rdsutil

README

# RDS Util

1. Connecting to a DB instance running the MySQL database engine
2. Creating and connecting to a MySQL DB instance
3. How can I troubleshoot connectivity to an Amazon RDS DB instance that uses a public or private subnet of a VPC?
4. Encrypting client connections to MySQL DB instances with SSL/TLS
5. Working with DB parameter groups
6. Amazon RDS examples using SDK for Go V2

MySQL CLI Errors

1. timeout
2. ERROR 2003 (HY000): Can't connect to MySQL server on 'aa.bb.cc.dd' (60)
3. ERROR 2026 (HY000): SSL connection error: unknown error number
4. AWS MySQL ERROR 2026 (HY000): SSL connection error

Documentation

Index

• Constants
• Variables
• func NewRDSClient(cfg *config.AWSConfig) (*rds.RDS, error)
• type ParameterGroupService
  • func (svc *ParameterGroupService) CreateDBClusterParameterGroup(dbClusterParameterGroupName string, dbParameterGroupFamily string, ...) (*rds.CreateDBClusterParameterGroupOutput, error)
  • func (svc *ParameterGroupService) DescribeDBParameterGroup(dbParameterGroupName string, opts *rds.DescribeDBParametersInput) (Parameters, error)
  • func (svc *ParameterGroupService) DescribeDBParameterGroupSets(dbParameterGroupNames []string, opts *rds.DescribeDBParametersInput) (*ParametersSets, error)
  • func (svc *ParameterGroupService) DescribeEngineDefaultParameters(dbParameterGroupFamily string, opts *rds.DescribeEngineDefaultParametersInput) (Parameters, error)
  • func (svc *ParameterGroupService) ModifyDBParameterGroup(dbParameterGroupName string, params map[string]string) (*rds.DBParameterGroupNameMessage, error)
• type Parameters
  • func MapToParameters(m map[string]string) Parameters
  • func (p Parameters) Map() map[string]string
  • func (p Parameters) Names() []string
  • func (p Parameters) Table() table.Table
  • func (p Parameters) ToPointers() []*rds.Parameter
• type ParametersResponse
  • func ParametersResponseReadBytes(b []byte) (ParametersResponse, error)
  • func ParametersResponseReadFile(name string) (ParametersResponse, error)
• type ParametersSet
  • func NewParametersSet() ParametersSet
  • func (ps *ParametersSet) AddParameters(p ...rds.Parameter)
  • func (ps *ParametersSet) GetValue(key string) (string, error)
  • func (ps *ParametersSet) Map() map[string]string
  • func (ps *ParametersSet) ModifyMapToPointerSlice(m map[string]string) ([]*rds.Parameter, error)
  • func (ps *ParametersSet) Names() []string
• type ParametersSets
  • func NewParametersSets() *ParametersSets
  • func (pss *ParametersSets) GetParamNameValues(paramName string) map[string]*string
  • func (pss *ParametersSets) Names() []string
• type RDSClientMore
  • func NewRDSClientMore(cfg *config.AWSConfig) (*RDSClientMore, error)

Constants

const (
	ApplyMethodImmediate     = "immediate"
	ApplyMethodPendingReboot = "pending-reboot"
)

const (
	DBPGFAuroraMySQL57 = "aurora-mysql5.7"
	DBPGFMySQL80       = "mysql8.0"
	DBPGFMySQL57       = "mysql5.7"
)

Variables

var ErrPagesGT1000 = errors.New("more than 1000 pages returned")

var ErrParameterNotFound = errors.New("parameter not found")

Functions

func NewRDSClient

func NewRDSClient(cfg *config.AWSConfig) (*rds.RDS, error)

Types

type ParameterGroupService

type ParameterGroupService struct {
	// contains filtered or unexported fields
}

func (*ParameterGroupService) CreateDBClusterParameterGroup

func (svc *ParameterGroupService) CreateDBClusterParameterGroup(
	dbClusterParameterGroupName string,
	dbParameterGroupFamily string,
	description string,
	opts *rds.CreateDBClusterParameterGroupInput) (*rds.CreateDBClusterParameterGroupOutput, error)

func (*ParameterGroupService) DescribeDBParameterGroup

func (svc *ParameterGroupService) DescribeDBParameterGroup(dbParameterGroupName string, opts *rds.DescribeDBParametersInput) (Parameters, error)

DescribeDBParameterGroup returnsthe parameters for a parameter group. The corresponding AWS SDk Method is `DescribeDBParameters()`.

func (*ParameterGroupService) DescribeDBParameterGroupSets

func (svc *ParameterGroupService) DescribeDBParameterGroupSets(dbParameterGroupNames []string, opts *rds.DescribeDBParametersInput) (*ParametersSets, error)

func (*ParameterGroupService) DescribeEngineDefaultParameters

func (svc *ParameterGroupService) DescribeEngineDefaultParameters(dbParameterGroupFamily string, opts *rds.DescribeEngineDefaultParametersInput) (Parameters, error)

DescribeEngineDefaultParameters is a wrapper for https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#RDS.DescribeEngineDefaultParameters

func (*ParameterGroupService) ModifyDBParameterGroup

func (svc *ParameterGroupService) ModifyDBParameterGroup(dbParameterGroupName string, params map[string]string) (*rds.DBParameterGroupNameMessage, error)

ModifyDBParameterGroup is a wrapper for https://docs.aws.amazon.com/sdk-for-go/api/service/rds/#RDS.ModifyDBParameterGroup .

type Parameters

type Parameters []rds.Parameter

func MapToParameters

func MapToParameters(m map[string]string) Parameters

func (Parameters) Map

func (p Parameters) Map() map[string]string

func (Parameters) Names

func (p Parameters) Names() []string

func (Parameters) Table

func (p Parameters) Table() table.Table

func (Parameters) ToPointers

func (p Parameters) ToPointers() []*rds.Parameter

type ParametersResponse

type ParametersResponse struct {
	Parameters Parameters
}

ParametersResponse represents the response from the AWS CLI utility for reading database parameter groups.

func ParametersResponseReadBytes

func ParametersResponseReadBytes(b []byte) (ParametersResponse, error)

func ParametersResponseReadFile

func ParametersResponseReadFile(name string) (ParametersResponse, error)

type ParametersSet

type ParametersSet struct {
	Data map[string]rds.Parameter
}

func NewParametersSet

func NewParametersSet() ParametersSet

func (*ParametersSet) AddParameters

func (ps *ParametersSet) AddParameters(p ...rds.Parameter)

func (*ParametersSet) GetValue

func (ps *ParametersSet) GetValue(key string) (string, error)

func (*ParametersSet) Map

func (ps *ParametersSet) Map() map[string]string

func (*ParametersSet) ModifyMapToPointerSlice

func (ps *ParametersSet) ModifyMapToPointerSlice(m map[string]string) ([]*rds.Parameter, error)

ModifyMapToPointerSlice converts a `map[string]string` to a `[]*rds.Parameter` adding the current ApplyType.` This is used in `ModifyDBParameterGroup()`.

func (*ParametersSet) Names

func (ps *ParametersSet) Names() []string

type ParametersSets

type ParametersSets struct {
	Data map[string]ParametersSet // paramSetName
}

func NewParametersSets

func NewParametersSets() *ParametersSets

func (*ParametersSets) GetParamNameValues

func (pss *ParametersSets) GetParamNameValues(paramName string) map[string]*string

GetParamNameValues returns the values for a particular param name where the keys are the ParameterSet keys and the value is the value of the param. If the param is not present, a `nil` is returned in the map.

func (*ParametersSets) Names

func (pss *ParametersSets) Names() []string

type RDSClientMore

type RDSClientMore struct {
	Parameter *ParameterGroupService
	// contains filtered or unexported fields
}

func NewRDSClientMore

func NewRDSClientMore(cfg *config.AWSConfig) (*RDSClientMore, error)