inspec 2.1.81 → 2.1.83

data/docs/resources/aws_config_delivery_channel.md.erb

@@ -1,101 +1,101 @@
----
-title: About the aws_config_delivery_channel Resource
----
-
-# aws_config_delivery_channel
-
-The AWS Config service can monitor and record changes to your AWS resource configurations. A Delivery Channel can record the changes
-to an S3 Bucket, an SNS or both.
-
-Use the `aws_config_delivery_channel` InSpec audit resource to examine how the AWS Config service delivers those change notifications.
-
-As of April 2018, each AWS region may have only one Delivery Channel.
-
-<br>
-
-## Resource Parameters
-
-An `aws_config_delivery_channel` resource block declares the tests for a single AWS Config Delivery Channel.
-
-You may specify the Delivery Channel name:
-
-    describe aws_config_delivery_channel('my_channel') do
-      it { should exist }
-    end
-
-    describe aws_config_delivery_channel(channel_name: 'my-channel') do
-      it { should exist }
-    end
-
-However, since you may only have one Delivery Channel per region, and InSpec connections are per-region, you may also omit the `channel_name` to obtain the one Delivery Channel (if any) that exists:
-
-    describe aws_config_delivery_channel do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test how frequently the channel writes configuration changes to the s3 bucket.
-
-    describe aws_config_delivery_channel(channel_name: 'my-recorder') do
-      its(delivery_frequency_in_hours) { should be > 3 }
-    end
-
-## Properties
-
-### channel\_name
-
-Returns the name of the Delivery Channel.
-
-    describe aws_config_delivery_channel do
-      its('channel_name') { should cmp 'my-channel' }
-    end
-
-### delivery\_frequency\_in\_hours
-
-Provides how often the AWS Config sends configuration changes to the s3 bucket in the delivery channel.
-
-    describe aws_config_delivery_channel(channel_name: 'my_channel')
-      its('delivery_frequency_in_hours') { should eq 24 }
-      its('delivery_frequency_in_hours') { should be > 24 }
-    end
-
-### s3\_bucket\_name
-
-Provides the name of the s3 bucket that the channel sends configuration changes to. This is an optional value since a Delivery Channel can also talk to an SNS.
-
-    describe aws_config_delivery_channel(channel_name: 'my_channel')
-      its('s3_bucket_name') { should eq 'my_bucket' }
-    end
-
-### s3\_key\_prefix
-
-Provides the s3 object key prefix (or "path") under which configuration data will be recorded.
-
-    describe aws_config_delivery_channel(channel_name: 'my_channel')
-      its('s3_key_prefix') { should eq 'log/' }
-    end
-
-### sns\_topic\_arn
-
-Provides the ARN of the SNS topic for which the channel sends notifications about configuration changes.
-
-    describe aws_config_delivery_channel(channel_name: 'my_channel')
-      its('sns_topic_arn') { should eq 'arn:aws:sns:us-east-1:721741954427:sns_topic' }
-    end
-
-<br>
-
-## Matchers
-
-This resource provides no matchers, aside from the standard `exist` matcher.
-
-## AWS Permissions
-
-Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `config:DescribeDeliveryChannels` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS Config](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awsconfig.html).
+---
+title: About the aws_config_delivery_channel Resource
+---
+
+# aws_config_delivery_channel
+
+The AWS Config service can monitor and record changes to your AWS resource configurations. A Delivery Channel can record the changes
+to an S3 Bucket, an SNS or both.
+
+Use the `aws_config_delivery_channel` InSpec audit resource to examine how the AWS Config service delivers those change notifications.
+
+As of April 2018, each AWS region may have only one Delivery Channel.
+
+<br>
+
+## Resource Parameters
+
+An `aws_config_delivery_channel` resource block declares the tests for a single AWS Config Delivery Channel.
+
+You may specify the Delivery Channel name:
+
+    describe aws_config_delivery_channel('my_channel') do
+      it { should exist }
+    end
+
+    describe aws_config_delivery_channel(channel_name: 'my-channel') do
+      it { should exist }
+    end
+
+However, since you may only have one Delivery Channel per region, and InSpec connections are per-region, you may also omit the `channel_name` to obtain the one Delivery Channel (if any) that exists:
+
+    describe aws_config_delivery_channel do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test how frequently the channel writes configuration changes to the s3 bucket.
+
+    describe aws_config_delivery_channel(channel_name: 'my-recorder') do
+      its(delivery_frequency_in_hours) { should be > 3 }
+    end
+
+## Properties
+
+### channel\_name
+
+Returns the name of the Delivery Channel.
+
+    describe aws_config_delivery_channel do
+      its('channel_name') { should cmp 'my-channel' }
+    end
+
+### delivery\_frequency\_in\_hours
+
+Provides how often the AWS Config sends configuration changes to the s3 bucket in the delivery channel.
+
+    describe aws_config_delivery_channel(channel_name: 'my_channel')
+      its('delivery_frequency_in_hours') { should eq 24 }
+      its('delivery_frequency_in_hours') { should be > 24 }
+    end
+
+### s3\_bucket\_name
+
+Provides the name of the s3 bucket that the channel sends configuration changes to. This is an optional value since a Delivery Channel can also talk to an SNS.
+
+    describe aws_config_delivery_channel(channel_name: 'my_channel')
+      its('s3_bucket_name') { should eq 'my_bucket' }
+    end
+
+### s3\_key\_prefix
+
+Provides the s3 object key prefix (or "path") under which configuration data will be recorded.
+
+    describe aws_config_delivery_channel(channel_name: 'my_channel')
+      its('s3_key_prefix') { should eq 'log/' }
+    end
+
+### sns\_topic\_arn
+
+Provides the ARN of the SNS topic for which the channel sends notifications about configuration changes.
+
+    describe aws_config_delivery_channel(channel_name: 'my_channel')
+      its('sns_topic_arn') { should eq 'arn:aws:sns:us-east-1:721741954427:sns_topic' }
+    end
+
+<br>
+
+## Matchers
+
+This resource provides no matchers, aside from the standard `exist` matcher.
+
+## AWS Permissions
+
+Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `config:DescribeDeliveryChannels` action with Effect set to Allow.
+
+You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS Config](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awsconfig.html).

data/docs/resources/aws_config_recorder.md.erb

@@ -1,86 +1,86 @@
----
-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.
-
-As of April 2018, you are only permitted one configuration recorder per region.
-
-<br>
-
-## Resource Parameters
-
-An `aws_config_recorder` resource block declares the tests for a single AWS configuration recorder.
-
-You may specify a recorder by name:
-
-    describe aws_config_recorder('my_recorder') do
-      it { should exist }
-    end
-
-    describe aws_config_recorder(recorder_name: 'my-recorder') do
-      it { should exist }
-    end
-
-However, since you may only have one recorder per region, and InSpec connections are per-region, you may also omit the `recorder_name` to obtain the one recorder (if any) that exists:
-
-    describe aws_config_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_recording_all_resource_types }
-
-### be\_recording\_all\_global\_types
-
-Indicates whether the ConfigurationRecorder will record changes for global resource types (such as [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal)s).
-
-      it { should be_recording_all_global_types }
-
-## AWS Permissions
-
-Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `config:DescribeConfigurationRecorders` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS Config](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awsconfig.html).
+---
+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.
+
+As of April 2018, you are only permitted one configuration recorder per region.
+
+<br>
+
+## Resource Parameters
+
+An `aws_config_recorder` resource block declares the tests for a single AWS configuration recorder.
+
+You may specify a recorder by name:
+
+    describe aws_config_recorder('my_recorder') do
+      it { should exist }
+    end
+
+    describe aws_config_recorder(recorder_name: 'my-recorder') do
+      it { should exist }
+    end
+
+However, since you may only have one recorder per region, and InSpec connections are per-region, you may also omit the `recorder_name` to obtain the one recorder (if any) that exists:
+
+    describe aws_config_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_recording_all_resource_types }
+
+### be\_recording\_all\_global\_types
+
+Indicates whether the ConfigurationRecorder will record changes for global resource types (such as [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal)s).
+
+      it { should be_recording_all_global_types }
+
+## AWS Permissions
+
+Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `config:DescribeConfigurationRecorders` action with Effect set to Allow.
+
+You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS Config](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awsconfig.html).

data/docs/resources/aws_ec2_instance.md.erb

@@ -1,112 +1,112 @@
----
-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 }
-
-## AWS Permissions
-
-Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `ec2:DescribeInstances`, and `iam:GetInstanceProfile` actions 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), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html).
+---
+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 }
+
+## AWS Permissions
+
+Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `ec2:DescribeInstances`, and `iam:GetInstanceProfile` actions 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), and [Actions, Resources, and Condition Keys for Identity And Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_identityandaccessmanagement.html).