configurations

package
v0.4.1 Latest Latest
Warning

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

Go to latest
Published: Jun 2, 2021 License: Apache-2.0 Imports: 2 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplyConfiguration added in v0.2.1

type ApplyConfiguration struct {
	// Specifies the parameter template ID.
	ConfigurationID string `json:"configuration_id"`
	// Specifies the parameter template name.
	ConfigurationName string `json:"configuration_name"`
	// Specifies the result of applying the parameter template.
	ApplyResults []ApplyConfigurationResult `json:"apply_results"`
	// Specifies whether each parameter template is applied to DB instances successfully.
	Success bool `json:"success"`
}

type ApplyConfigurationResult added in v0.2.1

type ApplyConfigurationResult struct {
	// Indicates the DB instance ID.
	InstanceID string `json:"instance_id"`
	// Indicates the DB instance name.
	InstanceName string `json:"instance_name"`
	// Indicates whether a reboot is required.
	RestartRequired bool `json:"restart_required"`
	// Indicates whether each parameter template is applied to DB instances successfully.
	Success bool `json:"success"`
}

type ApplyOpts added in v0.2.1

type ApplyOpts struct {
	// Specifies the DB instance ID list object.
	InstanceIDs []string `json:"instance_ids" required:"true"`
}

ApplyOpts contains all the instances needed to apply another template.

func (ApplyOpts) ToInstanceTemplateApplyMap added in v0.2.1

func (opts ApplyOpts) ToInstanceTemplateApplyMap() (map[string]interface{}, error)

ToInstanceTemplateApplyMap builds an apply request body from ApplyOpts.

type ApplyOptsBuilder added in v0.2.1

type ApplyOptsBuilder interface {
	ToInstanceTemplateApplyMap() (map[string]interface{}, error)
}

ApplyOptsBuilder allows extensions to update instance templates to the Apply request.

type ApplyResult added in v0.2.1

type ApplyResult struct {
	golangsdk.Result
}

ApplyResult represents the result of a apply operation. Call its Extract method to interpret it.

func Apply added in v0.2.1

func Apply(client *golangsdk.ServiceClient, id string, opts ApplyOptsBuilder) (r ApplyResult)

Apply is used to apply a parameter template to one or more DB instances.

func (ApplyResult) Extract added in v0.2.1

func (r ApplyResult) Extract() (*ApplyConfiguration, error)

Extract is a function that accepts a result and extracts an apply configuration result.

type Configuration

type Configuration struct {
	// Configuration ID
	ID string `json:"id"`
	// Configuration Name
	Name string `json:"name"`
	// Database version Name
	DatastoreVersionName string `json:"datastore_version_name"`
	// Database Name
	DatastoreName string `json:"datastore_name"`
	// Configuration Description
	Description string `json:"description"`
	// Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ.
	Created string `json:"created"`
	// Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ.
	Updated string `json:"updated"`
	// Configuration Parameters
	Parameters []Parameter `json:"configuration_parameters"`
}

type ConfigurationCreate

type ConfigurationCreate struct {
	// Configuration ID
	ID string `json:"id"`
	// Configuration Name
	Name string `json:"name"`
	// Database version Name
	DatastoreVersionName string `json:"datastore_version_name"`
	// Database Name
	DatastoreName string `json:"datastore_name"`
	// Configuration Description
	Description string `json:"description"`
	// Indicates the creation time in the following format: yyyy-MM-ddTHH:mm:ssZ.
	Created string `json:"created"`
	// Indicates the update time in the following format: yyyy-MM-ddTHH:mm:ssZ.
	Updated string `json:"updated"`
}

type CreateOpts

type CreateOpts struct {
	// Configuration Name
	Name string `json:"name" required:"true"`
	// Configuration Description
	Description string `json:"description,omitempty"`
	// Configuration Values
	Values map[string]string `json:"values,omitempty"`
	// Database Object
	DataStore DataStore `json:"datastore" required:"true"`
}

CreateOpts contains all the values needed to create a new configuration.

func (CreateOpts) ToConfigCreateMap

func (opts CreateOpts) ToConfigCreateMap() (map[string]interface{}, error)

ToConfigCreateMap builds a create request body from CreateOpts.

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToConfigCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder allows extensions to add additional parameters to the Create request.

type CreateResult

type CreateResult struct {
	golangsdk.Result
}

CreateResult represents the result of a create operation. Call its Extract method to interpret it as a Configuration.

func Create

func Create(c *golangsdk.ServiceClient, opts CreateOptsBuilder) (r CreateResult)

Create will create a new Config based on the values in CreateOpts.

func (CreateResult) Extract

func (r CreateResult) Extract() (*ConfigurationCreate, error)

Extract is a function that accepts a result and extracts a configuration.

func (CreateResult) ExtractInto

func (r CreateResult) ExtractInto(v interface{}) error

type DataStore

type DataStore struct {
	// DB Engine
	Type string `json:"type" required:"true"`
	// DB version
	Version string `json:"version" required:"true"`
}

type DeleteResult

type DeleteResult struct {
	golangsdk.ErrResult
}

DeleteResult represents the result of a delete operation. Call its ExtractErr method to determine if the request succeeded or failed.

func Delete

func Delete(c *golangsdk.ServiceClient, id string) (r DeleteResult)

Delete will permanently delete a particular Configuration based on its unique ID.

type GetResult

type GetResult struct {
	golangsdk.Result
}

GetResult represents the result of a get operation. Call its Extract method to interpret it as a Configuration.

func Get

func Get(c *golangsdk.ServiceClient, id string) (r GetResult)

Get retrieves a particular Configuration based on its unique ID.

func GetForInstance added in v0.2.7

func GetForInstance(c *golangsdk.ServiceClient, instanceID string) (r GetResult)

GetForInstance retrieves Configuration applied to particular RDS instance configuration ID and Name will be empty

func (GetResult) Extract

func (r GetResult) Extract() (*Configuration, error)

Extract is a function that accepts a result and extracts a configuration.

type ListResult added in v0.2.1

type ListResult struct {
	golangsdk.Result
}

ListResult represents the result of a list operation. Call its Extract method to interpret it as a list of Configurations.

func List added in v0.2.1

func List(client *golangsdk.ServiceClient) (r ListResult)

List is used to obtain the parameter template list, including default parameter templates of all databases and those created by users.

func (ListResult) Extract added in v0.2.1

func (r ListResult) Extract() ([]Configuration, error)

Extract is a function that accepts a result and extracts a list of configurations.

type Parameter

type Parameter struct {
	// Parameter Name
	Name string `json:"name"`
	// Parameter value
	Value string `json:"value"`
	// Whether a restart is required
	RestartRequired bool `json:"restart_required"`
	// Whether the parameter is read-only
	ReadOnly bool `json:"readonly"`
	// Parameter value range
	ValueRange string `json:"value_range"`
	// Parameter type
	Type string `json:"type"`
	// Parameter description
	Description string `json:"description"`
}

type UpdateOpts

type UpdateOpts struct {
	// Configuration Name
	Name string `json:"name,omitempty"`
	// Configuration Description
	Description string `json:"description,omitempty"`
	// Configuration Values
	Values map[string]string `json:"values,omitempty"`
}

UpdateOpts contains all the values needed to update a Configuration.

func (UpdateOpts) ToConfigUpdateMap

func (opts UpdateOpts) ToConfigUpdateMap() (map[string]interface{}, error)

ToConfigUpdateMap builds a update request body from UpdateOpts.

type UpdateOptsBuilder

type UpdateOptsBuilder interface {
	ToConfigUpdateMap() (map[string]interface{}, error)
}

UpdateOptsBuilder allows extensions to add additional parameters to the Update request.

type UpdateResult

type UpdateResult struct {
	golangsdk.ErrResult
}

UpdateResult represents the result of a update operation.

func Update

func Update(c *golangsdk.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)

Update accepts a UpdateOpts struct and uses the values to update a Configuration.The response code from api is 200

Jump to

Keyboard shortcuts

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