Class: MintPress::Aws::RDS::OptionGroup

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

Properties (Read/Write)

  • #engine_name ⇒ [String]
    'Specifies the name of the engine that this option group should be associated with.'
    Property Attributes
    • source ⇒ "create_option_group"
    • orig_name ⇒ 'engine_name'
    • create_option_group_prop ⇒ 'engine_name'
    • read_only ⇒ false
    • describe_option_groups_prop ⇒ 'engine_name'
    

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

property :engine_name, description: 'Specifies the name of the engine that this option group should be
associated with.', source: "create_option_group", orig_name: 'engine_name', type: [String], create_option_group_prop: 'engine_name', read_only: false, describe_option_groups_prop: 'engine_name'
  • #major_engine_version ⇒ [String]
    'Specifies the major version of the engine that this option group should be associated with.'
    Property Attributes
    • source ⇒ "create_option_group"
    • orig_name ⇒ 'major_engine_version'
    • create_option_group_prop ⇒ 'major_engine_version'
    • read_only ⇒ false
    • describe_option_groups_prop ⇒ 'major_engine_version'
    

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

property :major_engine_version, description: 'Specifies the major version of the engine that this option group
should be associated with.', source: "create_option_group", orig_name: 'major_engine_version', type: [String], create_option_group_prop: 'major_engine_version', read_only: false, describe_option_groups_prop: 'major_engine_version'
  • #option_group_description ⇒ [String]
    'The description of the option group.'
    Property Attributes
    • source ⇒ "create_option_group"
    • orig_name ⇒ 'option_group_description'
    • create_option_group_prop ⇒ 'option_group_description'
    • read_only ⇒ false
    

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

property :option_group_description, description: 'The description of the option group.', source: "create_option_group", orig_name: 'option_group_description', type: [String], create_option_group_prop: 'option_group_description', read_only: false
  • #option_group_name ⇒ [String]
    'Specifies the name of the option group to be created. Constraints: Must be 1 to 255 letters, numbers, or hyphens First character must be a letter Can"t end with a hyphen or contain two consecutive hyphens Example: myoptiongroup'
    Property Attributes
    • source ⇒ "create_option_group"
    • orig_name ⇒ 'option_group_name'
    • create_option_group_prop ⇒ 'option_group_name'
    • read_only ⇒ false
    • delete_option_group_prop ⇒ 'option_group_name'
    • describe_option_groups_prop ⇒ 'option_group_name'
    • modify_option_group_prop ⇒ 'option_group_name'
    

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

property :option_group_name, description: 'Specifies the name of the option group to be created.

Constraints:


Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can"t end with a hyphen or contain two consecutive hyphens



Example: myoptiongroup', source: "create_option_group", orig_name: 'option_group_name', type: [String], create_option_group_prop: 'option_group_name', read_only: false, delete_option_group_prop: 'option_group_name', describe_option_groups_prop: 'option_group_name', modify_option_group_prop: 'option_group_name'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'Tags to assign to the option group.'
    Property Attributes
    • create_option_group_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_option_group"
    

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

property :tags, create_option_group_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_option_group", description: 'Tags to assign to the option group.', hash: true
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter isn"t currently supported.'
    Property Attributes
    • describe_option_groups_prop ⇒ 'filters'
    • source ⇒ "describe_option_groups"
    

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

property :filters, describe_option_groups_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_option_groups", 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_groups_prop ⇒ 'max_records'
    • source ⇒ "describe_option_groups"
    

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

property :max_records, describe_option_groups_prop: 'max_records', type: [Integer], source: "describe_option_groups", 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.'
  • #options_to_include ⇒ Hash of ⇒ [MintPress::Aws::RDS::OptionConfiguration]
    'Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.'
    Property Attributes
    • modify_option_group_prop ⇒ 'options_to_include'
    • read_only ⇒ false
    • source ⇒ "modify_option_group"
    

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

property :options_to_include, modify_option_group_prop: 'options_to_include', type: [MintPress::Aws::RDS::OptionConfiguration], array: false, read_only: false, source: "modify_option_group", description: 'Options in this list are added to the option group or, if already
present, the specified configuration is used to update the existing
configuration.', hash: true
  • #options_to_remove ⇒ Array of ⇒ [String]
    'Options in this list are removed from the option group.'
    Property Attributes
    • modify_option_group_prop ⇒ 'options_to_remove'
    • read_only ⇒ false
    • source ⇒ "modify_option_group"
    

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

property :options_to_remove, modify_option_group_prop: 'options_to_remove', type: [String], array: true, read_only: false, source: "modify_option_group", description: 'Options in this list are removed from the option group.'
  • #apply_immediately ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.'
    Property Attributes
    • modify_option_group_prop ⇒ 'apply_immediately'
    • read_only ⇒ false
    • source ⇒ "modify_option_group"
    

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

property :apply_immediately, modify_option_group_prop: 'apply_immediately', type: [TrueClass,FalseClass], read_only: false, source: "modify_option_group", description: 'A value that indicates whether to apply the change immediately or
during the next maintenance window for each instance associated with
the option group.'
  • #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 
    

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

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
    

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

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

Properties (Read Only)

  • #allows_vpc_and_non_vpc_instance_memberships ⇒ [TrueClass,FalseClass]
    'Indicates whether this option group can be applied to both VPC and non-VPC instances.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "OptionGroup"
    • orig_name ⇒ 'allows_vpc_and_non_vpc_instance_memberships'
    • read_only ⇒ true
    

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

property :allows_vpc_and_non_vpc_instance_memberships, disposition: :read_only_attribute, description: 'Indicates whether this option group can be applied to both VPC and non-VPC instances.', source: "OptionGroup", orig_name: 'allows_vpc_and_non_vpc_instance_memberships', type: [TrueClass,FalseClass], read_only: true
  • #option_group_arn ⇒ [String]
    'The Amazon Resource Name (ARN) for the option group.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "OptionGroup"
    • orig_name ⇒ 'option_group_arn'
    • read_only ⇒ true
    

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

property :option_group_arn, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) for the option group.', source: "OptionGroup", orig_name: 'option_group_arn', type: [String], read_only: true
  • #options ⇒ Hash of ⇒ [MintPress::Aws::RDS::Option]
    'Indicates what options are available in the option group.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "OptionGroup"
    • orig_name ⇒ 'options'
    • read_only ⇒ true
    

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

property :options, disposition: :read_only_attribute, description: 'Indicates what options are available in the option group.', source: "OptionGroup", orig_name: 'options', type: [MintPress::Aws::RDS::Option], array: false, read_only: true, hash: true
  • #name ⇒ [String]
    '(also: #option_group_name)'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "OptionGroup"
    • orig_name ⇒ 'name'
    

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

property :name, read_only: true, disposition: :read_only_attribute, description: '(also: #option_group_name)', source: "OptionGroup", orig_name: 'name', type: [String]
  • #vpc ⇒ [String]
    'If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "OptionGroup"
    • orig_name ⇒ 'vpc_id'
    • read_only ⇒ true
    

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

property :vpc, disposition: :read_only_attribute, description: 'If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank.', source: "OptionGroup", orig_name: 'vpc_id', type: [String], read_only: true

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

Returns a new instance of OptionGroup.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object