

This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SecurityAgent::Pentest ReportFilters
<a name="aws-properties-securityagent-pentest-reportfilters"></a>

The report-generation filters applied when a pentest or code review report is exported.

## Syntax
<a name="aws-properties-securityagent-pentest-reportfilters-syntax"></a>

To declare this entity in your Amazon CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-securityagent-pentest-reportfilters-syntax.json"></a>

```
{
  "[AnnotationNotes](#cfn-securityagent-pentest-reportfilters-annotationnotes)" : {{Boolean}},
  "[ComplianceReport](#cfn-securityagent-pentest-reportfilters-compliancereport)" : {{Boolean}},
  "[ConfidenceLevels](#cfn-securityagent-pentest-reportfilters-confidencelevels)" : {{[ String, ... ]}},
  "[FindingTypes](#cfn-securityagent-pentest-reportfilters-findingtypes)" : {{[ String, ... ]}},
  "[RiskLevels](#cfn-securityagent-pentest-reportfilters-risklevels)" : {{[ String, ... ]}},
  "[RiskTypes](#cfn-securityagent-pentest-reportfilters-risktypes)" : {{[ String, ... ]}},
  "[Statuses](#cfn-securityagent-pentest-reportfilters-statuses)" : {{[ String, ... ]}},
  "[TaskStatuses](#cfn-securityagent-pentest-reportfilters-taskstatuses)" : {{[ String, ... ]}}
}
```

### YAML
<a name="aws-properties-securityagent-pentest-reportfilters-syntax.yaml"></a>

```
  [AnnotationNotes](#cfn-securityagent-pentest-reportfilters-annotationnotes): {{Boolean}}
  [ComplianceReport](#cfn-securityagent-pentest-reportfilters-compliancereport): {{Boolean}}
  [ConfidenceLevels](#cfn-securityagent-pentest-reportfilters-confidencelevels): {{
    - String}}
  [FindingTypes](#cfn-securityagent-pentest-reportfilters-findingtypes): {{
    - String}}
  [RiskLevels](#cfn-securityagent-pentest-reportfilters-risklevels): {{
    - String}}
  [RiskTypes](#cfn-securityagent-pentest-reportfilters-risktypes): {{
    - String}}
  [Statuses](#cfn-securityagent-pentest-reportfilters-statuses): {{
    - String}}
  [TaskStatuses](#cfn-securityagent-pentest-reportfilters-taskstatuses): {{
    - String}}
```

## Properties
<a name="aws-properties-securityagent-pentest-reportfilters-properties"></a>

`AnnotationNotes`  <a name="cfn-securityagent-pentest-reportfilters-annotationnotes"></a>
Whether to include reviewer annotation notes under each finding.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ComplianceReport`  <a name="cfn-securityagent-pentest-reportfilters-compliancereport"></a>
Whether to include the compliance-ready report additions.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConfidenceLevels`  <a name="cfn-securityagent-pentest-reportfilters-confidencelevels"></a>
The confidence levels to include in the report.  
*Required*: No  
*Type*: Array of String  
*Allowed values*: `FALSE_POSITIVE | UNCONFIRMED | LOW | MEDIUM | HIGH`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FindingTypes`  <a name="cfn-securityagent-pentest-reportfilters-findingtypes"></a>
The finding types to include in the report.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RiskLevels`  <a name="cfn-securityagent-pentest-reportfilters-risklevels"></a>
The severity levels to include in the report.  
*Required*: No  
*Type*: Array of String  
*Allowed values*: `UNKNOWN | INFORMATIONAL | LOW | MEDIUM | HIGH | CRITICAL`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RiskTypes`  <a name="cfn-securityagent-pentest-reportfilters-risktypes"></a>
The risk types to include in the report.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Statuses`  <a name="cfn-securityagent-pentest-reportfilters-statuses"></a>
The finding statuses to include in the report.  
*Required*: No  
*Type*: Array of String  
*Allowed values*: `ACTIVE | RESOLVED | ACCEPTED | FALSE_POSITIVE`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TaskStatuses`  <a name="cfn-securityagent-pentest-reportfilters-taskstatuses"></a>
The task execution statuses to include in the report's task table.  
*Required*: No  
*Type*: Array of String  
*Allowed values*: `IN_PROGRESS | ABORTED | COMPLETED | INTERNAL_ERROR | FAILED`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)