Class: MintPress::Aws::RDS::OrderableDbInstanceOption

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

Properties (Read/Write)

  • #engine ⇒ [String]
    'The name of the engine to retrieve DB instance options for.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'engine'
    • source ⇒ "describe_orderable_db_instance_options"
    

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

property :engine, describe_orderable_db_instance_options_prop: 'engine', type: [String], source: "describe_orderable_db_instance_options", description: 'The name of the engine to retrieve DB instance options for.'
  • #engine_version ⇒ [String]
    'The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'engine_version'
    • source ⇒ "describe_orderable_db_instance_options"
    

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

property :engine_version, describe_orderable_db_instance_options_prop: 'engine_version', type: [String], source: "describe_orderable_db_instance_options", description: 'The engine version filter value. Specify this parameter to show only
the available offerings matching the specified engine version.'
  • #db_instance_class ⇒ [String]
    'The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'db_instance_class'
    • source ⇒ "describe_orderable_db_instance_options"
    

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

property :db_instance_class, describe_orderable_db_instance_options_prop: 'db_instance_class', type: [String], source: "describe_orderable_db_instance_options", description: 'The DB instance class filter value. Specify this parameter to show
only the available offerings matching the specified DB instance class.'
  • #license_model ⇒ [String]
    'The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'license_model'
    • source ⇒ "describe_orderable_db_instance_options"
    

23
24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/orderable_db_instance_option.rb', line 23

property :license_model, describe_orderable_db_instance_options_prop: 'license_model', type: [String], source: "describe_orderable_db_instance_options", description: 'The license model filter value. Specify this parameter to show only
the available offerings matching the specified license model.'
  • #availability_zone_group ⇒ [String]
    'The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group. Omit this parameter to show the available offerings in the specified AWS Region.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'availability_zone_group'
    • source ⇒ "describe_orderable_db_instance_options"
    

25
26
27
28
29
30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/orderable_db_instance_option.rb', line 25

property :availability_zone_group, describe_orderable_db_instance_options_prop: 'availability_zone_group', type: [String], source: "describe_orderable_db_instance_options", description: 'The Availability Zone group associated with a Local Zone. Specify this
parameter to retrieve available offerings for the Local Zones in the
group.

Omit this parameter to show the available offerings in the specified
AWS Region.'
  • #vpc ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to show only VPC or non-VPC offerings.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'vpc'
    • source ⇒ "describe_orderable_db_instance_options"
    

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

property :vpc, describe_orderable_db_instance_options_prop: 'vpc', type: [TrueClass,FalseClass], source: "describe_orderable_db_instance_options", description: 'A value that indicates whether to show only VPC or non-VPC offerings.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter isn"t currently supported.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'filters'
    • source ⇒ "describe_orderable_db_instance_options"
    

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

property :filters, describe_orderable_db_instance_options_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_orderable_db_instance_options", description: 'This parameter isn"t currently supported.', hash: true
  • #max_records ⇒ [Integer]
    'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_orderable_db_instance_options_prop ⇒ 'max_records'
    • source ⇒ "describe_orderable_db_instance_options"
    

33
34
35
36
37
38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/orderable_db_instance_option.rb', line 33

property :max_records, describe_orderable_db_instance_options_prop: 'max_records', type: [Integer], source: "describe_orderable_db_instance_options", description: 'The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so that you can
retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #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 
    

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

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
    

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

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 = {}) ⇒ OrderableDbInstanceOption

Returns a new instance of OrderableDbInstanceOption.

Instance Method Details

#describe ⇒ Object