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.

DescribeReservedDBInstancesInput

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

type DescribeReservedDBInstancesInput struct { DBInstanceClass *string `type:"string"` Duration *string `type:"string"` Filters []*Filter `locationNameList:"Filter" type:"list"` Marker *string `type:"string"` MaxRecords *int64 `type:"integer"` MultiAZ *bool `type:"boolean"` OfferingType *string `type:"string"` ProductDescription *string `type:"string"` ReservedDBInstanceId *string `type:"string"` ReservedDBInstancesOfferingId *string `type:"string"` }

DBInstanceClass

Type: *string

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Duration

Type: *string

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

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

Marker

Type: *string

An optional pagination token provided by a previous 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 than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

MultiAZ

Type: *bool

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

OfferingType

Type: *string

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

ProductDescription

Type: *string

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

ReservedDBInstanceId

Type: *string

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

ReservedDBInstancesOfferingId

Type: *string

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Method

GoString

func (s DescribeReservedDBInstancesInput) GoString() string

GoString returns the string representation

SetDBInstanceClass

func (s *DescribeReservedDBInstancesInput) SetDBInstanceClass(v string) *DescribeReservedDBInstancesInput

SetDBInstanceClass sets the DBInstanceClass field's value.

SetDuration

func (s *DescribeReservedDBInstancesInput) SetDuration(v string) *DescribeReservedDBInstancesInput

SetDuration sets the Duration field's value.

SetFilters

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

SetFilters sets the Filters field's value.

SetMarker

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

SetMarker sets the Marker field's value.

SetMaxRecords

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

SetMaxRecords sets the MaxRecords field's value.

SetMultiAZ

func (s *DescribeReservedDBInstancesInput) SetMultiAZ(v bool) *DescribeReservedDBInstancesInput

SetMultiAZ sets the MultiAZ field's value.

SetOfferingType

func (s *DescribeReservedDBInstancesInput) SetOfferingType(v string) *DescribeReservedDBInstancesInput

SetOfferingType sets the OfferingType field's value.

SetProductDescription

func (s *DescribeReservedDBInstancesInput) SetProductDescription(v string) *DescribeReservedDBInstancesInput

SetProductDescription sets the ProductDescription field's value.

SetReservedDBInstanceId

func (s *DescribeReservedDBInstancesInput) SetReservedDBInstanceId(v string) *DescribeReservedDBInstancesInput

SetReservedDBInstanceId sets the ReservedDBInstanceId field's value.

SetReservedDBInstancesOfferingId

func (s *DescribeReservedDBInstancesInput) SetReservedDBInstancesOfferingId(v string) *DescribeReservedDBInstancesInput

SetReservedDBInstancesOfferingId sets the ReservedDBInstancesOfferingId field's value.

String

func (s DescribeReservedDBInstancesInput) String() string

String returns the string representation

Validate

func (s *DescribeReservedDBInstancesInput) Validate() error

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

On this page: