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< ? preferredEngineVersions, Input<String> ?>List< ? preferredInstanceClasses, Input<String> ?>bool?> ? readReplicaCapable, Input<String?> ? region, Input<String?> ? storageType, Input<List< ? supportedEngineModes, Input<String> ?>List< ? supportedNetworkTypes, Input<String> ?>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.
availabilityZoneGroupAvailability zone group.engineDB engine. Engine values includeaurora,aurora-mysql,aurora-postgresql,docdb,mariadb,mysql,neptune,oracle-ee,oracle-se,oracle-se1,oracle-se2,postgres,sqlserver-ee,sqlserver-ex,sqlserver-se, andsqlserver-web.engineLatestVersionWhen set totrue, the data source attempts to return the most recent version matching the other criteria you provide. You must useengineLatestVersionwithpreferredInstanceClassesand/orpreferredEngineVersions. UsingengineLatestVersionwill avoidmultiple RDS DB Instance Classeserrors. If you useengineLatestVersionwithpreferredInstanceClasses, 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, usingengineLatestVersionmay not return the latest version in every situation.engineVersionVersion of the DB engine. If none is provided, the data source tries to use the AWS-defined default version that matches any other criteria.instanceClassDB instance class. Examples of classes aredb.m3.2xlarge,db.t2.small, anddb.m3.medium.licenseModelLicense model. Examples of license models aregeneral-public-license,bring-your-own-license, andamazon-license.preferredEngineVersionsOrdered list of preferred RDS DB instance engine versions. WhenengineLatestVersionis 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 withoutengineLatestVersion, it returns an error. CAUTION: We don't recommend usingpreferredEngineVersionswithoutpreferredInstanceClassessince the data source returns an arbitraryinstanceClassbased on the first one AWS returns that matches the engine version and any other criteria.preferredInstanceClassesOrdered 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 withoutengineLatestVersion, it returns an error. If you usepreferredInstanceClasseswithoutpreferredEngineVersionsorengineLatestVersion, the data source returns an arbitraryengineVersionbased on the first one AWS returns matching the instance class and any other criteria.readReplicaCapableWhether a DB instance can have a read replica.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.storageTypeStorage types. Examples of storage types arestandard,io1,gp2, andaurora.supportedEngineModesUse to limit results to engine modes such asprovisioned.supportedNetworkTypesUse to limit results to network typesIPV4orDUAL.supportsClustersWhether to limit results to instances that support clusters.supportsEnhancedMonitoringEnable this to ensure a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.supportsGlobalDatabasesEnable this to ensure a DB instance supports Aurora global databases with a specific combination of other DB engine attributes.supportsIamDatabaseAuthenticationEnable this to ensure a DB instance supports IAM database authentication.supportsIopsEnable this to ensure a DB instance supports provisioned IOPS.supportsKerberosAuthenticationEnable this to ensure a DB instance supports Kerberos Authentication.supportsMultiAzWhether to limit results to instances that are multi-AZ capable.supportsPerformanceInsightsEnable this to ensure a DB instance supports Performance Insights.supportsStorageAutoscalingEnable this to ensure Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.supportsStorageEncryptionEnable this to ensure a DB instance supports encrypted storage.vpcBoolean 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, andsqlserver-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 useengineLatestVersionwithpreferredInstanceClassesand/orpreferredEngineVersions. UsingengineLatestVersionwill avoidmultiple RDS DB Instance Classeserrors. If you useengineLatestVersionwithpreferredInstanceClasses, 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, usingengineLatestVersionmay 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, anddb.m3.medium.final -
licenseModel
→ Input<
String?> ? -
License model. Examples of license models are
general-public-license,bring-your-own-license, andamazon-license.final -
preferredEngineVersions
→ Input<
List< ?String> ?> -
Ordered list of preferred RDS DB instance engine versions. When
engineLatestVersionis 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 withoutengineLatestVersion, it returns an error. CAUTION: We don't recommend usingpreferredEngineVersionswithoutpreferredInstanceClassessince the data source returns an arbitraryinstanceClassbased 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 usepreferredInstanceClasseswithoutpreferredEngineVersionsorengineLatestVersion, the data source returns an arbitraryengineVersionbased 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, andaurora.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
IPV4orDUAL.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