Class: ESP::CustomSignature::Result

Inherits:

Resource

• Object
• ActiveResource::Base
• Resource
• ESP::CustomSignature::Result

Defined in:

lib/esp/resources/custom_signature/result.rb,
lib/esp/resources/custom_signature/result/alert.rb

Defined Under Namespace

Classes: Alert

Class Method Summary

• .all ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>

  Returns a paginated list.

• .create(attributes = {}) ⇒ ESP::CustomSignature::Result

  Create a CustomSignature::Result call-seq -> super.create(attributes={}).

• .find(id) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>

  Find a CustomSignature::Result by id.

• .where(clauses = {}) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>

  Returns a paginated list filtered by search parameters.

Instance Method Summary

• #alerts ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result::Alert>
• #destroy ⇒ void

  Not Implemented.

• #save ⇒ Boolean

  Create or update a CustomSignature::Result.

• #update ⇒ void

  Not Implemented.

Methods included from Dirty

#changed_attributes, #original_attributes, #original_attributes=

Methods included from LoadWithOriginalAttributes

#load

Class Method Details

.all ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>

Returns a paginated list.

Returns:

• (ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>)

# File 'lib/esp/resources/custom_signature/result.rb', line 61

.create(attributes = {}) ⇒ ESP::CustomSignature::Result

Create a CustomSignature::Result call-seq -> super.create(attributes={})

Examples:

signature = "# Demo Ruby Signature\r\nconfigure do |c|\r\n  # Set regions to run in. Remove this line to run in all regions.\r\n  c.valid_regions     = [:us_east_1]\r\n  # Override region to display as global. Useful when checking resources\r\n  # like IAM that do not have a specific region.\r\n  c.display_as        = :global\r\n  # deep_inspection works with set_data to automically collect\r\n  # data fields for each alert. Not required.\r\n  c.deep_inspection   = [:users]\r\nend\r\n\r\n# Required perform method\r\ndef perform(aws)\r\n  list_users = aws.iam.list_users\r\n  count = list_users[:users].count\r\n\r\n  # Set data for deep_inspection to use\r\n  set_data(list_users)\r\n\r\n  if count == 0\r\n    fail(user_count: count, condition: 'count == 0')\r\n  else\r\n    pass(user_count: count, condition: 'count >= 1')\r\n  end\r\nend\r\n"
result = ESP::CustomSignature::Result.create(signature: signature, language: "ruby", region_id: 1, external_account_id: 1)

Parameters:

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

  Required hash of custom signature result attributes.

  Valid Attributes

  See API documentation for valid arguments

Returns:

• (ESP::CustomSignature::Result)

# File 'lib/esp/resources/custom_signature/result.rb', line 66

.find(id) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result> .find(id, options = {}) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>

Find a CustomSignature::Result by id

call-seq -> super.find(id, options = {})

Overloads:

• .find(id, options = {}) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>

  Parameters:

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

    An optional hash of options.

    Valid Options

    include | The list of associated objects to return on the initial request.

    Valid Includable Associations

    See API documentation for valid arguments

Parameters:

• id (Integer, Numeric, #to_i) —

  Required ID of the custom signature result to retrieve.

Returns:

• (ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>)

# File 'lib/esp/resources/custom_signature/result.rb', line 43

.where(clauses = {}) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>

Returns a paginated list filtered by search parameters

call-seq -> super.where(clauses = {})

Parameters:

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

  A hash of attributes with appended predicates to search, sort and include.

  Valid Clauses

  See API documentation for valid arguments

Returns:

• (ActiveResource::PaginatedCollection<ESP::CustomSignature::Result>)

# File 'lib/esp/resources/custom_signature/result.rb', line 32

Instance Method Details

#alerts ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Result::Alert>

Returns:

• (ActiveResource::PaginatedCollection<ESP::CustomSignature::Result::Alert>)

# File 'lib/esp/resources/custom_signature/result.rb', line 13

def alerts
  return attributes['alerts'] if attributes['alerts'].present?
  CustomSignature::Result::Alert.for_result(id)
end

#destroy ⇒ void

This method returns an undefined value.

Not Implemented. You cannot destroy a CustomSignature::Result.

# File 'lib/esp/resources/custom_signature/result.rb', line 28

def destroy
  fail ESP::NotImplementedError
end

#save ⇒ Boolean

Create or update a CustomSignature::Result

Valid Attributes

See API documentation for valid arguments

Examples:

signature = "# Demo Ruby Signature\r\nconfigure do |c|\r\n  # Set regions to run in. Remove this line to run in all regions.\r\n  c.valid_regions     = [:us_east_1]\r\n  # Override region to display as global. Useful when checking resources\r\n  # like IAM that do not have a specific region.\r\n  c.display_as        = :global\r\n  # deep_inspection works with set_data to automically collect\r\n  # data fields for each alert. Not required.\r\n  c.deep_inspection   = [:users]\r\nend\r\n\r\n# Required perform method\r\ndef perform(aws)\r\n  list_users = aws.iam.list_users\r\n  count = list_users[:users].count\r\n\r\n  # Set data for deep_inspection to use\r\n  set_data(list_users)\r\n\r\n  if count == 0\r\n    fail(user_count: count, condition: 'count == 0')\r\n  else\r\n    pass(user_count: count, condition: 'count >= 1')\r\n  end\r\nend\r\n"
result = ESP::CustomSignature::Result.new(signature: signature, language: "ruby", region_id: 1, external_account_id: 1)
result.save

Returns:

• (Boolean)

# File 'lib/esp/resources/custom_signature/result.rb', line 79

#update ⇒ void

This method returns an undefined value.

Not Implemented. You cannot update a CustomSignature::Result.

# File 'lib/esp/resources/custom_signature/result.rb', line 21

def update
  fail ESP::NotImplementedError
end