inspec 2.1.0 → 2.1.10

data/docs/resources/aws_config_recorder.md.erb

@@ -1,71 +1,71 @@
----
-title: About the aws_config_recorder Resource
----
-
-# aws\_config\_recorder
-
-Use the `aws_config_recorder` InSpec audit resource to test properties of your AWS Config Service.
-
-The AWS Config service can monitor and record changes to your AWS resource configurations.  The Aws Config Recorder is used to detect changes in resource configurations and capture these changes as configuration items.
-
-<br>
-
-## Syntax
-
-An `aws_config_recorder` resource block declares the tests for a single AWS configuration recorder.
-
-    describe aws_config_recorder('my_recorder') do
-      it { should exist }
-    end
-
-    describe aws_config_recorder(recorder_name: 'my-recorder') do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if the recorder is active and recording.
-
-    describe aws_config_recorder(recorder_name: 'my-recorder') do
-      it { should be_recording }
-    end
-    
-## Properties
-
-### role\_arn
-
-Provides the IAM role arn associated with the configuration recorder.  The role is used to grant permissions to S3 Buckets, SNS topics and to get configuration details for supported AWS resources.
-
-    describe aws_config_recorder(username: 'bob')
-      its('role_arn') { should eq 'arn:aws:iam::721741954427:role/My_Recorder' }
-    end
-    
-### resource\_types
-
-Provides a list of AWS resource types for which the AWS Config records configuration will change. Note that if be_recording_all_resource_types is true than this property is meaningless and will return and empty array.
-
-    describe aws_config_recorder(username: 'bob')
-      its('resource_types') { should include 'AWS::EC2::CustomerGateway' }
-      its('resource_types') { should include 'AWS::EC2::EIP' }
-    end
-    
-<br>
-
-## Matchers
-
-### be\_recording\_all\_resource\_types
-
-Indicates if the ConfigurationRecorder will record changes for all resources, regardless of type. If this is true, resource_types is ignored.
-
-      it { should be_all_supported }
-      
-### be\_recording\_all\_global\_types
-
-Indicates whether the ConfigurationRecorder will record changes for global resource types (such as IAM Users).
-
-      it { should be_recording_all_global_types }
-
+---
+title: About the aws_config_recorder Resource
+---
+
+# aws\_config\_recorder
+
+Use the `aws_config_recorder` InSpec audit resource to test properties of your AWS Config Service.
+
+The AWS Config service can monitor and record changes to your AWS resource configurations.  The Aws Config Recorder is used to detect changes in resource configurations and capture these changes as configuration items.
+
+<br>
+
+## Syntax
+
+An `aws_config_recorder` resource block declares the tests for a single AWS configuration recorder.
+
+    describe aws_config_recorder('my_recorder') do
+      it { should exist }
+    end
+
+    describe aws_config_recorder(recorder_name: 'my-recorder') do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test if the recorder is active and recording.
+
+    describe aws_config_recorder(recorder_name: 'my-recorder') do
+      it { should be_recording }
+    end
+    
+## Properties
+
+### role\_arn
+
+Provides the IAM role arn associated with the configuration recorder.  The role is used to grant permissions to S3 Buckets, SNS topics and to get configuration details for supported AWS resources.
+
+    describe aws_config_recorder(username: 'bob')
+      its('role_arn') { should eq 'arn:aws:iam::721741954427:role/My_Recorder' }
+    end
+    
+### resource\_types
+
+Provides a list of AWS resource types for which the AWS Config records configuration will change. Note that if be_recording_all_resource_types is true than this property is meaningless and will return and empty array.
+
+    describe aws_config_recorder(username: 'bob')
+      its('resource_types') { should include 'AWS::EC2::CustomerGateway' }
+      its('resource_types') { should include 'AWS::EC2::EIP' }
+    end
+    
+<br>
+
+## Matchers
+
+### be\_recording\_all\_resource\_types
+
+Indicates if the ConfigurationRecorder will record changes for all resources, regardless of type. If this is true, resource_types is ignored.
+
+      it { should be_all_supported }
+      
+### be\_recording\_all\_global\_types
+
+Indicates whether the ConfigurationRecorder will record changes for global resource types (such as IAM Users).
+
+      it { should be_recording_all_global_types }
+

data/docs/resources/aws_ec2_instance.md.erb

@@ -1,106 +1,106 @@
----
-title: About the aws_ec2_instance Resource
-platform: aws
----
-
-# aws\_ec2\_instance
-
-Use the `aws_ec2_instance` InSpec audit resource to test properties of a single AWS EC2 instance.
-
-<br>
-
-## Syntax
-
-An `aws_ec2_instance` resource block declares the tests for a single AWS EC2 instance by either name or id.
-
-    describe aws_ec2_instance('i-01a2349e94458a507') do
-      it { should exist }
-    end
-
-    describe aws_ec2_instance(name: 'my-instance') do
-      it { should be_running }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that an EC2 instance does not exist
-
-    describe aws_ec2_instance(name: 'dev-server') do
-      it { should_not exist }
-    end
-
-### Test that an EC2 instance is running
-
-    describe aws_ec2_instance(name: 'prod-database') do
-      it { should be_running }
-    end
-
-### Test that an EC2 instance is using the correct image ID
-
-    describe aws_ec2_instance(name: 'my-instance') do
-      its('image_id') { should eq 'ami-27a58d5c' }
-    end
-
-### Test that an EC2 instance has the correct tag
-
-    describe aws_ec2_instance('i-090c29e4f4c165b74') do
-      its('tags') { should include(key: 'Contact', value: 'Gilfoyle') }
-    end
-
-<br>
-
-## Properties
-
-* `architecture`, `client_token`, `image_id`,`instance_type`, `key_name`, `launch_time`,`private_ip_address`,  `private_dns_name`, `public_dns_name`, `public_ip_address`,  `root_device_type`, `root_device_name`, `security_group_ids`, `subnet_id`, `tags`,`virtualization_type`, `vpc_id`
-
-<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/).
-
-### be\_pending
-
-The `be_pending` matcher tests if the described EC2 instance state is `pending`. This indicates that an instance is provisioning. This state should be temporary.
-
-    it { should be_pending }
-
-### be\_running
-
-The `be_running` matcher tests if the described EC2 instance state is `running`. This indicates the instance is fully operational from AWS's perspective.
-
-    it { should be_running }
-
-### be\_shutting\_down
-
-The `be_shutting_down` matcher tests if the described EC2 instance state is `shutting-down`. This indicates the instance has received a termination command and is in the process of being permanently halted and de-provisioned. This state should be temporary.
-
-    it { should be_shutting_down }
-
-### be\_stopped
-
-The `be_stopped` matcher tests if the described EC2 instance state is `stopped`. This indicates that the instance is suspended and may be started again.
-
-    it { should be_stopped }
-
-### be\_stopping
-
-The `be_stopping` matcher tests if the described EC2 instance state is `stopping`. This indicates that an AWS stop command has been issued, which will suspend the instance in an OS-unaware manner. This state should be temporary.
-
-    it { should be_stopping }
-
-### be\_terminated
-
-The `be_terminated` matcher tests if the described EC2 instance state is `terminated`. This indicates the instance is permanently halted and will be removed from the instance listing in a short period. This state should be temporary.
-
-    it { should be_terminated }
-
-### be\_unknown
-
-The `be_unknown` matcher tests if the described EC2 instance state is `unknown`. This indicates an error condition in the AWS management system. This state should be temporary.
-
-    it { should be_unknown }
+---
+title: About the aws_ec2_instance Resource
+platform: aws
+---
+
+# aws\_ec2\_instance
+
+Use the `aws_ec2_instance` InSpec audit resource to test properties of a single AWS EC2 instance.
+
+<br>
+
+## Syntax
+
+An `aws_ec2_instance` resource block declares the tests for a single AWS EC2 instance by either name or id.
+
+    describe aws_ec2_instance('i-01a2349e94458a507') do
+      it { should exist }
+    end
+
+    describe aws_ec2_instance(name: 'my-instance') do
+      it { should be_running }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that an EC2 instance does not exist
+
+    describe aws_ec2_instance(name: 'dev-server') do
+      it { should_not exist }
+    end
+
+### Test that an EC2 instance is running
+
+    describe aws_ec2_instance(name: 'prod-database') do
+      it { should be_running }
+    end
+
+### Test that an EC2 instance is using the correct image ID
+
+    describe aws_ec2_instance(name: 'my-instance') do
+      its('image_id') { should eq 'ami-27a58d5c' }
+    end
+
+### Test that an EC2 instance has the correct tag
+
+    describe aws_ec2_instance('i-090c29e4f4c165b74') do
+      its('tags') { should include(key: 'Contact', value: 'Gilfoyle') }
+    end
+
+<br>
+
+## Properties
+
+* `architecture`, `client_token`, `image_id`,`instance_type`, `key_name`, `launch_time`,`private_ip_address`,  `private_dns_name`, `public_dns_name`, `public_ip_address`,  `root_device_type`, `root_device_name`, `security_group_ids`, `subnet_id`, `tags`,`virtualization_type`, `vpc_id`
+
+<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/).
+
+### be\_pending
+
+The `be_pending` matcher tests if the described EC2 instance state is `pending`. This indicates that an instance is provisioning. This state should be temporary.
+
+    it { should be_pending }
+
+### be\_running
+
+The `be_running` matcher tests if the described EC2 instance state is `running`. This indicates the instance is fully operational from AWS's perspective.
+
+    it { should be_running }
+
+### be\_shutting\_down
+
+The `be_shutting_down` matcher tests if the described EC2 instance state is `shutting-down`. This indicates the instance has received a termination command and is in the process of being permanently halted and de-provisioned. This state should be temporary.
+
+    it { should be_shutting_down }
+
+### be\_stopped
+
+The `be_stopped` matcher tests if the described EC2 instance state is `stopped`. This indicates that the instance is suspended and may be started again.
+
+    it { should be_stopped }
+
+### be\_stopping
+
+The `be_stopping` matcher tests if the described EC2 instance state is `stopping`. This indicates that an AWS stop command has been issued, which will suspend the instance in an OS-unaware manner. This state should be temporary.
+
+    it { should be_stopping }
+
+### be\_terminated
+
+The `be_terminated` matcher tests if the described EC2 instance state is `terminated`. This indicates the instance is permanently halted and will be removed from the instance listing in a short period. This state should be temporary.
+
+    it { should be_terminated }
+
+### be\_unknown
+
+The `be_unknown` matcher tests if the described EC2 instance state is `unknown`. This indicates an error condition in the AWS management system. This state should be temporary.
+
+    it { should be_unknown }

data/docs/resources/aws_iam_access_key.md.erb

@@ -1,123 +1,123 @@
----
-title: About the aws_iam_access_key Resource
-platform: aws
----
-
-# aws\_iam\_access\_key
-
-Use the `aws_iam_access_key` InSpec audit resource to test properties of a single AWS IAM access key.
-
-<br>
-
-## Syntax
-
-An `aws_iam_access_key` resource block declares the tests for a single AWS IAM access key. An access key is uniquely identified by its access key id. 
-
-    # This is unique - the key will either exist or it won't, but it will never be an error.
-    describe aws_iam_access_key(access_key_id: 'AKIA12345678ABCD') do
-      it { should exist }
-      it { should_not be_active }
-      its('create_date') { should be > Time.now - 365 * 86400 }
-      its('last_used_date') { should be > Time.now - 90 * 86400 }
-    end
-
-    # id is an alias for access_key_id
-    describe aws_iam_access_key(id: 'AKIA12345678ABCD') do
-      # Same
-    end
-    
-
-Access keys are associated with IAM users, who may have zero, one or two access keys. You may also lookup an access key by username. If the user has more than one access key, an error occurs (You may use `aws_iam_access_keys` with the `username` resource parameter to access a user's keys when they have multiple keys.)
-
-    # This is not unique. If the user has zero or one keys, it is not an error.
-    # If they have two, it is an error.
-    describe aws_iam_access_key(username: 'roderick') do
-      it { should exist }
-      it { should be_active }
-    end
-
-You may also use both username and access key id to ensure that a particular key is associated with a particular user.
-
-    describe aws_iam_access_key(username: 'roderick', access_key_id: 'AKIA12345678ABCD') do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that an IAM access key is not active
-
-    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
-      it { should_not be_active }
-    end
-
-### Test that an IAM access key is older than one year
-
-    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
-      its('create_date') { should be > Time.now - 365 * 86400 }
-    end
-
-### Test that an IAM access key has been used in the past 90 days
-
-    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
-      its('last_used_date') { should be > Time.now - 90 * 86400 }
-    end
-
-<br>
-
-## Properties
-
-* `access_key_id`, `create_date`, `last_used_date`, `username`
-
-<br>
-
-## Property Examples
-
-### access\_key\_id
-
-The unique ID of this access key.
-
-    describe aws_iam_access_key(username: 'bob')
-      its('access_key_id') { should cmp 'AKIA12345678ABCD' }
-    end
-
-### create\_date
-
-The date and time, as a Ruby DateTime, at which the access key was created.
-
-    # Is the access key less than a year old?
-    describe aws_iam_access_key(username: 'bob')
-      its('create_date') { should be > Time.now - 365 * 86400 }
-    end
-
-### last\_used\_date
-
-The date and time, as a Ruby DateTime, at which the access key was last_used.
-
-    # Has the access key been used in the last year?
-    describe aws_iam_access_key(username: 'bob')
-      its('last_used_date') { should be > Time.now - 365 * 86400 }
-    end
-
-### username
-
-The IAM user that owns this key.
-
-    describe aws_iam_access_key(access_key_id: 'AKIA12345678ABCD')
-      its('username') { should cmp 'bob' }
-    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/).
-
-### be\_active
-
-The `be_active` matcher tests if the described IAM access key is active.
-
-    it { should be_active }
+---
+title: About the aws_iam_access_key Resource
+platform: aws
+---
+
+# aws\_iam\_access\_key
+
+Use the `aws_iam_access_key` InSpec audit resource to test properties of a single AWS IAM access key.
+
+<br>
+
+## Syntax
+
+An `aws_iam_access_key` resource block declares the tests for a single AWS IAM access key. An access key is uniquely identified by its access key id. 
+
+    # This is unique - the key will either exist or it won't, but it will never be an error.
+    describe aws_iam_access_key(access_key_id: 'AKIA12345678ABCD') do
+      it { should exist }
+      it { should_not be_active }
+      its('create_date') { should be > Time.now - 365 * 86400 }
+      its('last_used_date') { should be > Time.now - 90 * 86400 }
+    end
+
+    # id is an alias for access_key_id
+    describe aws_iam_access_key(id: 'AKIA12345678ABCD') do
+      # Same
+    end
+    
+
+Access keys are associated with IAM users, who may have zero, one or two access keys. You may also lookup an access key by username. If the user has more than one access key, an error occurs (You may use `aws_iam_access_keys` with the `username` resource parameter to access a user's keys when they have multiple keys.)
+
+    # This is not unique. If the user has zero or one keys, it is not an error.
+    # If they have two, it is an error.
+    describe aws_iam_access_key(username: 'roderick') do
+      it { should exist }
+      it { should be_active }
+    end
+
+You may also use both username and access key id to ensure that a particular key is associated with a particular user.
+
+    describe aws_iam_access_key(username: 'roderick', access_key_id: 'AKIA12345678ABCD') do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that an IAM access key is not active
+
+    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
+      it { should_not be_active }
+    end
+
+### Test that an IAM access key is older than one year
+
+    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
+      its('create_date') { should be > Time.now - 365 * 86400 }
+    end
+
+### Test that an IAM access key has been used in the past 90 days
+
+    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
+      its('last_used_date') { should be > Time.now - 90 * 86400 }
+    end
+
+<br>
+
+## Properties
+
+* `access_key_id`, `create_date`, `last_used_date`, `username`
+
+<br>
+
+## Property Examples
+
+### access\_key\_id
+
+The unique ID of this access key.
+
+    describe aws_iam_access_key(username: 'bob')
+      its('access_key_id') { should cmp 'AKIA12345678ABCD' }
+    end
+
+### create\_date
+
+The date and time, as a Ruby DateTime, at which the access key was created.
+
+    # Is the access key less than a year old?
+    describe aws_iam_access_key(username: 'bob')
+      its('create_date') { should be > Time.now - 365 * 86400 }
+    end
+
+### last\_used\_date
+
+The date and time, as a Ruby DateTime, at which the access key was last_used.
+
+    # Has the access key been used in the last year?
+    describe aws_iam_access_key(username: 'bob')
+      its('last_used_date') { should be > Time.now - 365 * 86400 }
+    end
+
+### username
+
+The IAM user that owns this key.
+
+    describe aws_iam_access_key(access_key_id: 'AKIA12345678ABCD')
+      its('username') { should cmp 'bob' }
+    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/).
+
+### be\_active
+
+The `be_active` matcher tests if the described IAM access key is active.
+
+    it { should be_active }