You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::Event

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(source_id, date, options = {}) ⇒ Event #initialize(options = {}) ⇒ Event

Returns a new instance of Event

Overloads:

  • #initialize(source_id, date, options = {}) ⇒ Event

    Parameters:

    • source_id (String)
    • date (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Event

    Options Hash (options):

    • :source_id (required, String)
    • :date (required, String)
    • :client (Client)


21
22
23
24
25
26
27
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 21

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @source_id = extract_source_id(args, options)
  @date = extract_date(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#clientClient

Returns:



69
70
71
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 69

def client
  @client
end

#dataTypes::Event

Returns the data for this Aws::RDS::Event.

Returns:

Raises:



84
85
86
87
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 84

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



92
93
94
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 92

def data_loaded?
  !!@data
end

#dateString

Returns:

  • (String)


38
39
40
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 38

def date
  @date
end

#event_categoriesArray<String>

Specifies the category for the event.

Returns:

  • (Array<String>)


56
57
58
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 56

def event_categories
  data.event_categories
end

#messageString

Provides the text of this event.

Returns:

  • (String)


50
51
52
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 50

def message
  data.message
end

#source_arnString

The Amazon Resource Name (ARN) for the event.

Returns:

  • (String)


62
63
64
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 62

def source_arn
  data.source_arn
end

#source_idString Also known as: source_identifier

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 32

def source_id
  @source_id
end

#source_typeString

Specifies the source type for this event.

Returns:

  • (String)


44
45
46
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 44

def source_type
  data.source_type
end