Class: MintPress::Aws::RDS::OptionGroupOption

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

Properties (Read/Write)

  • #default_port ⇒ [Integer]
    'If the option requires a port, specifies the default port for the option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'default_port'
    

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

property :default_port, disposition: :attribute, description: 'If the option requires a port, specifies the default port for the option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'default_port', type: [Integer]
  • #description ⇒ [String]
    'The description of the option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'description'
    

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

property :description, disposition: :attribute, description: 'The description of the option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'description', type: [String]
  • #engine_name ⇒ [String]
    'A required parameter. Options available for the given engine name are described.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_option_group_options"
    • orig_name ⇒ 'engine_name'
    • describe_option_group_options_prop ⇒ 'engine_name'
    

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

property :engine_name, disposition: :attribute, description: 'A required parameter. Options available for the given engine name are
described.', source: "describe_option_group_options", orig_name: 'engine_name', type: [String], describe_option_group_options_prop: 'engine_name'
  • #major_engine_version ⇒ [String]
    'If specified, filters the results to include only options for the specified major engine version.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_option_group_options"
    • orig_name ⇒ 'major_engine_version'
    • describe_option_group_options_prop ⇒ 'major_engine_version'
    

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

property :major_engine_version, disposition: :attribute, description: 'If specified, filters the results to include only options for the
specified major engine version.', source: "describe_option_group_options", orig_name: 'major_engine_version', type: [String], describe_option_group_options_prop: 'major_engine_version'
  • #minimum_required_minor_engine_version ⇒ [String]
    'The minimum required engine version for the option to be applied.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'minimum_required_minor_engine_version'
    

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

property :minimum_required_minor_engine_version, disposition: :attribute, description: 'The minimum required engine version for the option to be applied.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'minimum_required_minor_engine_version', type: [String]
  • #name ⇒ [String]
    'The name of the option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'name'
    

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

property :name, disposition: :attribute, description: 'The name of the option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'name', type: [String]
  • #option_group_option_settings ⇒ Hash of ⇒ [MintPress::Aws::RDS::OptionGroupOptionSetting]
    'The option settings that are available (and the default value) for each option in an option group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'option_group_option_settings'
    

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

property :option_group_option_settings, disposition: :attribute, description: 'The option settings that are available (and the default value) for each option in an option group.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'option_group_option_settings', type: [MintPress::Aws::RDS::OptionGroupOptionSetting], array: false, hash: true
  • #option_group_option_versions ⇒ Array of ⇒ [MintPress::Aws::RDS::OptionVersion]
    'The versions that are available for the option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'option_group_option_versions'
    

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

property :option_group_option_versions, disposition: :attribute, description: 'The versions that are available for the option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'option_group_option_versions', type: [MintPress::Aws::RDS::OptionVersion], array: true
  • #options_conflicts_with ⇒ Array of ⇒ [String]
    'The options that conflict with this option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'options_conflicts_with'
    

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

property :options_conflicts_with, disposition: :attribute, description: 'The options that conflict with this option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'options_conflicts_with', type: [String], array: true
  • #options_depended_on ⇒ Array of ⇒ [String]
    'The options that are prerequisites for this option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'options_depended_on'
    

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

property :options_depended_on, disposition: :attribute, description: 'The options that are prerequisites for this option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'options_depended_on', type: [String], array: true
  • #permanent ⇒ [TrueClass,FalseClass]
    'Permanent options can never be removed from an option group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'permanent'
    

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

property :permanent, disposition: :attribute, description: 'Permanent options can never be removed from an option group.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'permanent', type: [TrueClass,FalseClass]
  • #persistent ⇒ [TrueClass,FalseClass]
    'Persistent options can"t be removed from an option group while DB instances are associated with the option group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'persistent'
    

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

property :persistent, disposition: :attribute, description: 'Persistent options can"t be removed from an option group while DB instances are associated with the option group.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'persistent', type: [TrueClass,FalseClass]
  • #port_required ⇒ [TrueClass,FalseClass]
    'Specifies whether the option requires a port.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'port_required'
    

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

property :port_required, disposition: :attribute, description: 'Specifies whether the option requires a port.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'port_required', type: [TrueClass,FalseClass]
  • #requires_auto_minor_engine_version_upgrade ⇒ [TrueClass,FalseClass]
    'If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'requires_auto_minor_engine_version_upgrade'
    

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

property :requires_auto_minor_engine_version_upgrade, disposition: :attribute, description: 'If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'requires_auto_minor_engine_version_upgrade', type: [TrueClass,FalseClass]
  • #supports_option_version_downgrade ⇒ [TrueClass,FalseClass]
    'If true, you can change the option to an earlier version of the option.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'supports_option_version_downgrade'
    

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

property :supports_option_version_downgrade, disposition: :attribute, description: 'If true, you can change the option to an earlier version of the option.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'supports_option_version_downgrade', type: [TrueClass,FalseClass]
  • #vpc_only ⇒ [TrueClass,FalseClass]
    'If true, you can only use this option with a DB instance that is in a VPC.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::RDS::OptionGroupOption"
    • orig_name ⇒ 'vpc_only'
    

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

property :vpc_only, disposition: :attribute, description: 'If true, you can only use this option with a DB instance that is in a VPC.', source: "MintPress::Aws::RDS::OptionGroupOption", orig_name: 'vpc_only', type: [TrueClass,FalseClass]
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter isn"t currently supported.'
    Property Attributes
    • describe_option_group_options_prop ⇒ 'filters'
    • source ⇒ "describe_option_group_options"
    

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

property :filters, describe_option_group_options_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_option_group_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_option_group_options_prop ⇒ 'max_records'
    • source ⇒ "describe_option_group_options"
    

39
40
41
42
43
44
45
46
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/option_group_option.rb', line 39

property :max_records, describe_option_group_options_prop: 'max_records', type: [Integer], source: "describe_option_group_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 
    

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

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
    

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

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

Returns a new instance of OptionGroupOption.

Instance Method Details

#describe ⇒ Object