AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribeOptionGroupsInput

import "github.com/aws/aws-sdk-go/service/rds"

type DescribeOptionGroupsInput struct { EngineName *string `type:"string"` Filters []*Filter `locationNameList:"Filter" type:"list"` MajorEngineVersion *string `type:"string"` Marker *string `type:"string"` MaxRecords *int64 `type:"integer"` OptionGroupName *string `type:"string"` }

EngineName

Type: *string

Filters the list of option groups to only include groups associated with a specific database engine.

Filters

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

  • DescribeDBClusterBacktracks

  • DescribeDBClusterEndpoints

  • DescribeDBClusters

  • DescribeDBInstances

  • DescribePendingMaintenanceActions

MajorEngineVersion

Type: *string

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Marker

Type: *string

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

Type: *int64

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

OptionGroupName

Type: *string

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Method

GoString

func (s DescribeOptionGroupsInput) GoString() string

GoString returns the string representation

SetEngineName

func (s *DescribeOptionGroupsInput) SetEngineName(v string) *DescribeOptionGroupsInput

SetEngineName sets the EngineName field's value.

SetFilters

func (s *DescribeOptionGroupsInput) SetFilters(v []*Filter) *DescribeOptionGroupsInput

SetFilters sets the Filters field's value.

SetMajorEngineVersion

func (s *DescribeOptionGroupsInput) SetMajorEngineVersion(v string) *DescribeOptionGroupsInput

SetMajorEngineVersion sets the MajorEngineVersion field's value.

SetMarker

func (s *DescribeOptionGroupsInput) SetMarker(v string) *DescribeOptionGroupsInput

SetMarker sets the Marker field's value.

SetMaxRecords

func (s *DescribeOptionGroupsInput) SetMaxRecords(v int64) *DescribeOptionGroupsInput

SetMaxRecords sets the MaxRecords field's value.

SetOptionGroupName

func (s *DescribeOptionGroupsInput) SetOptionGroupName(v string) *DescribeOptionGroupsInput

SetOptionGroupName sets the OptionGroupName field's value.

String

func (s DescribeOptionGroupsInput) String() string

String returns the string representation

Validate

func (s *DescribeOptionGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: