inspec 2.1.21 → 2.1.30

data/docs/resources/aws_sns_topics.md.erb

@@ -1,52 +1,52 @@
----
-title: About the aws_sns_topics Resource
----
-
-# aws\_sns\_topics
-Use the `aws_sns_topics` InSpec audit resource to test all or a group of the SNS Topic ARNs in an account.
-
-User the 'aws_sns_topic' InSpec audit resource to test a single SNS Topic in an account.
-
-<br>
-
-## Syntax
-
-An `aws_sns_topics` resource block takes no filter conditions.
-
-    # Get all SNS Topic arns
-    describe aws_sns_topics do
-      its('topic_arns') { should include 'arn:aws:sns:us-east-1:333344445555:MyTopic' }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-As this is the initial release of `aws_sns_topics`, its limited functionality precludes examples.
-
-<br>
-
-## Matchers
-
-### exists
-
-The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.
-
-    # Test if there is any SNS Topics
-    describe aws_sns_topics
-      it { should exist }
-    end
-
-
-## Properties
-
-### topic\_arns
-
-Provides an array of all SNS Topic arns.
-
-    # Test that a specific SNS Topic exists
-    describe aws_sns_topics do
-      its('topic_arns') { should include 'arn:aws:sns:us-east-1:333344445555:MyTopic' }
-    end
+---
+title: About the aws_sns_topics Resource
+---
+
+# aws\_sns\_topics
+Use the `aws_sns_topics` InSpec audit resource to test all or a group of the SNS Topic ARNs in an account.
+
+User the 'aws_sns_topic' InSpec audit resource to test a single SNS Topic in an account.
+
+<br>
+
+## Syntax
+
+An `aws_sns_topics` resource block takes no filter conditions.
+
+    # Get all SNS Topic arns
+    describe aws_sns_topics do
+      its('topic_arns') { should include 'arn:aws:sns:us-east-1:333344445555:MyTopic' }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+As this is the initial release of `aws_sns_topics`, its limited functionality precludes examples.
+
+<br>
+
+## Matchers
+
+### exists
+
+The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.
+
+    # Test if there is any SNS Topics
+    describe aws_sns_topics
+      it { should exist }
+    end
+
+
+## Properties
+
+### topic\_arns
+
+Provides an array of all SNS Topic arns.
+
+    # Test that a specific SNS Topic exists
+    describe aws_sns_topics do
+      its('topic_arns') { should include 'arn:aws:sns:us-east-1:333344445555:MyTopic' }
+    end

data/docs/resources/aws_subnet.md.erb

@@ -1,134 +1,134 @@
----
-title: About the aws_subnet Resource
-platform: aws
----
-
-# aws\_subnet
-
-Use the `aws_subnet` InSpec audit resource to test properties of a vpc subnet.
-
-To test properties of a single VPC subnet, use the `aws_subnet` resource.
-
-To test properties of all or a group of VPC subnets, use the `aws_subnets` resource.
-
-<br>
-
-## Syntax
-
-An `aws_subnet` resource block uses the parameter to select a VPC and a subnet in the VPC.
-
-    describe aws_subnet(subnet_id: 'subnet-1234567') do
-      it { should exist }
-      its('cidr_block') { should eq '10.0.1.0/24' }
-    end
-
-<br>
-
-## Resource Parameters
-
-This InSpec resource accepts the following parameters, which are used to search for the VPCs subnet.
-
-### subnet\_id
-
-A string identifying the subnet that the VPC contains.
-
-    # This will error if there is more than the default SG
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should exist }    
-    end
-
-<br>
-
-## Properties
-
-* `availability_zone`, `available_ip_address_count`, `cidr_block`, `subnet_id`, `vpc_id`
-
-<br>
-
-## Property Examples
-
-### availability\_zone
-
-Provides the Availability Zone of the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('availability_zone') { should eq 'us-east-1c' }    
-    end
-
-### available\_ip\_address\_count
-
-Provides the number of available IPv4 addresses on the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('available_ip_address_count') { should eq 251 }    
-    end
-
-### cidr\_block
-
-Provides the block of ip addresses specified to the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('cidr_block') { should eq '10.0.1.0/24' }    
-    end
-
-### subnet\_id
-
-Provides the ID of the Subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('subnet_id') { should eq 'subnet-12345678' }    
-    end
-
-### vpc\_id
-
-Provides the ID of the VPC the subnet is in.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('vpc_id') { should eq 'vpc-12345678' }    
-    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/).
-
-### assigning\_ipv\_6\_address\_on\_creation
-
-Detects if the network interface on the subnet accepts IPv6 addresses.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_assigning_ipv_6_address_on_creation }    
-    end
-    
-### available
-
-Provides the current state of the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_available }    
-    end
-
-### default\_for\_az
-
-Detects if the subnet is the default subnet for the Availability Zone.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_default_for_az }    
-    end
-
-### exist
-
-The `exist` matcher indicates that a subnet exists for the specified vpc.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should exist }
-    end
-    
-### mapping\_public\_ip\_on\_launch
-
-Provides the VPC ID for the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_mapping_public_ip_on_launch }    
-    end
+---
+title: About the aws_subnet Resource
+platform: aws
+---
+
+# aws\_subnet
+
+Use the `aws_subnet` InSpec audit resource to test properties of a vpc subnet.
+
+To test properties of a single VPC subnet, use the `aws_subnet` resource.
+
+To test properties of all or a group of VPC subnets, use the `aws_subnets` resource.
+
+<br>
+
+## Syntax
+
+An `aws_subnet` resource block uses the parameter to select a VPC and a subnet in the VPC.
+
+    describe aws_subnet(subnet_id: 'subnet-1234567') do
+      it { should exist }
+      its('cidr_block') { should eq '10.0.1.0/24' }
+    end
+
+<br>
+
+## Resource Parameters
+
+This InSpec resource accepts the following parameters, which are used to search for the VPCs subnet.
+
+### subnet\_id
+
+A string identifying the subnet that the VPC contains.
+
+    # This will error if there is more than the default SG
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should exist }    
+    end
+
+<br>
+
+## Properties
+
+* `availability_zone`, `available_ip_address_count`, `cidr_block`, `subnet_id`, `vpc_id`
+
+<br>
+
+## Property Examples
+
+### availability\_zone
+
+Provides the Availability Zone of the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('availability_zone') { should eq 'us-east-1c' }    
+    end
+
+### available\_ip\_address\_count
+
+Provides the number of available IPv4 addresses on the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('available_ip_address_count') { should eq 251 }    
+    end
+
+### cidr\_block
+
+Provides the block of ip addresses specified to the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('cidr_block') { should eq '10.0.1.0/24' }    
+    end
+
+### subnet\_id
+
+Provides the ID of the Subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('subnet_id') { should eq 'subnet-12345678' }    
+    end
+
+### vpc\_id
+
+Provides the ID of the VPC the subnet is in.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('vpc_id') { should eq 'vpc-12345678' }    
+    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/).
+
+### assigning\_ipv\_6\_address\_on\_creation
+
+Detects if the network interface on the subnet accepts IPv6 addresses.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_assigning_ipv_6_address_on_creation }    
+    end
+    
+### available
+
+Provides the current state of the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_available }    
+    end
+
+### default\_for\_az
+
+Detects if the subnet is the default subnet for the Availability Zone.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_default_for_az }    
+    end
+
+### exist
+
+The `exist` matcher indicates that a subnet exists for the specified vpc.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should exist }
+    end
+    
+### mapping\_public\_ip\_on\_launch
+
+Provides the VPC ID for the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_mapping_public_ip_on_launch }    
+    end

data/docs/resources/aws_subnets.md.erb

@@ -1,126 +1,126 @@
----
-title: About the aws_subnets Resource
-platform: aws
----
-
-# aws\_subnets
-
-Use the `aws_subnets` InSpec audit resource to test properties of some or all subnets.
-
-Subnets are networks within a VPC that can have their own block of IP address's and ACL's.
-VPCs span across all availability zones in AWS, while a subnet in a VPC can only span a single availability zone.
-Separating IP addresses allows for protection if there is a failure in one availability zone.
-
-<br>
-
-## Syntax
-
-An `aws_subnets` resource block uses an optional filter to select a group of subnets and then tests that group.
-
-    # Test all subnets within a single vpc
-    describe aws_subnets.where(vpc_id: 'vpc-12345678') do
-      its('subnet_ids') { should include 'subnet-12345678' }
-      its('subnet_ids') { should include 'subnet-98765432' }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-As this is the initial release of `aws_subnets`, its limited functionality precludes examples.
-
-<br>
-
-## Filter Criteria
-
-* `vpc_id`, `subnet_id`
-
-## Filter Examples
-
-### vpc\_id
-
-A string identifying the VPC which may or may not contain subnets.
-
-    # Look for all subnets within a vpc.
-    describe aws_subnets.where( vpc_id: 'vpc-12345678') do
-      its('subnet_ids') { should include 'subnet-12345678' }
-      its('subnet_ids') { should include 'subnet-98765432' }
-    end
-
-### subnet\_id
-
-A string identifying a specific subnet.
-
-    # Examine a specific subnet
-    describe aws_subnets.where(subnet_id: 'subnet-12345678') do
-      its('cidr_blocks') { should eq ['10.0.1.0/24'] }
-    end
-
-<br>
-
-## Properties
-
-* `cidr_blocks`,  `states`, `subnet_ids`,`vpc_ids`
-
-<br>
-
-## Property Examples
-
-### cidr\_blocks
-
-Provides a string that contains the cidr block of ip addresses that can be given in the subnet.
-
-    # Examine a specific subnets cidr_blocks
-    describe aws_subnets.where( subnet_id: 'subnet-12345678') do
-      its('cidr_blocks') { should eq ['10.0.1.0/24'] }
-    end
-
-### states
-
-Provides an array of strings including if the subnets are available.
-
-    # Examine a specific vpcs Subnet IDs
-    describe aws_subnets.where( vpc_id: 'vpc-12345678') do
-      its('states') { should_not include 'pending' }
-    end
-
-### subnet\_ids
-
-Provides an array of strings containing the subnet IDs associated with a vpc.
-
-    # Examine a specific vpcs Subnet IDs
-    describe aws_subnets.where( vpc_id: 'vpc-12345678') do
-      its('subnet_ids') { should include 'subnet-12345678' }
-      its('subnet_ids') { should include 'subnet-98765432' }
-    end
-
-### vpc\_ids
-
-Provides an array containing a string of the vpc_id associated with a subnet.
-
-    # Examine a specific subnets VPC IDS
-    describe aws_subnets.where( subnet_id: 'subnet-12345678') do
-      its('vpc_ids') { should include 'vpc-12345678' }
-    end
-
-<br>
-
-## 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 dont always have subnets, so you can test if there are any.
-    describe aws_subnets
-      it { should exist }
-    end
-
-    # Test that there are subnets in a vpc
-    describe aws_subnets.where(vpc_id: 'vpc-12345678')
-      it { should exist }
-    end
+---
+title: About the aws_subnets Resource
+platform: aws
+---
+
+# aws\_subnets
+
+Use the `aws_subnets` InSpec audit resource to test properties of some or all subnets.
+
+Subnets are networks within a VPC that can have their own block of IP address's and ACL's.
+VPCs span across all availability zones in AWS, while a subnet in a VPC can only span a single availability zone.
+Separating IP addresses allows for protection if there is a failure in one availability zone.
+
+<br>
+
+## Syntax
+
+An `aws_subnets` resource block uses an optional filter to select a group of subnets and then tests that group.
+
+    # Test all subnets within a single vpc
+    describe aws_subnets.where(vpc_id: 'vpc-12345678') do
+      its('subnet_ids') { should include 'subnet-12345678' }
+      its('subnet_ids') { should include 'subnet-98765432' }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+As this is the initial release of `aws_subnets`, its limited functionality precludes examples.
+
+<br>
+
+## Filter Criteria
+
+* `vpc_id`, `subnet_id`
+
+## Filter Examples
+
+### vpc\_id
+
+A string identifying the VPC which may or may not contain subnets.
+
+    # Look for all subnets within a vpc.
+    describe aws_subnets.where( vpc_id: 'vpc-12345678') do
+      its('subnet_ids') { should include 'subnet-12345678' }
+      its('subnet_ids') { should include 'subnet-98765432' }
+    end
+
+### subnet\_id
+
+A string identifying a specific subnet.
+
+    # Examine a specific subnet
+    describe aws_subnets.where(subnet_id: 'subnet-12345678') do
+      its('cidr_blocks') { should eq ['10.0.1.0/24'] }
+    end
+
+<br>
+
+## Properties
+
+* `cidr_blocks`,  `states`, `subnet_ids`,`vpc_ids`
+
+<br>
+
+## Property Examples
+
+### cidr\_blocks
+
+Provides a string that contains the cidr block of ip addresses that can be given in the subnet.
+
+    # Examine a specific subnets cidr_blocks
+    describe aws_subnets.where( subnet_id: 'subnet-12345678') do
+      its('cidr_blocks') { should eq ['10.0.1.0/24'] }
+    end
+
+### states
+
+Provides an array of strings including if the subnets are available.
+
+    # Examine a specific vpcs Subnet IDs
+    describe aws_subnets.where( vpc_id: 'vpc-12345678') do
+      its('states') { should_not include 'pending' }
+    end
+
+### subnet\_ids
+
+Provides an array of strings containing the subnet IDs associated with a vpc.
+
+    # Examine a specific vpcs Subnet IDs
+    describe aws_subnets.where( vpc_id: 'vpc-12345678') do
+      its('subnet_ids') { should include 'subnet-12345678' }
+      its('subnet_ids') { should include 'subnet-98765432' }
+    end
+
+### vpc\_ids
+
+Provides an array containing a string of the vpc_id associated with a subnet.
+
+    # Examine a specific subnets VPC IDS
+    describe aws_subnets.where( subnet_id: 'subnet-12345678') do
+      its('vpc_ids') { should include 'vpc-12345678' }
+    end
+
+<br>
+
+## 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 dont always have subnets, so you can test if there are any.
+    describe aws_subnets
+      it { should exist }
+    end
+
+    # Test that there are subnets in a vpc
+    describe aws_subnets.where(vpc_id: 'vpc-12345678')
+      it { should exist }
+    end