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

Class: Aws::RDS::EventSubscription

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ EventSubscription #initialize(options = {}) ⇒ EventSubscription

Returns a new instance of EventSubscription

Overloads:

  • #initialize(name, options = {}) ⇒ EventSubscription

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ EventSubscription

    Options Hash (options):

    • :name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 19

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

Instance Method Details

#add_subscriber(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = event_subscription.add_subscriber({
  source_identifier: "String", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :source_identifier (required, String)

    The identifier of the event source to be added.

    Constraints:

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

Returns:



256
257
258
259
260
261
262
263
264
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 256

def add_subscriber(options = {})
  options = options.merge(subscription_name: @name)
  resp = @client.add_source_identifier_to_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#clientClient

Returns:



104
105
106
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 104

def client
  @client
end

#create(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = event_subscription.create({
  sns_topic_arn: "String", # required
  source_type: "String",
  event_categories: ["String"],
  source_ids: ["String"],
  enabled: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :sns_topic_arn (required, String)

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • :source_type (String)

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

  • :event_categories (Array<String>)

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

  • :source_ids (Array<String>)

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If SourceIds are supplied, SourceType must also be provided.

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

  • :enabled (Boolean)

    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

  • :tags (Array<Types::Tag>)

    A list of tags. For more information, see Tagging Amazon RDS Resources.

Returns:



336
337
338
339
340
341
342
343
344
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 336

def create(options = {})
  options = options.merge(subscription_name: @name)
  resp = @client.create_event_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#customer_aws_idString

The AWS customer account associated with the RDS event notification subscription.

Returns:

  • (String)


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

def customer_aws_id
  data[:customer_aws_id]
end

#dataTypes::EventSubscription

Returns the data for this Aws::RDS::EventSubscription. Calls Client#describe_event_subscriptions if #data_loaded? is false.

Returns:



124
125
126
127
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 124

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.



132
133
134
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 132

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


event_subscription.delete()

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Returns:



351
352
353
354
355
356
357
358
359
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 351

def delete(options = {})
  options = options.merge(subscription_name: @name)
  resp = @client.delete_event_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#enabledBoolean

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

Returns:

  • (Boolean)


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

def enabled
  data[:enabled]
end

#event_categories_listArray<String>

A list of event categories for the RDS event notification subscription.

Returns:

  • (Array<String>)


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

def event_categories_list
  data[:event_categories_list]
end

#event_subscription_arnString

The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (String)


97
98
99
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 97

def event_subscription_arn
  data[:event_subscription_arn]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::RDS::EventSubscription. Returns self making it possible to chain methods.

event_subscription.reload.data

Returns:

  • (self)


114
115
116
117
118
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 114

def load
  resp = @client.describe_event_subscriptions(subscription_name: @name)
  @data = resp.event_subscriptions_list[0]
  self
end

#modify(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = event_subscription.modify({
  sns_topic_arn: "String",
  source_type: "String",
  event_categories: ["String"],
  enabled: false,
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :sns_topic_arn (String)

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • :source_type (String)

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

  • :event_categories (Array<String>)

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

  • :enabled (Boolean)

    A Boolean value; set to true to activate the subscription.

Returns:



394
395
396
397
398
399
400
401
402
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 394

def modify(options = {})
  options = options.merge(subscription_name: @name)
  resp = @client.modify_event_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#nameString Also known as: cust_subscription_id

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 29

def name
  @name
end

#remove_subscriber(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = event_subscription.remove_subscriber({
  source_identifier: "String", # required
})

Parameters:

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :source_identifier (required, String)

    The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

Returns:



415
416
417
418
419
420
421
422
423
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 415

def remove_subscriber(options = {})
  options = options.merge(subscription_name: @name)
  resp = @client.remove_source_identifier_from_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#sns_topic_arnString

The topic ARN of the RDS event notification subscription.

Returns:

  • (String)


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

def sns_topic_arn
  data[:sns_topic_arn]
end

#source_ids_listArray<String>

A list of source IDs for the RDS event notification subscription.

Returns:

  • (Array<String>)


77
78
79
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 77

def source_ids_list
  data[:source_ids_list]
end

#source_typeString

The source type for the RDS event notification subscription.

Returns:

  • (String)


71
72
73
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 71

def source_type
  data[:source_type]
end

#statusString

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

Returns:

  • (String)


59
60
61
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 59

def status
  data[:status]
end

#subscription_creation_timeString

The time the RDS event notification subscription was created.

Returns:

  • (String)


65
66
67
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 65

def subscription_creation_time
  data[:subscription_creation_time]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_subscription.rb', line 214

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end