Class: MintPress::Aws::RDS::ReservedDbInstancesOffering

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

Properties (Read/Write)

  • #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_reserved_db_instances_offerings_prop ⇒ 'db_instance_class'
    • source ⇒ "describe_reserved_db_instances_offerings"
    

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

property :db_instance_class, describe_reserved_db_instances_offerings_prop: 'db_instance_class', type: [String], source: "describe_reserved_db_instances_offerings", description: 'The DB instance class filter value. Specify this parameter to show
only the available offerings matching the specified DB instance class.'
  • #duration ⇒ [String]
    'Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000'
    Property Attributes
    • describe_reserved_db_instances_offerings_prop ⇒ 'duration'
    • source ⇒ "describe_reserved_db_instances_offerings"
    

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

property :duration, describe_reserved_db_instances_offerings_prop: 'duration', type: [String], source: "describe_reserved_db_instances_offerings", description: 'Duration filter value, specified in years or seconds. Specify this
parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000'
  • #product_description ⇒ [String]
    'Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description. The results show offerings that partially match the filter value.'
    Property Attributes
    • describe_reserved_db_instances_offerings_prop ⇒ 'product_description'
    • source ⇒ "describe_reserved_db_instances_offerings"
    

29
30
31
32
33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/reserved_db_instances_offering.rb', line 29

property :product_description, describe_reserved_db_instances_offerings_prop: 'product_description', type: [String], source: "describe_reserved_db_instances_offerings", description: 'Product description filter value. Specify this parameter to show only
the available offerings that contain the specified product
description.

The results show offerings that partially match the filter value.'
  • #offering_type ⇒ [String]
    'The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"'
    Property Attributes
    • describe_reserved_db_instances_offerings_prop ⇒ 'offering_type'
    • source ⇒ "describe_reserved_db_instances_offerings"
    

34
35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/reserved_db_instances_offering.rb', line 34

property :offering_type, describe_reserved_db_instances_offerings_prop: 'offering_type', type: [String], source: "describe_reserved_db_instances_offerings", description: 'The offering type filter value. Specify this parameter to show only
the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"'
  • #multi_az ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to show only those reservations that support Multi-AZ.'
    Property Attributes
    • describe_reserved_db_instances_offerings_prop ⇒ 'multi_az'
    • source ⇒ "describe_reserved_db_instances_offerings"
    

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

property :multi_az, describe_reserved_db_instances_offerings_prop: 'multi_az', type: [TrueClass,FalseClass], source: "describe_reserved_db_instances_offerings", description: 'A value that indicates whether to show only those reservations that
support Multi-AZ.'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter isn"t currently supported.'
    Property Attributes
    • describe_reserved_db_instances_offerings_prop ⇒ 'filters'
    • source ⇒ "describe_reserved_db_instances_offerings"
    

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

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

41
42
43
44
45
46
47
48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/reserved_db_instances_offering.rb', line 41

property :max_records, describe_reserved_db_instances_offerings_prop: 'max_records', type: [Integer], source: "describe_reserved_db_instances_offerings", 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.'
  • #db_instance_count ⇒ [Integer]
    'The number of instances to reserve. Default: 1'
    Property Attributes
    • purchase_reserved_db_instances_offering_prop ⇒ 'db_instance_count'
    • read_only ⇒ false
    • source ⇒ "purchase_reserved_db_instances_offering"
    

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

property :db_instance_count, purchase_reserved_db_instances_offering_prop: 'db_instance_count', type: [Integer], read_only: false, source: "purchase_reserved_db_instances_offering", description: 'The number of instances to reserve.

Default: 1'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.'
    Property Attributes
    • purchase_reserved_db_instances_offering_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "purchase_reserved_db_instances_offering"
    

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

property :tags, purchase_reserved_db_instances_offering_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "purchase_reserved_db_instances_offering", description: 'A list of tags. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.', hash: true
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706'
    Property Attributes
    • describe_reserved_db_instances_offerings_prop ⇒ 'reserved_db_instances_offering_id'
    • source ⇒ "purchase_reserved_db_instances_offering"
    • purchase_reserved_db_instances_offering_prop ⇒ 'reserved_db_instances_offering_id'
    • read_only ⇒ false
    • default ⇒ Proc.new { self.name }
    

54
55
56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/reserved_db_instances_offering.rb', line 54

property :id, describe_reserved_db_instances_offerings_prop: 'reserved_db_instances_offering_id', type: [String], source: "purchase_reserved_db_instances_offering", description: 'The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706', purchase_reserved_db_instances_offering_prop: 'reserved_db_instances_offering_id', read_only: false, array: false, hash: false, default: Proc.new { self.name }
  • #reserved_db_instance ⇒ [MintPress::Aws::RDS::ReservedDbInstance]
    'Customer-specified identifier to track this reservation. Example: myreservationID'
    Property Attributes
    • purchase_reserved_db_instances_offering_prop ⇒ 'reserved_db_instance_id'
    • read_only ⇒ false
    • source ⇒ "purchase_reserved_db_instances_offering"
    • from ⇒ String
    

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

property :reserved_db_instance, purchase_reserved_db_instances_offering_prop: 'reserved_db_instance_id', type: [MintPress::Aws::RDS::ReservedDbInstance], read_only: false, source: "purchase_reserved_db_instances_offering", description: 'Customer-specified identifier to track this reservation.

Example: myreservationID', from: String
  • #name ⇒ String

    Property Attributes 
    

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

property :name, type: String
  • #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 
    

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

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
    

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

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

Returns a new instance of ReservedDbInstancesOffering.

Instance Method Details

#describe ⇒ Object

#purchase ⇒ Object