Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-14 00:47:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

MFixes some minor docs formatting problems

Browse source 
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
This commit is contained in:
Ian Maddaus 2021-11-22 11:19:07 -05:00
parent f686733235
commit 2424fa19c1
13 changed files with 37 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs-chef-io/content/inspec/resources/aws_cloudformation_stack.md
View file

@ -38,28 +38,28 @@ See also the [AWS documentation on Cloud Formation](https://docs.aws.amazon.com/
|Property | Description|
| --- | --- |
|stack\_id | Unique identifier of the stack. |
|stack\_name | The name associated with the stack. |
|change\_set\_id | The unique ID of the change set. |
|stack_id | Unique identifier of the stack. |
|stack_name | The name associated with the stack. |
|change_set_id | The unique ID of the change set. |
|description | A user-defined description associated with the stack. |
|parameters | A list of Parameter structures. |
|creation\_time | The time at which the stack was created. |
|deletion\_time | The time the stack was deleted. |
|last\_updated\_time | The time the stack was last updated. |
|rollback\_configuration | The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. |
|stack\_status | Current status of the stack. |
|stack\_status\_reason | Success/failure message associated with the stack status. |
|drift\_information | Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. |
|disable\_rollback | Boolean to enable or disable rollback on stack creation failures: |
|notification\_arns | SNS topic ARNs to which stack related events are published. |
|timeout\_in\_minutes | The amount of time within which stack creation should complete. |
|creation_time | The time at which the stack was created. |
|deletion_time | The time the stack was deleted. |
|last_updated_time | The time the stack was last updated. |
|rollback_configuration | The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards. |
|stack_status | Current status of the stack. |
|stack_status_reason | Success/failure message associated with the stack status. |
|drift_information | Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. |
|disable_rollback | Boolean to enable or disable rollback on stack creation failures: |
|notification_arns | SNS topic ARNs to which stack related events are published. |
|timeout_in_minutes | The amount of time within which stack creation should complete. |
|capabilities | The capabilities allowed in the stack. |
|outputs | A list of output structures. |
|role\_arn | The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. |
|role_arn | The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. |
|tags | A list of Tags that specify information about the stack. |
|enable\_termination\_protection | Whether termination protection is enabled for the stack. |
|parent\_id | For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. |
|root\_id | For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. |
|enable_termination_protection | Whether termination protection is enabled for the stack. |
|parent_id | For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. |
|root_id | For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs. |
## Examples

14
docs-chef-io/content/inspec/resources/aws_cloudtrail_trail.md
View file

@ -40,13 +40,13 @@ See also the [AWS documentation on CloudTrail](https://docs.aws.amazon.com/cloud
|Property | Description|
| --- | --- |
|trail\_arn | Specifies the ARN of the trail. |
|trail\_name | Name of the trail. |
|home\_region | The region in which the trail was created. |
|s3\_bucket\_name | Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. |
|cloud\_watch\_logs\_role\_arn | Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. |
|cloud\_watch\_logs\_log\_group\_arn | Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. |
|kms\_key\_id | Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. |
|trail_arn | Specifies the ARN of the trail. |
|trail_name | Name of the trail. |
|home_region | The region in which the trail was created. |
|s3_bucket_name | Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. |
|cloud_watch_logs_role_arn | Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. |
|cloud_watch_logs_log_group_arn | Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. |
|kms_key_id | Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. |
## Examples

4
docs-chef-io/content/inspec/resources/aws_cloudwatch_log_metric_filter.md
View file

@ -27,11 +27,11 @@ Use the `aws_cloudwatch_log_metric_filter` InSpec audit resource to search for a
**Note**: _While all parameters are optional, at least one must be provided. In practice, the more parameters you provide the narrower a result you will return._
### filter*name *(optional)\_
### filter_name _(optional)_
The name of the Log Metric Filter. Expected in a hash as `filter_name: 'value'`.
### log*group_name *(optional)\_
### log_group_name _(optional)_
The log group of the filter. Expected in a hash as `log_group_name: 'value'`.

2
docs-chef-io/content/inspec/resources/aws_ecr.md
View file

@ -37,7 +37,7 @@ An `aws_ecr` resource block declares the tests for a single AWS ECR by repositor
The ECR repository_name must be provided.
### repository*name *(required)\_
### repository_name _(required)_
The name of the repository
This can be passed either as a string or as an `repository_name: 'value'` key-value entry in a hash.

2
docs-chef-io/content/inspec/resources/aws_efs_file_system.md
View file

@ -44,7 +44,7 @@ Either the EFS file system id or creation token must be provided.
The ID of the EFS file system. This is in the format of `fs-` followed by 8 or 17 hexadecimal characters.
This can be passed either as a string or as a `file_system_id: 'value'` key-value entry in a hash.
### creation*token *(required if `file_system_id` not provided)\_
### creation_token _(required if `file_system_id` not provided)_
The creation token is automatically assigned by AWS if not provided by the user at creation.
This is a string with minimum 1 and maximum 64-character long.

2
docs-chef-io/content/inspec/resources/aws_iam_access_key.md
View file

@ -30,7 +30,7 @@ This resources requires either an `access_key_id` or the IAM `username` associat
The Access Key ID which uniquely identifies the Key. Begins with the characters "AKIA".
This can be passed either as a string or as a `access_key_id: 'value'` key-value entry in a hash.
### username _(required if `access_key\_id` not provided.)_
### username _(required if `access_key_id` not provided.)_
The IAM Username which is associated with the Access Key.
This can be passed either as a string or as a `username: 'value'` key-value entry in a hash.

2
docs-chef-io/content/inspec/resources/aws_rds_clusters.md
View file

@ -36,7 +36,7 @@ See also the [AWS documentation on RDS](https://docs.aws.amazon.com/rds/?id=docs
| ------------------ | ------------------------------------------------------------------------------------- |
| cluster_identifier | The unique IDs of the RDS clusters returned. |
| database_name | The name of the database associated with each RDS cluster. |
| cluster\_\members | The RDS instances attached to each RDS cluster. |
| cluster_members | The RDS instances attached to each RDS cluster. |
| engine | The name of the database engine used by each cluster. |
| engine_version | The version of the database engine used by each cluster. |
| status | The current status of each cluster. |

2
docs-chef-io/content/inspec/resources/aws_ssm_parameter.md
View file

@ -28,7 +28,7 @@ An `aws_ssm_parameter` resource block uses the parameter to select a ssm paramet
This resource accepts a single parameter, the SSM Parameter Name.
This can be passed either as a string or as a `aws_ssm_parameter: 'value'` key-value entry in a hash.
### with*decryption *(optional)\_
### with_decryption _(optional)_
This decrypts the value associated with the ssm parameter. This must be passed as a string `with_decryption: "true"`.

2
docs-chef-io/content/inspec/resources/aws_transit_gateway.md
View file

@ -23,7 +23,7 @@ An `aws_transit_gateway` resource block uses the parameter to select a transit g
## Parameters
### transit*gateway_id *(required)\_
### transit_gateway_id _(required)_
This resource accepts a single parameter, the Transit Gateway ID.
This can be passed either as a string or as a `transit_gateway_id: 'value'` key-value entry in a hash.

2
docs-chef-io/content/inspec/resources/azurerm_subnets.md
View file

@ -11,7 +11,7 @@ platform = "azure"
parent = "inspec/resources/azure"
+++
Use the `azurerm\_subnets` InSpec audit resource to test properties related to
Use the `azurerm_subnets` InSpec audit resource to test properties related to
subnets for a resource group.
## Azure REST API version

4
docs-chef-io/content/inspec/resources/google_bigquery_dataset.md
View file

@ -83,7 +83,7 @@ Properties that can be accessed from the `google_bigquery_dataset` resource:
: The ID of the project containing this table.
`table_id`
: The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (\_). The maximum length is 1,024 characters.
: The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`creation_time`
: The time when this dataset was created, in milliseconds since the epoch.
@ -92,7 +92,7 @@ Properties that can be accessed from the `google_bigquery_dataset` resource:
: A reference that identifies the dataset.
`dataset_id`
: A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (\_). The maximum length is 1,024 characters.
: A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
`project_id`
: The ID of the project containing this dataset.

2
docs-chef-io/content/inspec/resources/interface.md
View file

@ -114,7 +114,7 @@ The `exist` matcher tests if the network interface exists:
it { should exist }
### have\_an\_ipv4\_address
### have_an_ipv4_address
The `have_an_ipv4_address` matcher tests if the network interface has any IPv4 addresses assigned:

2
docs-chef-io/content/inspec/resources/oneget.md
View file

@ -11,7 +11,7 @@ platform = "windows"
parent = "inspec/resources/os"
+++
Use the `oneget` Chef InSpec audit resource to test if the named package and/or package version is installed on the system. This resource uses Oneget, which is `part of the Windows Management Framework 5.0 and Windows 10 <https://github.com/OneGet/oneget>`\_\_. This resource uses the `Get-Package` cmdlet to return all of the package names in the Oneget repository.
Use the `oneget` Chef InSpec audit resource to test if the named package and/or package version is installed on the system. This resource uses Oneget, which is `part of the Windows Management Framework 5.0 and Windows 10 <https://github.com/OneGet/oneget>`. This resource uses the `Get-Package` cmdlet to return all of the package names in the Oneget repository.
## Availability