Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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 engine.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeOrderableDBInstanceOptions Source #

See: newDescribeOrderableDBInstanceOptions smart constructor.

Constructors

DescribeOrderableDBInstanceOptions'

Fields

engineVersion :: Maybe Text
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
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.
filters :: Maybe [Filter]
This parameter isn't currently supported.
dbInstanceClass :: Maybe Text
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
licenseModel :: Maybe Text
The license model filter value. Specify this parameter to show only the available offerings matching the specified license 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 100.
vpc :: Maybe Bool
A value that indicates whether to show only VPC or non-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 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

Eq DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods (==) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool # (/=) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool #
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 #
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 #
NFData DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods rnf :: DescribeOrderableDBInstanceOptions -> () #
Hashable DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods hashWithSalt :: Int -> DescribeOrderableDBInstanceOptions -> Int # hash :: DescribeOrderableDBInstanceOptions -> Int #
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 :: DescribeOrderableDBInstanceOptions -> Request DescribeOrderableDBInstanceOptions # response :: MonadResource m => Logger -> Service -> Proxy DescribeOrderableDBInstanceOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOrderableDBInstanceOptions))) #
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 #
type Rep DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions type Rep DescribeOrderableDBInstanceOptions = D1 ('MetaData "DescribeOrderableDBInstanceOptions" "Amazonka.RDS.DescribeOrderableDBInstanceOptions" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "availabilityZoneGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((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))))))
type AWSResponse DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions type AWSResponse DescribeOrderableDBInstanceOptions = DescribeOrderableDBInstanceOptionsResponse

newDescribeOrderableDBInstanceOptions Source #

Arguments

:: Text	`$sel:engine: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:

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

$sel:availabilityZoneGroup: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.

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

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

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

$sel:marker: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 100.

$sel:vpc:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_vpc - A value that indicates whether to show only VPC or non-VPC offerings.

$sel:engine: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 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_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_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.

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

This parameter isn't currently supported.

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_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.

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 100.

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

A value that indicates whether to show only VPC or non-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 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

orderableDBInstanceOptions :: Maybe [OrderableDBInstanceOption]
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
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 .
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods (==) :: DescribeOrderableDBInstanceOptionsResponse -> DescribeOrderableDBInstanceOptionsResponse -> Bool # (/=) :: DescribeOrderableDBInstanceOptionsResponse -> DescribeOrderableDBInstanceOptionsResponse -> Bool #
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 #
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 #
NFData DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions Methods rnf :: DescribeOrderableDBInstanceOptionsResponse -> () #
type Rep DescribeOrderableDBInstanceOptionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOrderableDBInstanceOptions type Rep DescribeOrderableDBInstanceOptionsResponse = D1 ('MetaData "DescribeOrderableDBInstanceOptionsResponse" "Amazonka.RDS.DescribeOrderableDBInstanceOptions" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "orderableDBInstanceOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrderableDBInstanceOption])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

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

$sel:marker: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:httpStatus:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_httpStatus - The response's http status code.

Response Lenses

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

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

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_httpStatus :: Lens' DescribeOrderableDBInstanceOptionsResponse Int Source #

The response's http status code.