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

Class: Aws::RDS::DBSecurityGroup

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DBSecurityGroup

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBSecurityGroup

    Options Hash (options):

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


19
20
21
22
23
24
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.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

#authorize_ingress(options = {}) ⇒ DBSecurityGroup

Examples:

Request syntax with placeholder values


dbsecuritygroup = db_security_group.authorize_ingress({
  cidrip: "String",
  ec2_security_group_name: "String",
  ec2_security_group_id: "String",
  ec2_security_group_owner_id: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :cidrip (String) —

    The IP range to authorize.

  • :ec2_security_group_name (String) —

    Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • :ec2_security_group_id (String) —

    Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • :ec2_security_group_owner_id (String) —

    AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Returns:



230
231
232
233
234
235
236
237
238
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 230

def authorize_ingress(options = {})
  options = options.merge(db_security_group_name: @name)
  resp = @client.authorize_db_security_group_ingress(options)
  DBSecurityGroup.new(
    name: resp.data.db_security_group.db_security_group_name,
    data: resp.data.db_security_group,
    client: @client
  )
end

#client ⇒ Client

Returns:



73
74
75
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 73

def client
  @client
end

#create(options = {}) ⇒ DBSecurityGroup

Examples:

Request syntax with placeholder values


dbsecuritygroup = db_security_group.create({
  db_security_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :db_security_group_description (required, String) —

    The description for the DB security group.

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

    Tags to assign to the DB security group.

Returns:



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

def create(options = {})
  options = options.merge(db_security_group_name: @name)
  resp = @client.create_db_security_group(options)
  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.

Returns:



93
94
95
96
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 93

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.



101
102
103
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 101

def data_loaded?
  !!@data
end

#db_security_group_arn ⇒ String

The Amazon Resource Name (ARN) for the DB security group.

Returns:

  • (String) 


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

def db_security_group_arn
  data[:db_security_group_arn]
end

#db_security_group_description ⇒ String

Provides the description of the DB security group.

Returns:

  • (String) 


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

def db_security_group_description
  data[:db_security_group_description]
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


db_security_group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


272
273
274
275
276
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 272

def delete(options = {})
  options = options.merge(db_security_group_name: @name)
  resp = @client.delete_db_security_group(options)
  resp.data
end

#ec2_security_groups ⇒ Array<Types::EC2SecurityGroup>

Contains a list of EC2SecurityGroup elements.

Returns:



54
55
56
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 54

def ec2_security_groups
  data[:ec2_security_groups]
end

#events(options = {}) ⇒ Event::Collection

Examples:

Request syntax with placeholder values


events = db_security_group.events({
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :start_time (Time, DateTime, Date, Integer, String) —

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :end_time (Time, DateTime, Date, Integer, String) —

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :duration (Integer) —

    The number of minutes to retrieve events for.

    Default: 60

  • :event_categories (Array<String>) —

    A list of event categories that trigger notifications for a event notification subscription.

  • :filters (Array<Types::Filter>) —

    This parameter is not currently supported.

Returns:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 406

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-security-group",
      source_identifier: @name
    )
    resp = @client.describe_events(options)
    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.

Returns:



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

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

Returns:

  • (self) 


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

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

Returns:

  • (String) 


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

def name
  @name
end

#owner_id ⇒ String

Provides the AWS ID of the owner of a specific DB security group.

Returns:

  • (String) 


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

def owner_id
  data[:owner_id]
end

#revoke_ingress(options = {}) ⇒ DBSecurityGroup

Examples:

Request syntax with placeholder values


dbsecuritygroup = db_security_group.revoke_ingress({
  cidrip: "String",
  ec2_security_group_name: "String",
  ec2_security_group_id: "String",
  ec2_security_group_owner_id: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :cidrip (String) —

    The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.

  • :ec2_security_group_name (String) —

    The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • :ec2_security_group_id (String) —

    The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

  • :ec2_security_group_owner_id (String) —

    The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

Returns:



309
310
311
312
313
314
315
316
317
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 309

def revoke_ingress(options = {})
  options = options.merge(db_security_group_name: @name)
  resp = @client.revoke_db_security_group_ingress(options)
  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

Examples:

Request syntax with placeholder values


eventsubscription = db_security_group.subscribe_to({
  subscription_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :subscription_name (required, String) —

    The name of the RDS event notification subscription you want to add a source identifier to.

Returns:



329
330
331
332
333
334
335
336
337
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 329

def subscribe_to(options = {})
  options = options.merge(source_identifier: @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

#unsubscribe_from(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = db_security_group.unsubscribe_from({
  subscription_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :subscription_name (required, String) —

    The name of the RDS event notification subscription you want to remove a source identifier from.

Returns:



349
350
351
352
353
354
355
356
357
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 349

def unsubscribe_from(options = {})
  options = options.merge(source_identifier: @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

#vpc_id ⇒ String

Provides the VpcId of the DB security group.

Returns:

  • (String) 


48
49
50
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 48

def vpc_id
  data[:vpc_id]
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_security_group.rb', line 183

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