GetOrderableDbInstanceArgs class

Arguments for getOrderableDbInstance. Arguments for getOrderableDbInstance.

Constructors

GetOrderableDbInstanceArgs({Input<String?>? availabilityZoneGroup, required Input<String> engine, Input<bool?>? engineLatestVersion, Input<String?>? engineVersion, Input<String?>? instanceClass, Input<String?>? licenseModel, Input<List<String>?>? preferredEngineVersions, Input<List<String>?>? preferredInstanceClasses, Input<bool?>? readReplicaCapable, Input<String?>? region, Input<String?>? storageType, Input<List<String>?>? supportedEngineModes, Input<List<String>?>? supportedNetworkTypes, Input<bool?>? supportsClusters, Input<bool?>? supportsEnhancedMonitoring, Input<bool?>? supportsGlobalDatabases, Input<bool?>? supportsIamDatabaseAuthentication, Input<bool?>? supportsIops, Input<bool?>? supportsKerberosAuthentication, Input<bool?>? supportsMultiAz, Input<bool?>? supportsPerformanceInsights, Input<bool?>? supportsStorageAutoscaling, Input<bool?>? supportsStorageEncryption, Input<bool?>? vpc})
Creates a new GetOrderableDbInstanceArgs. availabilityZoneGroup Availability zone group. engine DB engine. Engine values include aurora, aurora-mysql, aurora-postgresql, docdb, mariadb, mysql, neptune, oracle-ee, oracle-se, oracle-se1, oracle-se2, postgres, sqlserver-ee, sqlserver-ex, sqlserver-se, and sqlserver-web. engineLatestVersion When set to true, the data source attempts to return the most recent version matching the other criteria you provide. You must use engineLatestVersion with preferredInstanceClasses and/or preferredEngineVersions. Using engineLatestVersion will avoid multiple RDS DB Instance Classes errors. If you use engineLatestVersion with preferredInstanceClasses, the data source returns the latest version for the first matching instance class (instance class priority). Note: The data source uses a best-effort approach at selecting the latest version but due to the complexity of version identifiers across engines, using engineLatestVersion may not return the latest version in every situation. engineVersion Version of the DB engine. If none is provided, the data source tries to use the AWS-defined default version that matches any other criteria. instanceClass DB instance class. Examples of classes are db.m3.2xlarge, db.t2.small, and db.m3.medium. licenseModel License model. Examples of license models are general-public-license, bring-your-own-license, and amazon-license. preferredEngineVersions Ordered list of preferred RDS DB instance engine versions. When engineLatestVersion is not set, the data source will return the first match in this list that matches any other criteria. If the data source finds no preferred matches or multiple matches without engineLatestVersion, it returns an error. CAUTION: We don't recommend using preferredEngineVersions without preferredInstanceClasses since the data source returns an arbitrary instanceClass based on the first one AWS returns that matches the engine version and any other criteria. preferredInstanceClasses Ordered list of preferred RDS DB instance classes. The data source will return the first match in this list that matches any other criteria. If the data source finds no preferred matches or multiple matches without engineLatestVersion, it returns an error. If you use preferredInstanceClasses without preferredEngineVersions or engineLatestVersion, the data source returns an arbitrary engineVersion based on the first one AWS returns matching the instance class and any other criteria. readReplicaCapable Whether a DB instance can have a read replica. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. storageType Storage types. Examples of storage types are standard, io1, gp2, and aurora. supportedEngineModes Use to limit results to engine modes such as provisioned. supportedNetworkTypes Use to limit results to network types IPV4 or DUAL. supportsClusters Whether to limit results to instances that support clusters. supportsEnhancedMonitoring Enable this to ensure a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds. supportsGlobalDatabases Enable this to ensure a DB instance supports Aurora global databases with a specific combination of other DB engine attributes. supportsIamDatabaseAuthentication Enable this to ensure a DB instance supports IAM database authentication. supportsIops Enable this to ensure a DB instance supports provisioned IOPS. supportsKerberosAuthentication Enable this to ensure a DB instance supports Kerberos Authentication. supportsMultiAz Whether to limit results to instances that are multi-AZ capable. supportsPerformanceInsights Enable this to ensure a DB instance supports Performance Insights. supportsStorageAutoscaling Enable this to ensure Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class. supportsStorageEncryption Enable this to ensure a DB instance supports encrypted storage. vpc Boolean that indicates whether to show only VPC or non-VPC offerings.
const
GetOrderableDbInstanceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

availabilityZoneGroup → Input<String?>?
Availability zone group.
final
engine → Input<String>
DB engine. Engine values include aurora, aurora-mysql, aurora-postgresql, docdb, mariadb, mysql, neptune, oracle-ee, oracle-se, oracle-se1, oracle-se2, postgres, sqlserver-ee, sqlserver-ex, sqlserver-se, and sqlserver-web.
final
engineLatestVersion → Input<bool?>?
When set to true, the data source attempts to return the most recent version matching the other criteria you provide. You must use engineLatestVersion with preferredInstanceClasses and/or preferredEngineVersions. Using engineLatestVersion will avoid multiple RDS DB Instance Classes errors. If you use engineLatestVersion with preferredInstanceClasses, the data source returns the latest version for the first matching instance class (instance class priority). Note: The data source uses a best-effort approach at selecting the latest version but due to the complexity of version identifiers across engines, using engineLatestVersion may not return the latest version in every situation.
final
engineVersion → Input<String?>?
Version of the DB engine. If none is provided, the data source tries to use the AWS-defined default version that matches any other criteria.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceClass → Input<String?>?
DB instance class. Examples of classes are db.m3.2xlarge, db.t2.small, and db.m3.medium.
final
licenseModel → Input<String?>?
License model. Examples of license models are general-public-license, bring-your-own-license, and amazon-license.
final
preferredEngineVersions → Input<List<String>?>?
Ordered list of preferred RDS DB instance engine versions. When engineLatestVersion is not set, the data source will return the first match in this list that matches any other criteria. If the data source finds no preferred matches or multiple matches without engineLatestVersion, it returns an error. CAUTION: We don't recommend using preferredEngineVersions without preferredInstanceClasses since the data source returns an arbitrary instanceClass based on the first one AWS returns that matches the engine version and any other criteria.
final
preferredInstanceClasses → Input<List<String>?>?
Ordered list of preferred RDS DB instance classes. The data source will return the first match in this list that matches any other criteria. If the data source finds no preferred matches or multiple matches without engineLatestVersion, it returns an error. If you use preferredInstanceClasses without preferredEngineVersions or engineLatestVersion, the data source returns an arbitrary engineVersion based on the first one AWS returns matching the instance class and any other criteria.
final
readReplicaCapable → Input<bool?>?
Whether a DB instance can have a read replica.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storageType → Input<String?>?
Storage types. Examples of storage types are standard, io1, gp2, and aurora.
final
supportedEngineModes → Input<List<String>?>?
Use to limit results to engine modes such as provisioned.
final
supportedNetworkTypes → Input<List<String>?>?
Use to limit results to network types IPV4 or DUAL.
final
supportsClusters → Input<bool?>?
Whether to limit results to instances that support clusters.
final
supportsEnhancedMonitoring → Input<bool?>?
Enable this to ensure a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
final
supportsGlobalDatabases → Input<bool?>?
Enable this to ensure a DB instance supports Aurora global databases with a specific combination of other DB engine attributes.
final
supportsIamDatabaseAuthentication → Input<bool?>?
Enable this to ensure a DB instance supports IAM database authentication.
final
supportsIops → Input<bool?>?
Enable this to ensure a DB instance supports provisioned IOPS.
final
supportsKerberosAuthentication → Input<bool?>?
Enable this to ensure a DB instance supports Kerberos Authentication.
final
supportsMultiAz → Input<bool?>?
Whether to limit results to instances that are multi-AZ capable.
final
supportsPerformanceInsights → Input<bool?>?
Enable this to ensure a DB instance supports Performance Insights.
final
supportsStorageAutoscaling → Input<bool?>?
Enable this to ensure Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
final
supportsStorageEncryption → Input<bool?>?
Enable this to ensure a DB instance supports encrypted storage.
final
vpc → Input<bool?>?
Boolean that indicates whether to show only VPC or non-VPC offerings.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited