/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the rds-2014-10-31.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.RDS.Model
{
///
/// Container for the parameters to the DescribeDBEngineVersions operation.
/// Returns a list of the available DB engines.
///
public partial class DescribeDBEngineVersionsRequest : AmazonRDSRequest
{
private string _dbParameterGroupFamily;
private bool? _defaultOnly;
private string _engine;
private string _engineVersion;
private List _filters = new List();
private bool? _includeAll;
private bool? _listSupportedCharacterSets;
private bool? _listSupportedTimezones;
private string _marker;
private int? _maxRecords;
///
/// Empty constructor used to set properties independently even when a simple constructor is available
///
public DescribeDBEngineVersionsRequest() { }
///
/// Gets and sets the property DBParameterGroupFamily.
///
/// The name of a specific DB parameter group family to return details for.
///
///
///
/// Constraints:
///
/// -
///
/// If supplied, must match an existing DBParameterGroupFamily.
///
///
///
public string DBParameterGroupFamily
{
get { return this._dbParameterGroupFamily; }
set { this._dbParameterGroupFamily = value; }
}
// Check to see if DBParameterGroupFamily property is set
internal bool IsSetDBParameterGroupFamily()
{
return this._dbParameterGroupFamily != null;
}
///
/// Gets and sets the property DefaultOnly.
///
/// A value that indicates whether only the default version of the specified engine or
/// engine and major version combination is returned.
///
///
public bool DefaultOnly
{
get { return this._defaultOnly.GetValueOrDefault(); }
set { this._defaultOnly = value; }
}
// Check to see if DefaultOnly property is set
internal bool IsSetDefaultOnly()
{
return this._defaultOnly.HasValue;
}
///
/// Gets and sets the property Engine.
///
/// The database engine to return.
///
///
///
/// Valid Values:
///
/// -
///
///
aurora-mysql
///
/// -
///
///
aurora-postgresql
///
/// -
///
///
custom-oracle-ee
///
/// -
///
///
mariadb
///
/// -
///
///
mysql
///
/// -
///
///
oracle-ee
///
/// -
///
///
oracle-ee-cdb
///
/// -
///
///
oracle-se2
///
/// -
///
///
oracle-se2-cdb
///
/// -
///
///
postgres
///
/// -
///
///
sqlserver-ee
///
/// -
///
///
sqlserver-se
///
/// -
///
///
sqlserver-ex
///
/// -
///
///
sqlserver-web
///
///
///
public string Engine
{
get { return this._engine; }
set { this._engine = value; }
}
// Check to see if Engine property is set
internal bool IsSetEngine()
{
return this._engine != null;
}
///
/// Gets and sets the property EngineVersion.
///
/// The database engine version to return.
///
///
///
/// Example: 5.1.49
///
///
public string EngineVersion
{
get { return this._engineVersion; }
set { this._engineVersion = value; }
}
// Check to see if EngineVersion property is set
internal bool IsSetEngineVersion()
{
return this._engineVersion != null;
}
///
/// Gets and sets the property Filters.
///
/// A filter that specifies one or more DB engine versions to describe.
///
///
///
/// Supported filters:
///
/// -
///
///
db-parameter-group-family
- Accepts parameter groups family names. The
/// results list only includes information about the DB engine versions for these parameter
/// group families.
///
/// -
///
///
engine
- Accepts engine names. The results list only includes information
/// about the DB engine versions for these engines.
///
/// -
///
///
engine-mode
- Accepts DB engine modes. The results list only includes
/// information about the DB engine versions for these engine modes. Valid DB engine modes
/// are the following:
///
/// -
///
///
global
///
/// -
///
///
multimaster
///
/// -
///
///
parallelquery
///
/// -
///
///
provisioned
///
/// -
///
///
serverless
///
///
-
///
///
engine-version
- Accepts engine versions. The results list only includes
/// information about the DB engine versions for these engine versions.
///
/// -
///
///
status
- Accepts engine version statuses. The results list only includes
/// information about the DB engine versions for these statuses. Valid statuses are the
/// following:
///
/// -
///
///
available
///
/// -
///
///
deprecated
///
///
///
public List Filters
{
get { return this._filters; }
set { this._filters = value; }
}
// Check to see if Filters property is set
internal bool IsSetFilters()
{
return this._filters != null && this._filters.Count > 0;
}
///
/// Gets and sets the property IncludeAll.
///
/// A value that indicates whether to include engine versions that aren't available in
/// the list. The default is to list only available engine versions.
///
///
public bool IncludeAll
{
get { return this._includeAll.GetValueOrDefault(); }
set { this._includeAll = value; }
}
// Check to see if IncludeAll property is set
internal bool IsSetIncludeAll()
{
return this._includeAll.HasValue;
}
///
/// Gets and sets the property ListSupportedCharacterSets.
///
/// A value that indicates whether to list the supported character sets for each engine
/// version.
///
///
///
/// If this parameter is enabled and the requested engine supports the CharacterSetName
/// parameter for CreateDBInstance
, the response includes a list of supported
/// character sets for each engine version.
///
///
///
/// For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets
/// to true
, RDS Custom returns no results.
///
///
public bool ListSupportedCharacterSets
{
get { return this._listSupportedCharacterSets.GetValueOrDefault(); }
set { this._listSupportedCharacterSets = value; }
}
// Check to see if ListSupportedCharacterSets property is set
internal bool IsSetListSupportedCharacterSets()
{
return this._listSupportedCharacterSets.HasValue;
}
///
/// Gets and sets the property ListSupportedTimezones.
///
/// A value that indicates whether to list the supported time zones for each engine version.
///
///
///
/// If this parameter is enabled and the requested engine supports the TimeZone
/// parameter for CreateDBInstance
, the response includes a list of supported
/// time zones for each engine version.
///
///
///
/// For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones
/// to true
, RDS Custom returns no results.
///
///
public bool ListSupportedTimezones
{
get { return this._listSupportedTimezones.GetValueOrDefault(); }
set { this._listSupportedTimezones = value; }
}
// Check to see if ListSupportedTimezones property is set
internal bool IsSetListSupportedTimezones()
{
return this._listSupportedTimezones.HasValue;
}
///
/// Gets and sets the property Marker.
///
/// 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
.
///
///
public string Marker
{
get { return this._marker; }
set { this._marker = value; }
}
// Check to see if Marker property is set
internal bool IsSetMarker()
{
return this._marker != null;
}
///
/// Gets and sets the property MaxRecords.
///
/// 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 you can retrieve the remaining results.
///
///
///
/// Default: 100
///
///
///
/// Constraints: Minimum 20, maximum 100.
///
///
public int MaxRecords
{
get { return this._maxRecords.GetValueOrDefault(); }
set { this._maxRecords = value; }
}
// Check to see if MaxRecords property is set
internal bool IsSetMaxRecords()
{
return this._maxRecords.HasValue;
}
}
}