class Aws::RDS::EventSubscription
Public Class Methods
@overload def initialize(name, options = {})
@param [String] name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :name @option options [Client] :client
# File lib/aws-sdk-rds/event_subscription.rb, line 22 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) @waiter_block_warned = false end
Public Instance Methods
@example Request syntax with placeholder values
eventsubscription = event_subscription.add_subscriber({ source_identifier: "String", # required })
@param [Hash] options ({}) @option options [required, String] :source_identifier
The identifier of the event source to be added. Constraints: * 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.
@return [EventSubscription]
# File lib/aws-sdk-rds/event_subscription.rb, line 268 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
@return [Client]
# File lib/aws-sdk-rds/event_subscription.rb, line 108 def client @client end
@example 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", }, ], })
@param [Hash] options ({}) @option options [required, String] :sns_topic_arn
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.
@option options [String] :source_type
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 set this parameter to `db-instance`. If this value isn't specified, all events are returned. Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \| `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
@option options [Array<String>] :event_categories
A list of event categories for a particular source type (`SourceType`) that you want to subscribe to. You can see a list of the categories for a given source type in [Events][1] in the *Amazon RDS User Guide* or by using the `DescribeEventCategories` operation. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
@option options [Array<String>] :source_ids
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, 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.
@option options [Boolean] :enabled
A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
@option options [Array<Types::Tag>] :tags
A list of tags. For more information, see [Tagging Amazon RDS Resources][1] in the *Amazon RDS User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@return [EventSubscription]
# File lib/aws-sdk-rds/event_subscription.rb, line 355 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
The Amazon Web Services customer account associated with the RDS
event notification subscription. @return [String]
# File lib/aws-sdk-rds/event_subscription.rb, line 41 def customer_aws_id data[:customer_aws_id] end
@return [Types::EventSubscription]
Returns the data for this {EventSubscription}. Calls {Client#describe_event_subscriptions} if {#data_loaded?} is `false`.
# File lib/aws-sdk-rds/event_subscription.rb, line 128 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-rds/event_subscription.rb, line 136 def data_loaded? !!@data end
@example Request syntax with placeholder values
event_subscription.delete()
@param [Hash] options ({}) @return [EventSubscription]
# File lib/aws-sdk-rds/event_subscription.rb, line 370 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
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled. @return [Boolean]
# File lib/aws-sdk-rds/event_subscription.rb, line 95 def enabled data[:enabled] end
A list of event categories for the RDS
event notification subscription. @return [Array<String>]
# File lib/aws-sdk-rds/event_subscription.rb, line 88 def event_categories_list data[:event_categories_list] end
The Amazon Resource
Name (ARN) for the event subscription. @return [String]
# File lib/aws-sdk-rds/event_subscription.rb, line 101 def event_subscription_arn data[:event_subscription_arn] end
@deprecated @api private
# File lib/aws-sdk-rds/event_subscription.rb, line 446 def identifiers { name: @name } end
Loads, or reloads {#data} for the current {EventSubscription}. Returns `self` making it possible to chain methods.
event_subscription.reload.data
@return [self]
# File lib/aws-sdk-rds/event_subscription.rb, line 118 def load resp = @client.describe_event_subscriptions(subscription_name: @name) @data = resp.event_subscriptions_list[0] self end
@example Request syntax with placeholder values
eventsubscription = event_subscription.modify({ sns_topic_arn: "String", source_type: "String", event_categories: ["String"], enabled: false, })
@param [Hash] options ({}) @option options [String] :sns_topic_arn
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.
@option options [String] :source_type
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 isn't specified, all events are returned. Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \| `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
@option options [Array<String>] :event_categories
A list of event categories for a source type (`SourceType`) that you want to subscribe to. You can see a list of the categories for a given source type in [Events][1] in the *Amazon RDS User Guide* or by using the `DescribeEventCategories` operation. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
@option options [Boolean] :enabled
A value that indicates whether to activate the subscription.
@return [EventSubscription]
# File lib/aws-sdk-rds/event_subscription.rb, line 413 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
@return [String]
# File lib/aws-sdk-rds/event_subscription.rb, line 33 def name @name end
@example Request syntax with placeholder values
eventsubscription = event_subscription.remove_subscriber({ source_identifier: "String", # required })
@param [Hash] options ({}) @option options [required, String] :source_identifier
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.
@return [EventSubscription]
# File lib/aws-sdk-rds/event_subscription.rb, line 434 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
The topic ARN of the RDS
event notification subscription. @return [String]
# File lib/aws-sdk-rds/event_subscription.rb, line 47 def sns_topic_arn data[:sns_topic_arn] end
A list of source IDs for the RDS
event notification subscription. @return [Array<String>]
# File lib/aws-sdk-rds/event_subscription.rb, line 81 def source_ids_list data[:source_ids_list] end
The source type for the RDS
event notification subscription. @return [String]
# File lib/aws-sdk-rds/event_subscription.rb, line 75 def source_type data[:source_type] end
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. @return [String]
# File lib/aws-sdk-rds/event_subscription.rb, line 63 def status data[:status] end
The time the RDS
event notification subscription was created. @return [String]
# File lib/aws-sdk-rds/event_subscription.rb, line 69 def subscription_creation_time data[:subscription_creation_time] end
@deprecated Use [Aws::RDS::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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) do |instance| instance.state.name == 'running' end
## 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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [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.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-rds/event_subscription.rb, line 220 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
Private Instance Methods
# File lib/aws-sdk-rds/event_subscription.rb, line 453 def extract_name(args, options) value = args[0] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end