Class: MintPress::Aws::RDS::Event

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

Properties (Read/Write)

  • #source_identifier ⇒ [String]
    'The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. If the source type is a DB instance, a DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a DBParameterGroupName value must be supplied. If the source type is a DB security group, a DBSecurityGroupName value must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied. If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied. Can"t end with a hyphen or contain two consecutive hyphens.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "describe_events"
    • orig_name ⇒ 'source_identifier'
    • describe_events_prop ⇒ 'source_identifier'
    

22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event.rb', line 22

property :source_identifier, disposition: :attribute, description: 'The identifier of the event source for which events are returned. If
not specified, then all sources are included in the response.

Constraints:


If SourceIdentifier is supplied, SourceType must also be
provided.
If the source type is a DB instance, a DBInstanceIdentifier value
must be supplied.
If the source type is a DB cluster, a DBClusterIdentifier value
must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName
value must be supplied.
If the source type is a DB security group, a DBSecurityGroupName
value must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier value
must be supplied.
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier value must be supplied.
Can"t end with a hyphen or contain two consecutive hyphens.', source: "describe_events", orig_name: 'source_identifier', type: [String], describe_events_prop: 'source_identifier'
  • #start_time ⇒ [Time,DateTime,Integer]
    'The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z'
    Property Attributes
    • describe_events_prop ⇒ 'start_time'
    • source ⇒ "describe_events"
    

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

property :start_time, describe_events_prop: 'start_time', type: [Time,DateTime,Integer], source: "describe_events", description: 'The beginning of the time interval to retrieve events for, specified
in ISO 8601 format. For more information about ISO 8601, go to the
ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z'
    Property Attributes
    • describe_events_prop ⇒ 'end_time'
    • source ⇒ "describe_events"
    

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

property :end_time, describe_events_prop: 'end_time', type: [Time,DateTime,Integer], source: "describe_events", description: 'The end of the time interval for which to retrieve events, specified
in ISO 8601 format. For more information about ISO 8601, go to the
ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z'
  • #duration ⇒ [Integer]
    'The number of minutes to retrieve events for. Default: 60'
    Property Attributes
    • describe_events_prop ⇒ 'duration'
    • source ⇒ "describe_events"
    

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

property :duration, describe_events_prop: 'duration', type: [Integer], source: "describe_events", description: 'The number of minutes to retrieve events for.

Default: 60'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'This parameter isn"t currently supported.'
    Property Attributes
    • describe_events_prop ⇒ 'filters'
    • source ⇒ "describe_events"
    

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

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

58
59
60
61
62
63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event.rb', line 58

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

70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/event.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/event.rb', line 73

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

Properties (Read Only)

  • #date ⇒ [String]
    'Specifies the date and time of the event.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::RDS::Event"
    • orig_name ⇒ 'date'
    • read_only ⇒ true
    

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

property :date, disposition: :read_only_attribute, description: 'Specifies the date and time of the event.', source: "MintPress::Aws::RDS::Event", orig_name: 'date', type: [String], read_only: true
  • #event_categories ⇒ Array of ⇒ [String]
    'Specifies the category for the event.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::RDS::Event"
    • orig_name ⇒ 'event_categories'
    • describe_events_prop ⇒ 'event_categories'
    • read_only ⇒ true
    

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

property :event_categories, disposition: :read_only_attribute, description: 'Specifies the category for the event.', source: "MintPress::Aws::RDS::Event", orig_name: 'event_categories', type: [String], array: true, describe_events_prop: 'event_categories', read_only: true
  • #message ⇒ [String]
    'Provides the text of this event.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::RDS::Event"
    • orig_name ⇒ 'message'
    • read_only ⇒ true
    

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

property :message, disposition: :read_only_attribute, description: 'Provides the text of this event.', source: "MintPress::Aws::RDS::Event", orig_name: 'message', type: [String], read_only: true
  • #source_arn ⇒ [String]
    'The Amazon Resource Name (ARN) for the event.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::RDS::Event"
    • orig_name ⇒ 'source_arn'
    • read_only ⇒ true
    

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

property :source_arn, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) for the event.', source: "MintPress::Aws::RDS::Event", orig_name: 'source_arn', type: [String], read_only: true
  • #source_type ⇒ [String]
    'Specifies the source type for this event.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::RDS::Event"
    • orig_name ⇒ 'source_type'
    • describe_events_prop ⇒ 'source_type'
    • read_only ⇒ true
    

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

property :source_type, disposition: :read_only_attribute, description: 'Specifies the source type for this event.', source: "MintPress::Aws::RDS::Event", orig_name: 'source_type', type: [String], describe_events_prop: 'source_type', read_only: true
  • #source ⇒ [String]
    '(also: #source_identifier)'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::RDS::Event"
    • orig_name ⇒ 'source_id'
    

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

property :source, read_only: true, disposition: :read_only_attribute, description: '(also: #source_identifier)', source: "MintPress::Aws::RDS::Event", orig_name: 'source_id', type: [String]

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

Returns a new instance of Event.

Instance Method Details

#describe ⇒ Object