Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeOrderableDBInstanceOptions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeOrderableDBInstanceOptions Source #

See: newDescribeOrderableDBInstanceOptions smart constructor.

Constructors

DescribeOrderableDBInstanceOptions'

Fields

availabilityZoneGroup :: Maybe Text
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
dbInstanceClass :: Maybe Text
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
engineVersion :: Maybe Text
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
filters :: Maybe [Filter]
This parameter isn't currently supported.
licenseModel :: Maybe Text
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
RDS Custom supports only the BYOL licensing model.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 10000.
vpc :: Maybe Bool
A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
engine :: Text
The name of the engine to retrieve DB instance options for.
Valid Values:
- aurora (for MySQL 5.6-compatible Aurora)
- aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
- ```
aurora-postgresql
```
- ```
mariadb
```
- ```
mysql
```
- ```
oracle-ee
```
- ```
oracle-ee-cdb
```
- ```
oracle-se2
```
- ```
oracle-se2-cdb
```
- ```
postgres
```
- ```
sqlserver-ee
```
- ```
sqlserver-se
```
- ```
sqlserver-ex
```
- ```
sqlserver-web
```

Instances

Instances details

ToHeaders DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods toHeaders :: DescribeOrderableDBInstanceOptions -> [Header] #
ToPath DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods toPath :: DescribeOrderableDBInstanceOptions -> ByteString #
ToQuery DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods toQuery :: DescribeOrderableDBInstanceOptions -> QueryString #
AWSPager DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods page :: DescribeOrderableDBInstanceOptions -> AWSResponse DescribeOrderableDBInstanceOptions -> Maybe DescribeOrderableDBInstanceOptions #
AWSRequest DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Associated Types type AWSResponse DescribeOrderableDBInstanceOptions # Methods request :: (Service -> Service) -> DescribeOrderableDBInstanceOptions -> Request DescribeOrderableDBInstanceOptions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeOrderableDBInstanceOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOrderableDBInstanceOptions))) #
Generic DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Associated Types type Rep DescribeOrderableDBInstanceOptions :: Type -> Type # Methods from :: DescribeOrderableDBInstanceOptions -> Rep DescribeOrderableDBInstanceOptions x # to :: Rep DescribeOrderableDBInstanceOptions x -> DescribeOrderableDBInstanceOptions #
Read DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods readsPrec :: Int -> ReadS DescribeOrderableDBInstanceOptions # readList :: ReadS [DescribeOrderableDBInstanceOptions] # readPrec :: ReadPrec DescribeOrderableDBInstanceOptions # readListPrec :: ReadPrec [DescribeOrderableDBInstanceOptions] #
Show DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods showsPrec :: Int -> DescribeOrderableDBInstanceOptions -> ShowS # show :: DescribeOrderableDBInstanceOptions -> String # showList :: [DescribeOrderableDBInstanceOptions] -> ShowS #
NFData DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods rnf :: DescribeOrderableDBInstanceOptions -> () #
Eq DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods (==) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool # (/=) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool #
Hashable DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods hashWithSalt :: Int -> DescribeOrderableDBInstanceOptions -> Int # hash :: DescribeOrderableDBInstanceOptions -> Int #
type AWSResponse DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions type AWSResponse DescribeOrderableDBInstanceOptions = DescribeOrderableDBInstanceOptionsResponse
type Rep DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions type Rep DescribeOrderableDBInstanceOptions = D1 ('MetaData "DescribeOrderableDBInstanceOptions" "Amazonka.RDS.DescribeOrderableDBInstanceOptions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "availabilityZoneGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :: ((S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribeOrderableDBInstanceOptions Source #

Arguments

:: Text	`DescribeOrderableDBInstanceOptions`
-> DescribeOrderableDBInstanceOptions

Create a value of DescribeOrderableDBInstanceOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_availabilityZoneGroup - The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_dbInstanceClass - The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_engineVersion - The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

$sel:filters:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_filters - This parameter isn't currently supported.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_licenseModel - The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

RDS Custom supports only the BYOL licensing model.

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

$sel:maxRecords:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_maxRecords - 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 10000.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_vpc - A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_engine - The name of the engine to retrieve DB instance options for.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

Request Lenses

describeOrderableDBInstanceOptions_availabilityZoneGroup :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

describeOrderableDBInstanceOptions_dbInstanceClass :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

describeOrderableDBInstanceOptions_engineVersion :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

describeOrderableDBInstanceOptions_filters :: Lens' DescribeOrderableDBInstanceOptions (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeOrderableDBInstanceOptions_licenseModel :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

RDS Custom supports only the BYOL licensing model.

describeOrderableDBInstanceOptions_marker :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

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

describeOrderableDBInstanceOptions_maxRecords :: Lens' DescribeOrderableDBInstanceOptions (Maybe Int) Source #

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 10000.

describeOrderableDBInstanceOptions_vpc :: Lens' DescribeOrderableDBInstanceOptions (Maybe Bool) Source #

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

describeOrderableDBInstanceOptions_engine :: Lens' DescribeOrderableDBInstanceOptions Text Source #

The name of the engine to retrieve DB instance options for.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

Destructuring the Response

data DescribeOrderableDBInstanceOptionsResponse Source #

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

See: newDescribeOrderableDBInstanceOptionsResponse smart constructor.

Constructors

DescribeOrderableDBInstanceOptionsResponse'

Fields

marker :: Maybe Text
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
orderableDBInstanceOptions :: Maybe [OrderableDBInstanceOption]
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Associated Types type Rep DescribeOrderableDBInstanceOptionsResponse :: Type -> Type # Methods from :: DescribeOrderableDBInstanceOptionsResponse -> Rep DescribeOrderableDBInstanceOptionsResponse x # to :: Rep DescribeOrderableDBInstanceOptionsResponse x -> DescribeOrderableDBInstanceOptionsResponse #
Read DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods readsPrec :: Int -> ReadS DescribeOrderableDBInstanceOptionsResponse # readList :: ReadS [DescribeOrderableDBInstanceOptionsResponse] # readPrec :: ReadPrec DescribeOrderableDBInstanceOptionsResponse # readListPrec :: ReadPrec [DescribeOrderableDBInstanceOptionsResponse] #
Show DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods showsPrec :: Int -> DescribeOrderableDBInstanceOptionsResponse -> ShowS # show :: DescribeOrderableDBInstanceOptionsResponse -> String # showList :: [DescribeOrderableDBInstanceOptionsResponse] -> ShowS #
NFData DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods rnf :: DescribeOrderableDBInstanceOptionsResponse -> () #
Eq DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods (==) :: DescribeOrderableDBInstanceOptionsResponse -> DescribeOrderableDBInstanceOptionsResponse -> Bool # (/=) :: DescribeOrderableDBInstanceOptionsResponse -> DescribeOrderableDBInstanceOptionsResponse -> Bool #
type Rep DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions type Rep DescribeOrderableDBInstanceOptionsResponse = D1 ('MetaData "DescribeOrderableDBInstanceOptionsResponse" "Amazonka.RDS.DescribeOrderableDBInstanceOptions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "orderableDBInstanceOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrderableDBInstanceOption])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOrderableDBInstanceOptionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeOrderableDBInstanceOptionsResponse'`
-> DescribeOrderableDBInstanceOptionsResponse

Create a value of DescribeOrderableDBInstanceOptionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:orderableDBInstanceOptions:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions - An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

$sel:httpStatus:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeOrderableDBInstanceOptionsResponse_marker :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe Text) Source #

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

describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe [OrderableDBInstanceOption]) Source #

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

describeOrderableDBInstanceOptionsResponse_httpStatus :: Lens' DescribeOrderableDBInstanceOptionsResponse Int Source #

The response's http status code.