GetEngineVersionArgs class
Arguments for getEngineVersion. Arguments for getEngineVersion.
Constructors
-
GetEngineVersionArgs({Input<
bool?> ? defaultOnly, required Input<String> engine, Input<List< ? filters, Input<GetEngineVersionFilter> ?>bool?> ? hasMajorTarget, Input<bool?> ? hasMinorTarget, Input<bool?> ? includeAll, Input<bool?> ? latest, Input<String?> ? parameterGroupFamily, Input<List< ? preferredMajorTargets, Input<String> ?>List< ? preferredUpgradeTargets, Input<String> ?>List< ? preferredVersions, Input<String> ?>String?> ? region, Input<String?> ? version}) -
Creates a new GetEngineVersionArgs.
defaultOnlyWhether the engine version must be an AWS-defined default version. Some engines have multiple default versions, such as for each major version. UsingdefaultOnlymay help avoidmultiple RDS engine versionserrors. See alsolatest.engineDatabase 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.filtersOne or more name/value pairs to use in filtering versions. There are several valid keys; for a full reference, check out describe-db-engine-versions in the AWS CLI reference.hasMajorTargetWhether the engine version must have one or more major upgrade targets. Not includinghasMajorTargetor setting it tofalsedoesn't imply that there's no corresponding major upgrade target for the engine version.hasMinorTargetWhether the engine version must have one or more minor upgrade targets. Not includinghasMinorTargetor setting it tofalsedoesn't imply that there's no corresponding minor upgrade target for the engine version.includeAllWhether the engine versionstatuscan either bedeprecatedoravailable. When not set or set tofalse, the engine versionstatuswill always beavailable.latestWhether the engine version is the most recent version matching the other criteria. This is different fromdefaultOnlyin important ways: "default" relies on AWS-defined defaults, the latest version isn't always the default, and AWS might have multiple default versions for an engine. As a result,defaultOnlymight not prevent errors frommultiple RDS engine versions, whilelatestwill. (latestcan be used withdefaultOnly.) Note: The data source uses a best-effort approach at selecting the latest version. Due to the complexity of version identifiers across engines and incomplete version date information provided by AWS, usinglatestmay not always result in the engine version being the actual latest version.parameterGroupFamilyName of a specific database parameter group family. Examples of parameter group families aremysql8.0,mariadb10.4, andpostgres12.preferredMajorTargetsOrdered list of preferred major version upgrade targets. The engine version will be the first match in the list unless thelatestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such aspreferredMajorTargets.preferredUpgradeTargetsOrdered list of preferred version upgrade targets. The engine version will be the first match in this list unless thelatestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such aspreferredUpgradeTargets.preferredVersionsOrdered list of preferred versions. The engine version will be the first match in this list unless thelatestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such aspreferredVersions.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.versionEngine version. For example,5.7.22,10.1.34, or12.3.versioncan be a partial version identifier which can result inmultiple RDS engine versionserrors unless thelatestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such asversion. NOTE: In a future Terraform AWS provider version,versionwill only contain the version information you configure and not the complete version information that the data source gets from AWS. Instead, that version information will be available in theversionActualattribute.const -
GetEngineVersionArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
defaultOnly
→ Input<
bool?> ? -
Whether the engine version must be an AWS-defined default version. Some engines have multiple default versions, such as for each major version. Using
defaultOnlymay help avoidmultiple RDS engine versionserrors. See alsolatest.final -
engine
→ Input<
String> -
Database 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 -
filters
→ Input<
List< ?GetEngineVersionFilter> ?> -
One or more name/value pairs to use in filtering versions. There are several valid keys; for a full reference, check out describe-db-engine-versions in the AWS CLI reference.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hasMajorTarget
→ Input<
bool?> ? -
Whether the engine version must have one or more major upgrade targets. Not including
hasMajorTargetor setting it tofalsedoesn't imply that there's no corresponding major upgrade target for the engine version.final -
hasMinorTarget
→ Input<
bool?> ? -
Whether the engine version must have one or more minor upgrade targets. Not including
hasMinorTargetor setting it tofalsedoesn't imply that there's no corresponding minor upgrade target for the engine version.final -
includeAll
→ Input<
bool?> ? -
Whether the engine version
statuscan either bedeprecatedoravailable. When not set or set tofalse, the engine versionstatuswill always beavailable.final -
latest
→ Input<
bool?> ? -
Whether the engine version is the most recent version matching the other criteria. This is different from
defaultOnlyin important ways: "default" relies on AWS-defined defaults, the latest version isn't always the default, and AWS might have multiple default versions for an engine. As a result,defaultOnlymight not prevent errors frommultiple RDS engine versions, whilelatestwill. (latestcan be used withdefaultOnly.) Note: The data source uses a best-effort approach at selecting the latest version. Due to the complexity of version identifiers across engines and incomplete version date information provided by AWS, usinglatestmay not always result in the engine version being the actual latest version.final -
parameterGroupFamily
→ Input<
String?> ? -
Name of a specific database parameter group family. Examples of parameter group families are
mysql8.0,mariadb10.4, andpostgres12.final -
preferredMajorTargets
→ Input<
List< ?String> ?> -
Ordered list of preferred major version upgrade targets. The engine version will be the first match in the list unless the
latestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such aspreferredMajorTargets.final -
preferredUpgradeTargets
→ Input<
List< ?String> ?> -
Ordered list of preferred version upgrade targets. The engine version will be the first match in this list unless the
latestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such aspreferredUpgradeTargets.final -
preferredVersions
→ Input<
List< ?String> ?> -
Ordered list of preferred versions. The engine version will be the first match in this list unless the
latestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such aspreferredVersions.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
-
version
→ Input<
String?> ? -
Engine version. For example,
5.7.22,10.1.34, or12.3.versioncan be a partial version identifier which can result inmultiple RDS engine versionserrors unless thelatestparameter is set totrue. The engine version will be the default version if you don't include any criteria, such asversion. NOTE: In a future Terraform AWS provider version,versionwill only contain the version information you configure and not the complete version information that the data source gets from AWS. Instead, that version information will be available in theversionActualattribute.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