Class: Aws::RDS::DBSecurityGroup
- Inherits:
-
Object
- Object
- Aws::RDS::DBSecurityGroup
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#db_security_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB security group.
-
#db_security_group_description ⇒ String
Provides the description of the DB security group.
-
#ec2_security_groups ⇒ Array<Types::EC2SecurityGroup>
Contains a list of
EC2SecurityGroup
elements. -
#ip_ranges ⇒ Array<Types::IPRange>
Contains a list of
IPRange
elements. -
#name ⇒ String
(also: #db_security_group_name)
-
#owner_id ⇒ String
Provides the Amazon Web Services ID of the owner of a specific DB security group.
-
#vpc_id ⇒ String
Provides the VpcId of the DB security group.
Actions collapse
-
#authorize_ingress(options = {}) ⇒ DBSecurityGroup
-
#create(options = {}) ⇒ DBSecurityGroup
-
#delete(options = {}) ⇒ EmptyStructure
-
#revoke_ingress(options = {}) ⇒ DBSecurityGroup
-
#subscribe_to(options = {}) ⇒ EventSubscription
-
#unsubscribe_from(options = {}) ⇒ EventSubscription
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::DBSecurityGroup
Returns the data for this DBSecurityGroup.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ DBSecurityGroup
constructor
A new instance of DBSecurityGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBSecurityGroup.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ DBSecurityGroup #initialize(options = {}) ⇒ DBSecurityGroup
Returns a new instance of DBSecurityGroup.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#authorize_ingress(options = {}) ⇒ DBSecurityGroup
238 239 240 241 242 243 244 245 246 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 238 def ( = {}) = .merge(db_security_group_name: @name) resp = @client.() DBSecurityGroup.new( name: resp.data.db_security_group.db_security_group_name, data: resp.data.db_security_group, client: @client ) end |
#client ⇒ Client
78 79 80 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 78 def client @client end |
#create(options = {}) ⇒ DBSecurityGroup
265 266 267 268 269 270 271 272 273 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 265 def create( = {}) = .merge(db_security_group_name: @name) resp = @client.create_db_security_group() DBSecurityGroup.new( name: resp.data.db_security_group.db_security_group_name, data: resp.data.db_security_group, client: @client ) end |
#data ⇒ Types::DBSecurityGroup
Returns the data for this Aws::RDS::DBSecurityGroup. Calls
Client#describe_db_security_groups if #data_loaded? is false
.
98 99 100 101 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 98 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
106 107 108 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 106 def data_loaded? !!@data end |
#db_security_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB security group.
71 72 73 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 71 def db_security_group_arn data[:db_security_group_arn] end |
#db_security_group_description ⇒ String
Provides the description of the DB security group.
47 48 49 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 47 def db_security_group_description data[:db_security_group_description] end |
#delete(options = {}) ⇒ EmptyStructure
280 281 282 283 284 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 280 def delete( = {}) = .merge(db_security_group_name: @name) resp = @client.delete_db_security_group() resp.data end |
#ec2_security_groups ⇒ Array<Types::EC2SecurityGroup>
Contains a list of EC2SecurityGroup
elements.
59 60 61 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 59 def ec2_security_groups data[:ec2_security_groups] end |
#events(options = {}) ⇒ Event::Collection
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 414 def events( = {}) batches = Enumerator.new do |y| = .merge( source_type: "db-security-group", source_identifier: @name ) resp = @client.describe_events() resp.each_page do |page| batch = [] page.data.events.each do |e| batch << Event.new( source_id: e.source_identifier, date: e.date, data: e, client: @client ) end y.yield(batch) end end Event::Collection.new(batches) end |
#ip_ranges ⇒ Array<Types::IPRange>
Contains a list of IPRange
elements.
65 66 67 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 65 def ip_ranges data[:ip_ranges] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBSecurityGroup.
Returns self
making it possible to chain methods.
db_security_group.reload.data
88 89 90 91 92 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 88 def load resp = @client.describe_db_security_groups(db_security_group_name: @name) @data = resp.db_security_groups[0] self end |
#name ⇒ String Also known as: db_security_group_name
33 34 35 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 33 def name @name end |
#owner_id ⇒ String
Provides the Amazon Web Services ID of the owner of a specific DB security group.
41 42 43 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 41 def owner_id data[:owner_id] end |
#revoke_ingress(options = {}) ⇒ DBSecurityGroup
317 318 319 320 321 322 323 324 325 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 317 def revoke_ingress( = {}) = .merge(db_security_group_name: @name) resp = @client.revoke_db_security_group_ingress() DBSecurityGroup.new( name: resp.data.db_security_group.db_security_group_name, data: resp.data.db_security_group, client: @client ) end |
#subscribe_to(options = {}) ⇒ EventSubscription
337 338 339 340 341 342 343 344 345 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 337 def subscribe_to( = {}) = .merge(source_identifier: @name) resp = @client.add_source_identifier_to_subscription() EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) end |
#unsubscribe_from(options = {}) ⇒ EventSubscription
357 358 359 360 361 362 363 364 365 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 357 def unsubscribe_from( = {}) = .merge(source_identifier: @name) resp = @client.remove_source_identifier_from_subscription() EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) end |
#vpc_id ⇒ String
Provides the VpcId of the DB security group.
53 54 55 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 53 def vpc_id data[:vpc_id] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
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() {|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
attempts attempt in seconds invoked before each attempt invoked before each wait
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 190 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |