inspec 2.1.80 → 2.1.81

data/docs/resources/aws_security_groups.md.erb

@@ -1,97 +1,97 @@
----
-title: About the aws_security_groups Resource
-platform: aws
----
-
-# aws\_security\_groups
-
-Use the `aws_security_groups` InSpec audit resource to test properties of some or all security groups.
-
-Security groups are a networking construct that contain ingress and egress rules for network communications. Security groups may be attached to EC2 instances, as well as certain other AWS resources. Along with Network Access Control Lists, Security Groups are one of the two main mechanisms of enforcing network-level security.
-
-<br>
-
-## Syntax
-
-An `aws_security_groups` resource block uses an optional filter to select a group of security groups and then tests that group.
-
-    # Verify you have more than the default security group
-    describe aws_security_groups do
-      its('entries.count') { should be > 1 }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-As this is the initial release of `aws_security_groups`, its limited functionality precludes examples.
-
-<br>
-
-## Filter Criteria
-
-### vpc\_id
-
-A string identifying the VPC which contains the security group.
-
-    # Look for a particular security group in just one VPC
-    describe aws_security_groups.where( vpc_id: 'vpc-12345678') do
-      its('group_ids') { should include('sg-abcdef12')}
-    end
-
-### group\_name
-
-A string identifying a group. Since groups are contained in VPCs, group names are unique within the AWS account, but not across VPCs.
-
-    # Examine the default security group in all VPCs
-    describe aws_security_groups.where( group_name: 'default') do
-      it { should exist }
-    end
-
-<br>
-
-## Properties
-
-* `entries`, `group_ids`
-
-<br>
-
-## Property Examples
-
-### entries
-
-Provides access to the raw results of the query. This can be useful for checking counts and other advanced operations.
-
-    # Allow at most 100 security groups on the account
-    describe aws_security_groups do
-      its('entries.count') { should be <= 100}
-    end
-
-### group\_ids
-
-Provides a list of all security group IDs matched.
-
-    describe aws_security_groups do
-      its('group_ids') { should include('sg-12345678') }
-    end
-
-## 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 the filter returns at least one result. Use `should_not` if you expect zero matches.
-
-    # You will always have at least one SG, the VPC default SG
-    describe aws_security_groups
-      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 `ec2:DescribeSecurityGroups` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html).
+---
+title: About the aws_security_groups Resource
+platform: aws
+---
+
+# aws\_security\_groups
+
+Use the `aws_security_groups` InSpec audit resource to test properties of some or all security groups.
+
+Security groups are a networking construct that contain ingress and egress rules for network communications. Security groups may be attached to EC2 instances, as well as certain other AWS resources. Along with Network Access Control Lists, Security Groups are one of the two main mechanisms of enforcing network-level security.
+
+<br>
+
+## Syntax
+
+An `aws_security_groups` resource block uses an optional filter to select a group of security groups and then tests that group.
+
+    # Verify you have more than the default security group
+    describe aws_security_groups do
+      its('entries.count') { should be > 1 }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+As this is the initial release of `aws_security_groups`, its limited functionality precludes examples.
+
+<br>
+
+## Filter Criteria
+
+### vpc\_id
+
+A string identifying the VPC which contains the security group.
+
+    # Look for a particular security group in just one VPC
+    describe aws_security_groups.where( vpc_id: 'vpc-12345678') do
+      its('group_ids') { should include('sg-abcdef12')}
+    end
+
+### group\_name
+
+A string identifying a group. Since groups are contained in VPCs, group names are unique within the AWS account, but not across VPCs.
+
+    # Examine the default security group in all VPCs
+    describe aws_security_groups.where( group_name: 'default') do
+      it { should exist }
+    end
+
+<br>
+
+## Properties
+
+* `entries`, `group_ids`
+
+<br>
+
+## Property Examples
+
+### entries
+
+Provides access to the raw results of the query. This can be useful for checking counts and other advanced operations.
+
+    # Allow at most 100 security groups on the account
+    describe aws_security_groups do
+      its('entries.count') { should be <= 100}
+    end
+
+### group\_ids
+
+Provides a list of all security group IDs matched.
+
+    describe aws_security_groups do
+      its('group_ids') { should include('sg-12345678') }
+    end
+
+## 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 the filter returns at least one result. Use `should_not` if you expect zero matches.
+
+    # You will always have at least one SG, the VPC default SG
+    describe aws_security_groups
+      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 `ec2:DescribeSecurityGroups` action with Effect set to Allow.
+
+You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon EC2](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonec2.html).

data/docs/resources/aws_sns_subscription.md.erb

@@ -1,130 +1,130 @@
----
-title: About the aws_sns_subscription Resource
----
-
-# aws\_sns\_subscription
-
-Use the `aws_sns_subscription` InSpec audit resource to test detailed properties of a AWS SNS Subscription.
-
-<br>
-
-## Syntax
-
-An `aws_sns_subscription` resource block uses resource parameters to search for a SNS Subscription, and then tests that subscriptions properties.  If no Subscriptions match, no error is raised, but the `exists` matcher will return `false` and all properties will be `nil`.
-
-    describe aws_sns_subscription('arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-As this is the initial release of `aws_sns_subscription`, its limited functionality precludes examples.
-
-<br>
-
-## Resource Parameters
-
-This InSpec resource accepts the following parameters, which are used to search for the Security Group.
-
-### subscription\_arn
-
-The ARN (Amazon Resource Name) of the AWS SNS Subscription.
-
-    # Using Hash syntax
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
-      it { should exist }
-    end
-
-    # Or omit hash syntax, rely on it being the default parameter
-    describe aws_sns_subscription('arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
-      it { should exist }
-    end
-
-<br>
-
-## Matchers
-
-### exists
-
-The control will pass if the specified Aws Subscription was found.  Use should_not if you want to verify that the specified Subscription does not exist.
-
-    # Test that a specific subscription exists.
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6')
-      it { should exist }
-    end
-
-    # Test that a Subscription does not exist.
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
-      it { should_not exist }
-    end
-
-### be\_confirmation\_authenticated
-
-Provides whether or not the subscription confirmation request was authenticated.
-
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
-      it { should be_confirmation_authenticated }
-    end
-
-### have\_raw\_message\_delivery
-
-Provides whether or not the original message is passed as is, not formatted as a json or yaml.
-
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
-      it { should have_raw_message_delivery }
-    end
-
-## Properties
-
-### endpoint
-
-Provides the destination that the SNS Topic will send notifications to.
-
-    # Inspect the endpoint
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
-      # If protocol is 'sms', this should be a phone number:
-      its('endpoint') { should cmp '+16105551234' }
-      # If protocol is 'email' or 'email-json', endpoint should be an email address
-      its('endpoint') { should cmp 'myemail@example.com' }
-      # If protocal is 'http', endpoint should be a URL beginning with 'https://'
-      its('endpoint') { should cmp 'https://www.exampleurl.com' }
-      # If the protocol is 'lambda', its endpoint should be the ARN of a AWS Lambda function
-      its('endpoint') { should cmp 'rn:aws:lambda:us-east-1:account-id:function:myfunction' }
-    end
-
-### owner
-
-Provides the AWS Owners ID.
-
-    # Inspect the owners ID
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
-      its('owner') { should cmp '12345678' }
-    end
-
-### protocol
-
-Provides the Subscriptions protocol used. For example http, https, email, email-json, sqs, etc.  For more information about protocols please visit https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html
-
-    # Inspect the endpoint
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
-      its('protocol') { should cmp 'sqs' }
-    end
-
-### topic\_arn
-
-Provides the SNS Topic arn that the Subscription is associated with.
-
-    # Inspect the topic arn
-    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
-      its('topic_arn') { should cmp 'arn:aws:sns:us-east-1::test-topic-01' }
-    end
-
-## AWS Permissions
-
-Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `sns:GetSubscriptionAttributes` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon SNS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html).
+---
+title: About the aws_sns_subscription Resource
+---
+
+# aws\_sns\_subscription
+
+Use the `aws_sns_subscription` InSpec audit resource to test detailed properties of a AWS SNS Subscription.
+
+<br>
+
+## Syntax
+
+An `aws_sns_subscription` resource block uses resource parameters to search for a SNS Subscription, and then tests that subscriptions properties.  If no Subscriptions match, no error is raised, but the `exists` matcher will return `false` and all properties will be `nil`.
+
+    describe aws_sns_subscription('arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+As this is the initial release of `aws_sns_subscription`, its limited functionality precludes examples.
+
+<br>
+
+## Resource Parameters
+
+This InSpec resource accepts the following parameters, which are used to search for the Security Group.
+
+### subscription\_arn
+
+The ARN (Amazon Resource Name) of the AWS SNS Subscription.
+
+    # Using Hash syntax
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
+      it { should exist }
+    end
+
+    # Or omit hash syntax, rely on it being the default parameter
+    describe aws_sns_subscription('arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
+      it { should exist }
+    end
+
+<br>
+
+## Matchers
+
+### exists
+
+The control will pass if the specified Aws Subscription was found.  Use should_not if you want to verify that the specified Subscription does not exist.
+
+    # Test that a specific subscription exists.
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should exist }
+    end
+
+    # Test that a Subscription does not exist.
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should_not exist }
+    end
+
+### be\_confirmation\_authenticated
+
+Provides whether or not the subscription confirmation request was authenticated.
+
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should be_confirmation_authenticated }
+    end
+
+### have\_raw\_message\_delivery
+
+Provides whether or not the original message is passed as is, not formatted as a json or yaml.
+
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should have_raw_message_delivery }
+    end
+
+## Properties
+
+### endpoint
+
+Provides the destination that the SNS Topic will send notifications to.
+
+    # Inspect the endpoint
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      # If protocol is 'sms', this should be a phone number:
+      its('endpoint') { should cmp '+16105551234' }
+      # If protocol is 'email' or 'email-json', endpoint should be an email address
+      its('endpoint') { should cmp 'myemail@example.com' }
+      # If protocal is 'http', endpoint should be a URL beginning with 'https://'
+      its('endpoint') { should cmp 'https://www.exampleurl.com' }
+      # If the protocol is 'lambda', its endpoint should be the ARN of a AWS Lambda function
+      its('endpoint') { should cmp 'rn:aws:lambda:us-east-1:account-id:function:myfunction' }
+    end
+
+### owner
+
+Provides the AWS Owners ID.
+
+    # Inspect the owners ID
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      its('owner') { should cmp '12345678' }
+    end
+
+### protocol
+
+Provides the Subscriptions protocol used. For example http, https, email, email-json, sqs, etc.  For more information about protocols please visit https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html
+
+    # Inspect the endpoint
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      its('protocol') { should cmp 'sqs' }
+    end
+
+### topic\_arn
+
+Provides the SNS Topic arn that the Subscription is associated with.
+
+    # Inspect the topic arn
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      its('topic_arn') { should cmp 'arn:aws:sns:us-east-1::test-topic-01' }
+    end
+
+## AWS Permissions
+
+Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `sns:GetSubscriptionAttributes` action with Effect set to Allow.
+
+You can find detailed documentation at [Actions, Resources, and Condition Keys for Amazon SNS](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html).