inspec 2.1.80 → 2.1.81

data/docs/resources/aws_cloudwatch_alarm.md.erb

@@ -1,91 +1,91 @@
----
-title: About the aws_cloudwatch_alarm Resource
-platform: aws
----
-
-# aws\_cloudwatch\_alarm
-
-Use the `aws_cloudwatch_alarm` InSpec audit resource to test properties of a single Cloudwatch Alarm.
-
-Cloudwatch Alarms are currently identified using the metric name and metric namespace. Future work may allow other approaches to identifying alarms.
-
-<br>
-
-## Syntax
-
-An `aws_cloudwatch_alarm` resource block searches for a Cloudwatch Alarm, specified by several search options. If more than one Alarm matches, an error occurs.
-
-    # Look for a specific alarm
-    aws_cloudwatch_alarm(
-      metric_name: 'my-metric-name',
-      metric_namespace: 'my-metric-namespace',
-    ) do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Ensure an Alarm has at least one alarm action
-
-    describe aws_cloudwatch_alarm(
-      metric: 'my-metric-name',
-      metric_namespace: 'my-metric-namespace',
-    ) do
-      its('alarm_actions') { should_not be_empty }
-    end
-
-<br>
-
-## Properties
-
-* `alarm_actions`
-
-## Property Examples
-
-### alarm\_actions
-
-`alarm_actions` returns a list of strings. Each string is the ARN of an action that will be taken should the alarm be triggered.
-
-    # Ensure that the alarm has at least one action
-    describe aws_cloudwatch_alarm(
-      metric: 'bed-metric',
-      metric_namespace: 'my-metric-namespace',
-    ) do
-      its('alarm_actions') { should_not be_empty }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exists
-
-The control will pass if a Cloudwatch Alarm could be found. Use `should_not` if you expect zero matches.
-
-    # Expect good metric
-    describe aws_cloudwatch_alarm(
-      metric: 'good-metric',
-      metric_namespace: 'my-metric-namespace',
-    ) do
-      it { should exist }
-    end
-
-    # Disallow alarms based on bad-metric
-    describe aws_cloudwatch_alarm(
-      metric: 'bed-metric',
-      metric_namespace: 'my-metric-namespace',
-    ) 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 `cloudwatch:DescribeAlarmsForMetric` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon CloudWatch](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html).
+---
+title: About the aws_cloudwatch_alarm Resource
+platform: aws
+---
+
+# aws\_cloudwatch\_alarm
+
+Use the `aws_cloudwatch_alarm` InSpec audit resource to test properties of a single Cloudwatch Alarm.
+
+Cloudwatch Alarms are currently identified using the metric name and metric namespace. Future work may allow other approaches to identifying alarms.
+
+<br>
+
+## Syntax
+
+An `aws_cloudwatch_alarm` resource block searches for a Cloudwatch Alarm, specified by several search options. If more than one Alarm matches, an error occurs.
+
+    # Look for a specific alarm
+    aws_cloudwatch_alarm(
+      metric_name: 'my-metric-name',
+      metric_namespace: 'my-metric-namespace',
+    ) do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Ensure an Alarm has at least one alarm action
+
+    describe aws_cloudwatch_alarm(
+      metric: 'my-metric-name',
+      metric_namespace: 'my-metric-namespace',
+    ) do
+      its('alarm_actions') { should_not be_empty }
+    end
+
+<br>
+
+## Properties
+
+* `alarm_actions`
+
+## Property Examples
+
+### alarm\_actions
+
+`alarm_actions` returns a list of strings. Each string is the ARN of an action that will be taken should the alarm be triggered.
+
+    # Ensure that the alarm has at least one action
+    describe aws_cloudwatch_alarm(
+      metric: 'bed-metric',
+      metric_namespace: 'my-metric-namespace',
+    ) do
+      its('alarm_actions') { should_not be_empty }
+    end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exists
+
+The control will pass if a Cloudwatch Alarm could be found. Use `should_not` if you expect zero matches.
+
+    # Expect good metric
+    describe aws_cloudwatch_alarm(
+      metric: 'good-metric',
+      metric_namespace: 'my-metric-namespace',
+    ) do
+      it { should exist }
+    end
+
+    # Disallow alarms based on bad-metric
+    describe aws_cloudwatch_alarm(
+      metric: 'bed-metric',
+      metric_namespace: 'my-metric-namespace',
+    ) 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 `cloudwatch:DescribeAlarmsForMetric` action with Effect set to Allow.
+
+You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon CloudWatch](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html).

data/docs/resources/aws_cloudwatch_log_metric_filter.md.erb

@@ -1,154 +1,154 @@
----
-title: About the aws_cloudwatch_log_metric_filter Resource
-platform: aws
----
-
-# aws\_cloudwatch\_log\_metric\_filter
-
-Use the `aws_cloudwatch_log_metric_filter` InSpec audit resource to search for and test properties of individual AWS Cloudwatch Log Metric Filters.
-
-A Log Metric Filter (LMF) is an AWS resource that observes log traffic, looks for a specified pattern, and then updates a metric about the number times the match occurs.  The metric can also be connected to AWS Cloudwatch Alarms, so that actions can be taken when a match occurs.
-
-<br>
-
-## Syntax
-
-An `aws_cloudwatch_log_metric_filter` resource block searches for an LMF, specified by several search options.  If more than one log metric filter matches, an error occurs.
-
-    # Look for an LMF by its filter name and log group name.  This combination
-    # will always either find at most one LMF - no duplicates.
-    describe aws_cloudwatch_log_metric_filter(
-      filter_name: 'my-filter',
-      log_group_name: 'my-log-group'
-    ) do
-      it { should exist }
-    end
-
-    # Search for an LMF by pattern and log group.
-    # This could result in an error if the results are not unique.
-    describe aws_cloudwatch_log_metric_filter(
-      log_group_name:  'my-log-group',
-      pattern: 'my-filter'
-    ) do
-      it { should exist }
-    end
-
-<br>
-
-## Filter Attributes
-
-* `filter_name`, `log_group_name`, `pattern`
-
-<br>
-
-## Filter Examples
-
-### filter\_name
-
-This is the identifier of the log metric filter within its log group.  To ensure you have a unique result, you must also provide the `log_group_name`.
-
-    describe aws_cloudwatch_log_metric_filter(
-      filter_name: 'my-filter'
-    ) do
-      it { should exist }
-    end
-
-### log\_group\_name
-
-The name of the Cloudwatch Log Group that the LMF is watching.  Together with `filter_name`, this uniquely identifies an LMF.
-
-    describe aws_cloudwatch_log_metric_filter(
-      log_group_name: 'my-log-group',
-    ) do
-      it { should exist }
-    end
-
-### pattern
-
-The filter pattern used to match entries from the logs in the log group.
-
-    describe aws_cloudwatch_log_metric_filter(
-      pattern: '"ERROR" - "Exiting"',
-    ) do
-      it { should exist }
-    end
-
-<br>
-
-## Properties
-
-* `filter_name`, `log_group_name`,` metric_name`, `metric_namespace`, `pattern`
-
-<br>
-
-## Property Examples
-
-### filter\_name
-
-The name of the LMF within the `log_group`.
-
-    # Check the name of the LMF that has a certain pattern
-    describe aws_cloudwatch_log_metric_filter(
-      log_group_name: 'app-log-group',
-      pattern: 'KERBLEWIE',
-    ) do
-      its('filter_name') { should cmp 'kaboom_lmf' }
-    end
-
-### log\_group\_name
-
-The name of the log group that the LMF is watching.
-
-    # Check which log group the LMF 'error-watcher' is watching
-    describe aws_cloudwatch_log_metric_filter(
-      filter_name: 'error-watcher',
-    ) do
-      its('log_group_name') { should cmp 'app-log-group' }
-    end
-
-### metric\_name, metric\_namespace
-
-The name and namespace of the Cloudwatch Metric that will be updated when the LMF matches.  You also need the `metric_namespace` to uniquely identify the metric.
-
-    # Ensure that the LMF has the right metric name
-    describe aws_cloudwatch_log_metric_filter(
-      filter_name: 'my-filter',
-      log_group_name: 'my-log-group',
-    ) do
-      its('metric_name') { should cmp 'MyMetric' }
-      its('metric_namespace') { should cmp 'MyFantasticMetrics' }
-    end
-
-### pattern
-
-The pattern used to match entries from the logs in the log group.
-
-    # Ensure that the LMF is watching for errors
-    describe aws_cloudwatch_log_metric_filter(
-      filter_name: 'error-watcher',
-      log_group_name: 'app-log-group',
-    ) do
-      its('pattern') { should cmp 'ERROR' }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exist
-
-Matches (i.e., passes the test) if the resource parameters (search criteria) were able to locate exactly one LMF.
-
-    describe aws_cloudwatch_log_metric_filter(
-      log_group_name: 'my-log-group',
-    ) do
-      it { should exist }
-    end
-
-## AWS Permissions
-
-Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `cloudwatch:DescribeAlarmsForMetric` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon CloudWatch](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html).
+---
+title: About the aws_cloudwatch_log_metric_filter Resource
+platform: aws
+---
+
+# aws\_cloudwatch\_log\_metric\_filter
+
+Use the `aws_cloudwatch_log_metric_filter` InSpec audit resource to search for and test properties of individual AWS Cloudwatch Log Metric Filters.
+
+A Log Metric Filter (LMF) is an AWS resource that observes log traffic, looks for a specified pattern, and then updates a metric about the number times the match occurs.  The metric can also be connected to AWS Cloudwatch Alarms, so that actions can be taken when a match occurs.
+
+<br>
+
+## Syntax
+
+An `aws_cloudwatch_log_metric_filter` resource block searches for an LMF, specified by several search options.  If more than one log metric filter matches, an error occurs.
+
+    # Look for an LMF by its filter name and log group name.  This combination
+    # will always either find at most one LMF - no duplicates.
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'my-filter',
+      log_group_name: 'my-log-group'
+    ) do
+      it { should exist }
+    end
+
+    # Search for an LMF by pattern and log group.
+    # This could result in an error if the results are not unique.
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name:  'my-log-group',
+      pattern: 'my-filter'
+    ) do
+      it { should exist }
+    end
+
+<br>
+
+## Filter Attributes
+
+* `filter_name`, `log_group_name`, `pattern`
+
+<br>
+
+## Filter Examples
+
+### filter\_name
+
+This is the identifier of the log metric filter within its log group.  To ensure you have a unique result, you must also provide the `log_group_name`.
+
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'my-filter'
+    ) do
+      it { should exist }
+    end
+
+### log\_group\_name
+
+The name of the Cloudwatch Log Group that the LMF is watching.  Together with `filter_name`, this uniquely identifies an LMF.
+
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name: 'my-log-group',
+    ) do
+      it { should exist }
+    end
+
+### pattern
+
+The filter pattern used to match entries from the logs in the log group.
+
+    describe aws_cloudwatch_log_metric_filter(
+      pattern: '"ERROR" - "Exiting"',
+    ) do
+      it { should exist }
+    end
+
+<br>
+
+## Properties
+
+* `filter_name`, `log_group_name`,` metric_name`, `metric_namespace`, `pattern`
+
+<br>
+
+## Property Examples
+
+### filter\_name
+
+The name of the LMF within the `log_group`.
+
+    # Check the name of the LMF that has a certain pattern
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name: 'app-log-group',
+      pattern: 'KERBLEWIE',
+    ) do
+      its('filter_name') { should cmp 'kaboom_lmf' }
+    end
+
+### log\_group\_name
+
+The name of the log group that the LMF is watching.
+
+    # Check which log group the LMF 'error-watcher' is watching
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'error-watcher',
+    ) do
+      its('log_group_name') { should cmp 'app-log-group' }
+    end
+
+### metric\_name, metric\_namespace
+
+The name and namespace of the Cloudwatch Metric that will be updated when the LMF matches.  You also need the `metric_namespace` to uniquely identify the metric.
+
+    # Ensure that the LMF has the right metric name
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'my-filter',
+      log_group_name: 'my-log-group',
+    ) do
+      its('metric_name') { should cmp 'MyMetric' }
+      its('metric_namespace') { should cmp 'MyFantasticMetrics' }
+    end
+
+### pattern
+
+The pattern used to match entries from the logs in the log group.
+
+    # Ensure that the LMF is watching for errors
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'error-watcher',
+      log_group_name: 'app-log-group',
+    ) do
+      its('pattern') { should cmp 'ERROR' }
+    end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exist
+
+Matches (i.e., passes the test) if the resource parameters (search criteria) were able to locate exactly one LMF.
+
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name: 'my-log-group',
+    ) do
+      it { should exist }
+    end
+
+## AWS Permissions
+
+Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `cloudwatch:DescribeAlarmsForMetric` action with Effect set to Allow.
+
+You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon CloudWatch](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html).