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

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

A rule that controls network traffic during penetration testing by allowing or denying traffic to specific URL patterns.

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

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

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

```
{
  "[Effect](#cfn-securityagent-pentest-networktrafficrule-effect)" : {{String}},
  "[NetworkTrafficRuleType](#cfn-securityagent-pentest-networktrafficrule-networktrafficruletype)" : {{String}},
  "[Pattern](#cfn-securityagent-pentest-networktrafficrule-pattern)" : {{String}}
}
```

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

```
  [Effect](#cfn-securityagent-pentest-networktrafficrule-effect): {{String}}
  [NetworkTrafficRuleType](#cfn-securityagent-pentest-networktrafficrule-networktrafficruletype): {{String}}
  [Pattern](#cfn-securityagent-pentest-networktrafficrule-pattern): {{String}}
```

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

`Effect`  <a name="cfn-securityagent-pentest-networktrafficrule-effect"></a>
The effect of the rule. Valid values are ALLOW and DENY.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALLOW | DENY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkTrafficRuleType`  <a name="cfn-securityagent-pentest-networktrafficrule-networktrafficruletype"></a>
The type of the network traffic rule. Currently, only URL is supported.  
*Required*: No  
*Type*: String  
*Allowed values*: `URL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Pattern`  <a name="cfn-securityagent-pentest-networktrafficrule-pattern"></a>
The URL pattern to match for the rule.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)