aws_sdk_rds/client/
describe_orderable_db_instance_options.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeOrderableDBInstanceOptions`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`engine(impl Into<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_engine):<br>required: **true**<br><p>The name of the database engine to describe DB instance options for.</p> <p>Valid Values:</p> <ul>  <li>   <p><code>aurora-mysql</code></p></li>  <li>   <p><code>aurora-postgresql</code></p></li>  <li>   <p><code>custom-oracle-ee</code></p></li>  <li>   <p><code>custom-oracle-ee-cdb</code></p></li>  <li>   <p><code>custom-oracle-se2</code></p></li>  <li>   <p><code>custom-oracle-se2-cdb</code></p></li>  <li>   <p><code>db2-ae</code></p></li>  <li>   <p><code>db2-se</code></p></li>  <li>   <p><code>mariadb</code></p></li>  <li>   <p><code>mysql</code></p></li>  <li>   <p><code>oracle-ee</code></p></li>  <li>   <p><code>oracle-ee-cdb</code></p></li>  <li>   <p><code>oracle-se2</code></p></li>  <li>   <p><code>oracle-se2-cdb</code></p></li>  <li>   <p><code>postgres</code></p></li>  <li>   <p><code>sqlserver-ee</code></p></li>  <li>   <p><code>sqlserver-se</code></p></li>  <li>   <p><code>sqlserver-ex</code></p></li>  <li>   <p><code>sqlserver-web</code></p></li> </ul><br>
    ///   - [`engine_version(impl Into<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_engine_version):<br>required: **false**<br><p>A filter to include only the available options for the specified engine version.</p><br>
    ///   - [`db_instance_class(impl Into<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::db_instance_class) / [`set_db_instance_class(Option<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_db_instance_class):<br>required: **false**<br><p>A filter to include only the available options for the specified DB instance class.</p><br>
    ///   - [`license_model(impl Into<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::license_model) / [`set_license_model(Option<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_license_model):<br>required: **false**<br><p>A filter to include only the available options for the specified license model.</p> <p>RDS Custom supports only the BYOL licensing model.</p><br>
    ///   - [`availability_zone_group(impl Into<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::availability_zone_group) / [`set_availability_zone_group(Option<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_availability_zone_group):<br>required: **false**<br><p>The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.</p> <p>Omit this parameter to show the available options in the specified Amazon Web Services Region.</p> <p>This setting doesn't apply to RDS Custom DB instances.</p><br>
    ///   - [`vpc(bool)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::vpc) / [`set_vpc(Option<bool>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_vpc):<br>required: **false**<br><p>Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.</p> <p>RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.</p><br>
    ///   - [`filters(Filter)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_filters):<br>required: **false**<br><p>This parameter isn't currently supported.</p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 1000.</p><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::set_marker):<br>required: **false**<br><p>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 <code>MaxRecords</code>.</p><br>
    /// - On success, responds with [`DescribeOrderableDbInstanceOptionsOutput`](crate::operation::describe_orderable_db_instance_options::DescribeOrderableDbInstanceOptionsOutput) with field(s):
    ///   - [`orderable_db_instance_options(Option<Vec::<OrderableDbInstanceOption>>)`](crate::operation::describe_orderable_db_instance_options::DescribeOrderableDbInstanceOptionsOutput::orderable_db_instance_options): <p>An <code>OrderableDBInstanceOption</code> structure containing information about orderable options for the DB instance.</p>
    ///   - [`marker(Option<String>)`](crate::operation::describe_orderable_db_instance_options::DescribeOrderableDbInstanceOptionsOutput::marker): <p>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 <code>MaxRecords</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeOrderableDBInstanceOptionsError>`](crate::operation::describe_orderable_db_instance_options::DescribeOrderableDBInstanceOptionsError)
    pub fn describe_orderable_db_instance_options(
        &self,
    ) -> crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder {
        crate::operation::describe_orderable_db_instance_options::builders::DescribeOrderableDBInstanceOptionsFluentBuilder::new(self.handle.clone())
    }
}