rds

package
v1.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 19, 2021 License: LGPL-3.0 Imports: 11 Imported by: 0

Documentation

Overview

The rds package provides types and functions for interaction with the AWS Relational Database service (rds)

Index

Constants

View Source 
const APIVersion = "2014-10-31"

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthorizeDBSecurityGroupIngress 

type AuthorizeDBSecurityGroupIngress struct {
	Cidr                    string
	DBSecurityGroupName     string
	EC2SecurityGroupId      string
	EC2SecurityGroupName    string
	EC2SecurityGroupOwnerId string
}

The CreateDBSecurityGroup request parameters

type CreateDBInstance 

type CreateDBInstance struct {
	AllocatedStorage           int
	StorageType                string
	AvailabilityZone           string
	BackupRetentionPeriod      int
	DBInstanceClass            string
	DBInstanceIdentifier       string
	DBName                     string
	DBSubnetGroupName          string
	Engine                     string
	EngineVersion              string
	StorageEncrypted           bool
	Iops                       int
	MasterUsername             string
	MasterUserPassword         string
	MultiAZ                    bool
	Port                       int
	PreferredBackupWindow      string // hh24:mi-hh24:mi
	PreferredMaintenanceWindow string // ddd:hh24:mi-ddd:hh24:mi
	PubliclyAccessible         bool
	VpcSecurityGroupIds        []string
	DBSecurityGroupNames       []string
	DBParameterGroupName       string

	SetAllocatedStorage      bool
	SetBackupRetentionPeriod bool
	SetIops                  bool
	SetPort                  bool
}

The CreateDBInstance request parameters

type CreateDBParameterGroup 

type CreateDBParameterGroup struct {
	DBParameterGroupFamily string
	DBParameterGroupName   string
	Description            string
}

The CreateDBParameterGroup request parameters

type CreateDBSecurityGroup 

type CreateDBSecurityGroup struct {
	DBSecurityGroupName        string
	DBSecurityGroupDescription string
}

The CreateDBSecurityGroup request parameters

type CreateDBSubnetGroup 

type CreateDBSubnetGroup struct {
	DBSubnetGroupName        string
	DBSubnetGroupDescription string
	SubnetIds                []string
}

The CreateDBSubnetGroup request parameters

type DBInstance 

type DBInstance struct {
	Address                    string        `xml:"Endpoint>Address"`
	AllocatedStorage           int           `xml:"AllocatedStorage"`
	StorageType                string        `xml:"StorageType"`
	AvailabilityZone           string        `xml:"AvailabilityZone"`
	BackupRetentionPeriod      int           `xml:"BackupRetentionPeriod"`
	DBInstanceClass            string        `xml:"DBInstanceClass"`
	DBInstanceIdentifier       string        `xml:"DBInstanceIdentifier"`
	DBInstanceStatus           string        `xml:"DBInstanceStatus"`
	DBName                     string        `xml:"DBName"`
	Engine                     string        `xml:"Engine"`
	EngineVersion              string        `xml:"EngineVersion"`
	StorageEncrypted           bool          `xml:"StorageEncrypted"`
	MasterUsername             string        `xml:"MasterUsername"`
	MultiAZ                    bool          `xml:"MultiAZ"`
	Port                       int           `xml:"Endpoint>Port"`
	PreferredBackupWindow      string        `xml:"PreferredBackupWindow"`
	PreferredMaintenanceWindow string        `xml:"PreferredMaintenanceWindow"`
	VpcSecurityGroupIds        []string      `xml:"VpcSecurityGroups>VpcSecurityGroupMembership>VpcSecurityGroupId"`
	DBSecurityGroupNames       []string      `xml:"DBSecurityGroups>DBSecurityGroup>DBSecurityGroupName"`
	DBSubnetGroup              DBSubnetGroup `xml:"DBSubnetGroup"`
	DBParameterGroupName       string        `xml:"DBParameterGroups>DBParameterGroup>DBParameterGroupName"`
}

type DBParameterGroup 

type DBParameterGroup struct {
	DBParameterGroupFamily string `xml:"DBParameterGroupFamily"`
	DBParameterGroupName   string `xml:"DBParameterGroupName"`
	Description            string `xml:"Description"`
}

type DBSecurityGroup 

type DBSecurityGroup struct {
	Description              string   `xml:"DBSecurityGroupDescription"`
	Name                     string   `xml:"DBSecurityGroupName"`
	EC2SecurityGroupNames    []string `xml:"EC2SecurityGroups>EC2SecurityGroup>EC2SecurityGroupName"`
	EC2SecurityGroupIds      []string `xml:"EC2SecurityGroups>EC2SecurityGroup>EC2SecurityGroupId"`
	EC2SecurityGroupOwnerIds []string `xml:"EC2SecurityGroups>EC2SecurityGroup>EC2SecurityGroupOwnerId"`
	EC2SecurityGroupStatuses []string `xml:"EC2SecurityGroups>EC2SecurityGroup>Status"`
	CidrIps                  []string `xml:"IPRanges>IPRange>CIDRIP"`
	CidrStatuses             []string `xml:"IPRanges>IPRange>Status"`
}

type DBSnapshot 

type DBSnapshot struct {
	AllocatedStorage     int    `xml:"AllocatedStorage"`
	AvailabilityZone     string `xml:"AvailabilityZone"`
	DBInstanceIdentifier string `xml:"DBInstanceIdentifier"`
	DBSnapshotIdentifier string `xml:"DBSnapshotIdentifier"`
	Engine               string `xml:"Engine"`
	EngineVersion        string `xml:"EngineVersion"`
	InstanceCreateTime   string `xml:"InstanceCreateTime"`
	Iops                 int    `xml:"Iops"`
	LicenseModel         string `xml:"LicenseModel"`
	MasterUsername       string `xml:"MasterUsername"`
	OptionGroupName      string `xml:"OptionGroupName"`
	PercentProgress      int    `xml:"PercentProgress"`
	Port                 int    `xml:"Port"`
	SnapshotCreateTime   string `xml:"SnapshotCreateTime"`
	SnapshotType         string `xml:"SnapshotType"`
	SourceRegion         string `xml:"SourceRegion"`
	Status               string `xml:"Status"`
	VpcId                string `xml:"VpcId"`
}

type DBSubnetGroup 

type DBSubnetGroup struct {
	Description string   `xml:"DBSubnetGroupDescription"`
	Name        string   `xml:"DBSubnetGroupName"`
	Status      string   `xml:"SubnetGroupStatus"`
	SubnetIds   []string `xml:"Subnets>Subnet>SubnetIdentifier"`
	VpcId       string   `xml:"VpcId"`
}

type DeleteDBInstance 

type DeleteDBInstance struct {
	FinalDBSnapshotIdentifier string
	DBInstanceIdentifier      string
	SkipFinalSnapshot         bool
}

DeleteDBInstance request params

type DeleteDBParameterGroup 

type DeleteDBParameterGroup struct {
	DBParameterGroupName string
}

DeleteDBParameterGroup request params

type DeleteDBSecurityGroup 

type DeleteDBSecurityGroup struct {
	DBSecurityGroupName string
}

DeleteDBSecurityGroup request params

type DeleteDBSubnetGroup 

type DeleteDBSubnetGroup struct {
	DBSubnetGroupName string
}

DeleteDBSubnetGroup request params

type DescribeDBInstances 

type DescribeDBInstances struct {
	DBInstanceIdentifier string
}

DescribeDBInstances request params

type DescribeDBInstancesResp 

type DescribeDBInstancesResp struct {
	RequestId   string       `xml:"ResponseMetadata>RequestId"`
	DBInstances []DBInstance `xml:"DescribeDBInstancesResult>DBInstances>DBInstance"`
}

type DescribeDBParameterGroups 

type DescribeDBParameterGroups struct {
	DBParameterGroupName string
}

DescribeDBParameterGroups request params

type DescribeDBParameterGroupsResp 

type DescribeDBParameterGroupsResp struct {
	RequestId         string             `xml:"ResponseMetadata>RequestId"`
	DBParameterGroups []DBParameterGroup `xml:"DescribeDBParameterGroupsResult>DBParameterGroups>DBParameterGroup"`
}

type DescribeDBParameters 

type DescribeDBParameters struct {
	DBParameterGroupName string
	Source               string
}

DescribeDBParameters request params

type DescribeDBParametersResp 

type DescribeDBParametersResp struct {
	RequestId  string      `xml:"ResponseMetadata>RequestId"`
	Parameters []Parameter `xml:"DescribeDBParametersResult>Parameters>Parameter"`
}

type DescribeDBSecurityGroups 

type DescribeDBSecurityGroups struct {
	DBSecurityGroupName string
}

DescribeDBSecurityGroups request params

type DescribeDBSecurityGroupsResp 

type DescribeDBSecurityGroupsResp struct {
	RequestId        string            `xml:"ResponseMetadata>RequestId"`
	DBSecurityGroups []DBSecurityGroup `xml:"DescribeDBSecurityGroupsResult>DBSecurityGroups>DBSecurityGroup"`
}

type DescribeDBSnapshots 

type DescribeDBSnapshots struct {
	DBInstanceIdentifier string
	DBSnapshotIdentifier string
	SnapshotType         string
}

DescribeDBSnapshots request params

type DescribeDBSnapshotsResp 

type DescribeDBSnapshotsResp struct {
	RequestId   string       `xml:"ResponseMetadata>RequestId"`
	DBSnapshots []DBSnapshot `xml:"DescribeDBSnapshotsResult>DBSnapshots>DBSnapshot"`
}

type DescribeDBSubnetGroups 

type DescribeDBSubnetGroups struct {
	DBSubnetGroupName string
}

DescribeDBSubnetGroups request params

type DescribeDBSubnetGroupsResp 

type DescribeDBSubnetGroupsResp struct {
	RequestId      string          `xml:"ResponseMetadata>RequestId"`
	DBSubnetGroups []DBSubnetGroup `xml:"DescribeDBSubnetGroupsResult>DBSubnetGroups>DBSubnetGroup"`
}

type Error 

type Error struct {
	// HTTP status code of the error.
	StatusCode int

	// AWS code of the error.
	Code string

	// Message explaining the error.
	Message string
}

Error encapsulates an Rds error.

func (*Error) Error 

func (e *Error) Error() string

type ModifyDBParameterGroup 

type ModifyDBParameterGroup struct {
	DBParameterGroupName string
	Parameters           []Parameter
}

ModifyDBParameterGroup request parameters

type Parameter 

type Parameter struct {
	ApplyMethod    string `xml:"ApplyMethod"`
	ParameterName  string `xml:"ParameterName"`
	ParameterValue string `xml:"ParameterValue"`
}

type Rds 

type Rds struct {
	aws.Auth
	aws.Region
	// contains filtered or unexported fields
}

The Rds type encapsulates operations operations with the Rds endpoint.

func New 

func New(auth aws.Auth, region aws.Region) *Rds

New creates a new Rds instance.

func NewWithClient 

func NewWithClient(auth aws.Auth, region aws.Region, httpClient *http.Client) *Rds

func (*Rds) AuthorizeDBSecurityGroupIngress 

func (rds *Rds) AuthorizeDBSecurityGroupIngress(options *AuthorizeDBSecurityGroupIngress) (resp *SimpleResp, err error)

func (*Rds) CreateDBInstance 

func (rds *Rds) CreateDBInstance(options *CreateDBInstance) (resp *SimpleResp, err error)

func (*Rds) CreateDBParameterGroup 

func (rds *Rds) CreateDBParameterGroup(options *CreateDBParameterGroup) (resp *SimpleResp, err error)

func (*Rds) CreateDBSecurityGroup 

func (rds *Rds) CreateDBSecurityGroup(options *CreateDBSecurityGroup) (resp *SimpleResp, err error)

func (*Rds) CreateDBSubnetGroup 

func (rds *Rds) CreateDBSubnetGroup(options *CreateDBSubnetGroup) (resp *SimpleResp, err error)

func (*Rds) DeleteDBInstance 

func (rds *Rds) DeleteDBInstance(options *DeleteDBInstance) (resp *SimpleResp, err error)

func (*Rds) DeleteDBParameterGroup 

func (rds *Rds) DeleteDBParameterGroup(options *DeleteDBParameterGroup) (resp *SimpleResp, err error)

func (*Rds) DeleteDBSecurityGroup 

func (rds *Rds) DeleteDBSecurityGroup(options *DeleteDBSecurityGroup) (resp *SimpleResp, err error)

func (*Rds) DeleteDBSubnetGroup 

func (rds *Rds) DeleteDBSubnetGroup(options *DeleteDBSubnetGroup) (resp *SimpleResp, err error)

func (*Rds) DescribeDBInstances 

func (rds *Rds) DescribeDBInstances(options *DescribeDBInstances) (resp *DescribeDBInstancesResp, err error)

func (*Rds) DescribeDBParameterGroups 

func (rds *Rds) DescribeDBParameterGroups(options *DescribeDBParameterGroups) (resp *DescribeDBParameterGroupsResp, err error)

func (*Rds) DescribeDBParameters 

func (rds *Rds) DescribeDBParameters(options *DescribeDBParameters) (resp *DescribeDBParametersResp, err error)

func (*Rds) DescribeDBSecurityGroups 

func (rds *Rds) DescribeDBSecurityGroups(options *DescribeDBSecurityGroups) (resp *DescribeDBSecurityGroupsResp, err error)

func (*Rds) DescribeDBSnapshots 

func (rds *Rds) DescribeDBSnapshots(options *DescribeDBSnapshots) (resp *DescribeDBSnapshotsResp, err error)

func (*Rds) DescribeDBSubnetGroups 

func (rds *Rds) DescribeDBSubnetGroups(options *DescribeDBSubnetGroups) (resp *DescribeDBSubnetGroupsResp, err error)

func (*Rds) ModifyDBParameterGroup 

func (rds *Rds) ModifyDBParameterGroup(options *ModifyDBParameterGroup) (resp *SimpleResp, err error)

func (*Rds) RestoreDBInstanceFromDBSnapshot 

func (rds *Rds) RestoreDBInstanceFromDBSnapshot(options *RestoreDBInstanceFromDBSnapshot) (resp *SimpleResp, err error)

type RestoreDBInstanceFromDBSnapshot 

type RestoreDBInstanceFromDBSnapshot struct {
	DBInstanceIdentifier    string
	DBSnapshotIdentifier    string
	AutoMinorVersionUpgrade bool
	AvailabilityZone        string
	DBInstanceClass         string
	DBName                  string
	DBSubnetGroupName       string
	Engine                  string
	Iops                    int
	LicenseModel            string
	MultiAZ                 bool
	OptionGroupName         string
	Port                    int
	PubliclyAccessible      bool

	SetIops bool
	SetPort bool
}

type SimpleResp 

type SimpleResp struct {
	RequestId string `xml:"ResponseMetadata>RequestId"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.