Class: MintPress::Aws::RDS::DbEngineVersion

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb

Properties (Read/Write)

  • #engine ⇒ [String]
    'The database engine to return.'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'engine'
    • source ⇒ "describe_db_engine_versions"
    

19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 19

property :engine, describe_db_engine_versions_prop: 'engine', type: [String], source: "describe_db_engine_versions", description: 'The database engine to return.'
  • #engine_version ⇒ [String]
    'The database engine version to return. Example: 5.1.49'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'engine_version'
    • source ⇒ "describe_db_engine_versions"
    

20
21
22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 20

property :engine_version, describe_db_engine_versions_prop: 'engine_version', type: [String], source: "describe_db_engine_versions", description: 'The database engine version to return.

Example: 5.1.49'
  • #db_parameter_group_family ⇒ [String]
    'The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DBParameterGroupFamily. ^'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'db_parameter_group_family'
    • source ⇒ "describe_db_engine_versions"
    

23
24
25
26
27
28
29
30
31
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 23

property :db_parameter_group_family, describe_db_engine_versions_prop: 'db_parameter_group_family', type: [String], source: "describe_db_engine_versions", description: 'The name of a specific DB parameter group family to return details
for.

Constraints:


If supplied, must match an existing DBParameterGroupFamily.



^'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter isn"t currently supported.'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'filters'
    • source ⇒ "describe_db_engine_versions"
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 34

property :filters, describe_db_engine_versions_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_engine_versions", description: 'This parameter isn"t currently supported.', hash: true
  • #max_records ⇒ [Integer]
    '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.'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'max_records'
    • source ⇒ "describe_db_engine_versions"
    

35
36
37
38
39
40
41
42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 35

property :max_records, describe_db_engine_versions_prop: 'max_records', type: [Integer], source: "describe_db_engine_versions", description: '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.'
  • #default_only ⇒ [TrueClass,FalseClass]
    'A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'default_only'
    • source ⇒ "describe_db_engine_versions"
    

43
44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 43

property :default_only, describe_db_engine_versions_prop: 'default_only', type: [TrueClass,FalseClass], source: "describe_db_engine_versions", description: 'A value that indicates whether only the default version of the
specified engine or engine and major version combination is returned.'
  • #list_supported_character_sets ⇒ [TrueClass,FalseClass]
    '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.'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'list_supported_character_sets'
    • source ⇒ "describe_db_engine_versions"
    

45
46
47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 45

property :list_supported_character_sets, describe_db_engine_versions_prop: 'list_supported_character_sets', type: [TrueClass,FalseClass], source: "describe_db_engine_versions", description: '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.'
  • #list_supported_timezones ⇒ [TrueClass,FalseClass]
    '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.'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'list_supported_timezones'
    • source ⇒ "describe_db_engine_versions"
    

51
52
53
54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 51

property :list_supported_timezones, describe_db_engine_versions_prop: 'list_supported_timezones', type: [TrueClass,FalseClass], source: "describe_db_engine_versions", description: '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.'
  • #include_all ⇒ [TrueClass,FalseClass]
    '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.'
    Property Attributes
    • describe_db_engine_versions_prop ⇒ 'include_all'
    • source ⇒ "describe_db_engine_versions"
    

57
58
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 57

property :include_all, describe_db_engine_versions_prop: 'include_all', type: [TrueClass,FalseClass], source: "describe_db_engine_versions", description: '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.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 63

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_engine_version.rb', line 66

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ DbEngineVersion

Returns a new instance of DbEngineVersion.

Instance Method Details

#describe ⇒ Object