soumyo/aws_lambda_event_invoke_config

docs/resources/aws_lambda_event_invoke_config.md

@@ -0,0 +1,86 @@
+---
+title: About the aws_lambda_event_invoke_config Resource
+platform: aws
+---
+
+# aws_lambda_event_invoke_config
+
+Use the `aws_lambda_event_invoke_config` InSpec audit resource to test properties of a specific AWS Lambda EventInvokeConfig.
+
+The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.
+
+## Syntax
+
+Ensure that the config exists.
+
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+      it { should exist }
+    end
+
+## Parameters
+
+`function_name` _(required)_
+
+The name of the function.
+
+For additional information, see the [AWS documentation on AWS Lambda EventInvokeConfig.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html).
+
+## Properties
+
+| Property | Description | Field | 
+| --- | --- | --- |
+| last_modified | The date and time that the configuration was last updated. | last_modified |
+| function_arn | The Amazon Resource Name (ARN) of the function. | function_arn |
+| maximum_retry_attempts | The maximum number of times to retry when the function returns an error. | maximum_retry_attempts |
+| maximum_event_age_in_seconds | The maximum age of a request that Lambda sends to a function for processing. | maximum_event_age_in_seconds |
+| on_success_destinations | The destination configuration for successful invocations. The Amazon Resource Name (ARN) of the destination resource. | destination_config (on_success (destination)) |
+| on_faliure_destinations | The destination configuration for failed invocations. The Amazon Resource Name (ARN) of the destination resource. | destination_config (on_failure (destination)) |
+
+## Examples
+
+### Ensure an arn is available.
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+      its('function_arn') { should eq 'FUNCTION_ARN' }
+    end
+
+### Ensure a maximum retry attempts is available.
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+        its('maximum_retry_attempts') { should eq 1 }
+    end
+
+### Ensure on success destination is available.
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+        its('on_success_destinations') { should include 'DESTINATION' }
+    end
+
+## Matchers
+
+This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+The controls will pass if the `get` method returns at least one result.
+
+### exist
+
+Use `should` to test that the entity exists.
+
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+      it { should exist }
+    end
+
+Use `should_not` to test the entity does not exist.
+
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+      it { should_not exist }
+    end
+
+### be_available
+
+Use `should` to check if the entity is available.
+
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+      it { should be_available }
+    end
+
+## AWS Permissions
+
+Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `Lambda:Client:FunctionEventInvokeConfig` action with `Effect` set to `Allow`.

docs/resources/aws_lambda_event_invoke_configs.md

@@ -0,0 +1,71 @@
+---
+title: About the aws_lambda_event_invoke_configs Resource
+platform: aws
+---
+
+# aws_lambda_event_invoke_configs
+
+Use the `aws_lambda_event_invoke_configs` InSpec audit resource to test properties of the plural resource of AWS Lambda EventInvokeConfig.
+
+The AWS::Lambda::EventInvokeConfig resource configures options for asynchronous invocation on a version or an alias.
+
+## Syntax
+
+Ensure that the config exists.
+
+    describe aws_lambda_event_invoke_configs(function_name: 'FUNCTION_NAME') do
+      it { should exist }
+    end
+
+## Parameters
+
+`function_name` _(required)_
+
+The name of the function.
+
+For additional information, see the [AWS documentation on AWS Lambda EventInvokeConfig.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html).
+
+## Properties
+
+| Property | Description | Field | 
+| --- | --- | --- |
+| last_modified | The date and time that the configuration was last updated. | last_modified |
+| function_arns | The Amazon Resource Name (ARN) of the function. | function_arn |
+| maximum_retry_attempts | The maximum number of times to retry when the function returns an error. | maximum_retry_attempts |
+| destination_configs | A destination for events after they have been sent to a function for processing. | destination_configs |
+
+## Examples
+
+### Ensure an arn is available.
+    describe aws_lambda_event_invoke_configs(function_name: 'FUNCTION_NAME') do
+      its('function_arns') { should include 'FUNCTION_ARN' }
+    end
+
+### Ensure a maximum retry attempts is available.
+    describe aws_lambda_event_invoke_configs(function_name: 'FUNCTION_NAME') do
+        its('maximum_retry_attempts') { should include 1 }
+    end
+
+## Matchers
+
+This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+The controls will pass if the `list` method returns at least one result.
+
+### exist
+
+Use `should` to test that the entity exists.
+
+    describe aws_lambda_event_invoke_configs(function_name: 'FUNCTION_NAME') do
+      it { should exist }
+    end
+
+Use `should_not` to test the entity does not exist.
+
+    describe aws_lambda_event_invoke_configs(function_name: 'FUNCTION_NAME') do
+      it { should_not exist }
+    end
+
+## AWS Permissions
+
+Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `Lambda:Client:ListFunctionEventInvokeConfigsResponse` action with `Effect` set to `Allow`.

libraries/aws_lambda_event_invoke_config.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'aws_backend'
+
+class AWSLambdaEventInvokeConfig < AwsResourceBase
+  name 'aws_lambda_event_invoke_config'
+  desc 'Retrieves the configuration for asynchronous invocation for a function, version, or alias.'
+
+  example "
+    describe aws_lambda_event_invoke_config(function_name: 'FUNCTION_NAME') do
+      it { should exist }
+    end
+  "
+
+  def initialize(opts = {})
+    opts = { function_name: opts } if opts.is_a?(String)
+    super(opts)
+    validate_parameters(required: %i(function_name))
+    raise ArgumentError, "#{@__resource_name__}: function_name must be provided" unless opts[:function_name] && !opts[:function_name].empty?
+    @display_name = opts[:function_name]
+    catch_aws_errors do
+      resp = @aws.lambda_client.get_function_event_invoke_config({ function_name: opts[:function_name] })
+      @res = resp.to_h
+      create_resource_methods(@res)
+    end
+  end
+
+  def function_name
+    return nil unless exists?
+    @res[:function_name]
+  end
+
+  def exists?
+    !@res.nil? && !@res.empty?
+  end
+
+  def to_s
+    "Function Name: #{@display_name}"
+  end
+
+  def on_success_destinations
+    destination_config.on_success
+  end
+
+  def on_faliure_destinations
+    destination_config.on_faliure
+  end
+end

libraries/aws_lambda_event_invoke_configs.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'aws_backend'
+
+class AWSLambdaEventInvokeConfigs < AwsResourceBase
+  name 'aws_lambda_event_invoke_configs'
+  desc 'Gets information about the scalable targets in the specified namespace.'
+
+  example "
+    describe aws_lambda_event_invoke_configs(function_name: 'FUNCTION_NAME') do
+      it { should exist }
+    end
+  "
+
+  attr_reader :table
+
+  FilterTable.create
+             .register_column(:last_modified, field: :last_modified)
+             .register_column(:function_arns, field: :function_arn)
+             .register_column(:maximum_retry_attempts, field: :maximum_retry_attempts)
+             .register_column(:maximum_event_age_in_seconds, field: :maximum_event_age_in_seconds)
+             .register_column(:destination_configs, field: :destination_config)
+             .install_filter_methods_on_resource(self, :table)
+
+  def initialize(opts = {})
+    super(opts)
+    validate_parameters(required: %i(function_name))
+    @query_params = {}
+    raise ArgumentError, "#{@__resource_name__}: function_name must be provided" unless opts[:function_name] && !opts[:function_name].empty?
+    @query_params[:function_name] = opts[:function_name]
+    @table = fetch_data
+  end
+
+  def fetch_data
+    rows = []
+    loop do
+      catch_aws_errors do
+        @api_response = @aws.lambda_client.list_function_event_invoke_configs(@query_params)
+      end
+      return rows if !@api_response || @api_response.empty?
+      @api_response.function_event_invoke_configs.each do |resp|
+        rows += [{ last_modified: resp.last_modified,
+                   function_arn: resp.function_arn,
+                   maximum_retry_attempts: resp.maximum_retry_attempts,
+                   destination_config: resp.destination_config }]
+      end
+      break unless @api_response.next_marker
+      @query_params[:next_marker] = @api_response.next_marker
+    end
+    rows
+  end
+end