GetEngineVersionArgs class

Arguments for getEngineVersion. Arguments for getEngineVersion.

Constructors

GetEngineVersionArgs({Input<bool?>? defaultOnly, required Input<String> engine, Input<List<GetEngineVersionFilter>?>? filters, Input<bool?>? hasMajorTarget, Input<bool?>? hasMinorTarget, Input<bool?>? includeAll, Input<bool?>? latest, Input<String?>? parameterGroupFamily, Input<List<String>?>? preferredMajorTargets, Input<List<String>?>? preferredUpgradeTargets, Input<List<String>?>? preferredVersions, Input<String?>? region, Input<String?>? version})
Creates a new GetEngineVersionArgs. defaultOnly Whether the engine version must be an AWS-defined default version. Some engines have multiple default versions, such as for each major version. Using defaultOnly may help avoid multiple RDS engine versions errors. See also latest. engine 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, and sqlserver-web. filters 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. hasMajorTarget Whether the engine version must have one or more major upgrade targets. Not including hasMajorTarget or setting it to false doesn't imply that there's no corresponding major upgrade target for the engine version. hasMinorTarget Whether the engine version must have one or more minor upgrade targets. Not including hasMinorTarget or setting it to false doesn't imply that there's no corresponding minor upgrade target for the engine version. includeAll Whether the engine version status can either be deprecated or available. When not set or set to false, the engine version status will always be available. latest Whether the engine version is the most recent version matching the other criteria. This is different from defaultOnly in 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, defaultOnly might not prevent errors from multiple RDS engine versions, while latest will. (latest can be used with defaultOnly.) 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, using latest may not always result in the engine version being the actual latest version. parameterGroupFamily Name of a specific database parameter group family. Examples of parameter group families are mysql8.0, mariadb10.4, and postgres12. preferredMajorTargets Ordered list of preferred major version upgrade targets. The engine version will be the first match in the list unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferredMajorTargets. preferredUpgradeTargets Ordered list of preferred version upgrade targets. The engine version will be the first match in this list unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferredUpgradeTargets. preferredVersions Ordered list of preferred versions. The engine version will be the first match in this list unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferredVersions. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. version Engine version. For example, 5.7.22, 10.1.34, or 12.3. version can be a partial version identifier which can result in multiple RDS engine versions errors unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as version. NOTE: In a future Terraform AWS provider version, version will 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 the versionActual attribute.
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 defaultOnly may help avoid multiple RDS engine versions errors. See also latest.
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, and sqlserver-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 hasMajorTarget or setting it to false doesn'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 hasMinorTarget or setting it to false doesn't imply that there's no corresponding minor upgrade target for the engine version.
final
includeAll → Input<bool?>?
Whether the engine version status can either be deprecated or available. When not set or set to false, the engine version status will always be available.
final
latest → Input<bool?>?
Whether the engine version is the most recent version matching the other criteria. This is different from defaultOnly in 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, defaultOnly might not prevent errors from multiple RDS engine versions, while latest will. (latest can be used with defaultOnly.) 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, using latest may 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, and postgres12.
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 latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferredMajorTargets.
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 latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferredUpgradeTargets.
final
preferredVersions → Input<List<String>?>?
Ordered list of preferred versions. The engine version will be the first match in this list unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as preferredVersions.
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, or 12.3. version can be a partial version identifier which can result in multiple RDS engine versions errors unless the latest parameter is set to true. The engine version will be the default version if you don't include any criteria, such as version. NOTE: In a future Terraform AWS provider version, version will 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 the versionActual attribute.
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