lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.135.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.136.0

- old
+ new

@@ -453,10 +453,13 @@ # must be supplied. # # * If the source type is a DB cluster snapshot, a # `DBClusterSnapshotIdentifier` value must be supplied. # + # * If the source type is an RDS Proxy, a `DBProxyName` value must be + # supplied. + # # @return [Types::AddSourceIdentifierToSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AddSourceIdentifierToSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription # # @@ -6046,17 +6049,17 @@ # example, you can specify `SourceType` = `db-instance`, `SourceIds` = # `mydbinstance1`, `mydbinstance2` and `EventCategories` = # `Availability`, `Backup`. # # If you specify both the `SourceType` and `SourceIds`, such as - # `SourceType` = `db-instance` and `SourceIdentifier` = `myDBInstance1`, - # you are notified of all the `db-instance` events for the specified - # source. If you specify a `SourceType` but do not specify a - # `SourceIdentifier`, you receive notice of the events for that source - # type for all your RDS sources. If you don't specify either the - # SourceType or the `SourceIdentifier`, you are notified of events - # generated from all RDS sources belonging to your customer account. + # `SourceType` = `db-instance` and `SourceIds` = `myDBInstance1`, you + # are notified of all the `db-instance` events for the specified source. + # If you specify a `SourceType` but do not specify `SourceIds`, you + # receive notice of the events for that source type for all your RDS + # sources. If you don't specify either the SourceType or the + # `SourceIds`, you are notified of events generated from all RDS sources + # belonging to your customer account. # # <note markdown="1"> RDS event notification is only available for unencrypted SNS topics. # If you specify an encrypted SNS topic, event notifications aren't # sent for the topic. # @@ -6073,25 +6076,29 @@ # and subscribe to it. # # @option params [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. + # parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`. + # 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` + # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \| + # `db-proxy` # # @option params [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. + # for a given source type in the "Amazon RDS event categories and event + # messages" section of the [ *Amazon RDS User Guide* ][1] or the [ + # *Amazon Aurora User Guide* ][2]. You can also see this list by using + # the `DescribeEventCategories` operation. # # # - # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html # # @option params [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 @@ -6118,10 +6125,13 @@ # must be supplied. # # * If the source type is a DB cluster snapshot, a # `DBClusterSnapshotIdentifier` value must be supplied. # + # * If the source type is an RDS Proxy, a `DBProxyName` value must be + # supplied. + # # @option params [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. # @@ -10824,23 +10834,27 @@ req = build_request(:describe_engine_default_parameters, params) req.send_request(options) end # Displays a list of categories for all event source types, or, if - # specified, for a specified source type. You can see a list of the - # event categories and source types in [ Events][1] in the *Amazon RDS - # User Guide.* + # specified, for a specified source type. You can also see this list in + # the "Amazon RDS event categories and event messages" section of the + # [ *Amazon RDS User Guide* ][1] or the [ *Amazon Aurora User Guide* + # ][2]. # # # - # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html # # @option params [String] :source_type - # The type of source that is generating the events. + # The type of source that is generating the events. For RDS Proxy + # events, specify `db-proxy`. # # Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \| - # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` + # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \| + # `db-proxy` # # @option params [Array<Types::Filter>] :filters # This parameter isn't currently supported. # # @return [Types::EventCategoriesMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -10978,17 +10992,17 @@ req = build_request(:describe_event_subscriptions, params) req.send_request(options) end # Returns events related to DB instances, DB clusters, DB parameter - # groups, DB security groups, DB snapshots, and DB cluster snapshots for - # the past 14 days. Events specific to a particular DB instances, DB - # clusters, DB parameter groups, DB security groups, DB snapshots, and - # DB cluster snapshots group can be obtained by providing the name as a - # parameter. + # groups, DB security groups, DB snapshots, DB cluster snapshots, and + # RDS Proxies for the past 14 days. Events specific to a particular DB + # instance, DB cluster, DB parameter group, DB security group, DB + # snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by + # providing the name as a parameter. # - # <note markdown="1"> By default, the past hour of events are returned. + # <note markdown="1"> By default, RDS returns events that were generated in the past hour. # # </note> # # @option params [String] :source_identifier # The identifier of the event source for which events are returned. If @@ -11015,10 +11029,13 @@ # must be supplied. # # * If the source type is a DB cluster snapshot, a # `DBClusterSnapshotIdentifier` value must be supplied. # + # * If the source type is an RDS Proxy, a `DBProxyName` value must be + # supplied. + # # * Can't end with a hyphen or contain two consecutive hyphens. # # @option params [String] :source_type # The event source to retrieve events for. If no value is specified, all # events are returned. @@ -11100,11 +11117,11 @@ # # @example Request syntax with placeholder values # # resp = client.describe_events({ # source_identifier: "String", - # source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version + # source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot, custom-engine-version, db-proxy # start_time: Time.now, # end_time: Time.now, # duration: 1, # event_categories: ["String"], # filters: [ @@ -11120,11 +11137,11 @@ # @example Response structure # # resp.marker #=> String # resp.events #=> Array # resp.events[0].source_identifier #=> String - # resp.events[0].source_type #=> String, one of "db-instance", "db-parameter-group", "db-security-group", "db-snapshot", "db-cluster", "db-cluster-snapshot", "custom-engine-version" + # resp.events[0].source_type #=> String, one of "db-instance", "db-parameter-group", "db-security-group", "db-snapshot", "db-cluster", "db-cluster-snapshot", "custom-engine-version", "db-proxy" # resp.events[0].message #=> String # resp.events[0].event_categories #=> Array # resp.events[0].event_categories[0] #=> String # resp.events[0].date #=> Time # resp.events[0].source_arn #=> String @@ -15916,15 +15933,16 @@ # and subscribe to it. # # @option params [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. + # set this parameter to db-instance. For RDS Proxy events, specify + # `db-proxy`. 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` + # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \| + # `db-proxy` # # @option params [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 @@ -22335,10 +22353,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rds' - context[:gem_version] = '1.135.0' + context[:gem_version] = '1.136.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #