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::EC2::NetworkInsightsPath
<a name="aws-resource-ec2-networkinsightspath"></a>

Specifies a path to analyze for reachability.

VPC Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the [Reachability Analyzer User Guide](https://docs.aws.amazon.com/vpc/latest/reachability/what-is-reachability-analyzer.html).

## Syntax
<a name="aws-resource-ec2-networkinsightspath-syntax"></a>

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

### JSON
<a name="aws-resource-ec2-networkinsightspath-syntax.json"></a>

```
{
  "Type" : "AWS::EC2::NetworkInsightsPath",
  "Properties" : {
      "[Destination](#cfn-ec2-networkinsightspath-destination)" : String,
      "[DestinationIp](#cfn-ec2-networkinsightspath-destinationip)" : String,
      "[DestinationPort](#cfn-ec2-networkinsightspath-destinationport)" : Integer,
      "[FilterAtDestination](#cfn-ec2-networkinsightspath-filteratdestination)" : PathFilter,
      "[FilterAtSource](#cfn-ec2-networkinsightspath-filteratsource)" : PathFilter,
      "[Protocol](#cfn-ec2-networkinsightspath-protocol)" : String,
      "[Source](#cfn-ec2-networkinsightspath-source)" : String,
      "[SourceIp](#cfn-ec2-networkinsightspath-sourceip)" : String,
      "[Tags](#cfn-ec2-networkinsightspath-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-ec2-networkinsightspath-syntax.yaml"></a>

```
Type: AWS::EC2::NetworkInsightsPath
Properties:
  [Destination](#cfn-ec2-networkinsightspath-destination): String
  [DestinationIp](#cfn-ec2-networkinsightspath-destinationip): String
  [DestinationPort](#cfn-ec2-networkinsightspath-destinationport): Integer
  [FilterAtDestination](#cfn-ec2-networkinsightspath-filteratdestination): 
    PathFilter
  [FilterAtSource](#cfn-ec2-networkinsightspath-filteratsource): 
    PathFilter
  [Protocol](#cfn-ec2-networkinsightspath-protocol): String
  [Source](#cfn-ec2-networkinsightspath-source): String
  [SourceIp](#cfn-ec2-networkinsightspath-sourceip): String
  [Tags](#cfn-ec2-networkinsightspath-tags): 
    - Tag
```

## Properties
<a name="aws-resource-ec2-networkinsightspath-properties"></a>

`Destination`  <a name="cfn-ec2-networkinsightspath-destination"></a>
The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DestinationIp`  <a name="cfn-ec2-networkinsightspath-destinationip"></a>
The IP address of the destination.  
*Required*: No  
*Type*: String  
*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`  
*Minimum*: `0`  
*Maximum*: `15`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DestinationPort`  <a name="cfn-ec2-networkinsightspath-destinationport"></a>
The destination port.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `65535`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FilterAtDestination`  <a name="cfn-ec2-networkinsightspath-filteratdestination"></a>
Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.  
*Required*: No  
*Type*: [PathFilter](aws-properties-ec2-networkinsightspath-pathfilter.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FilterAtSource`  <a name="cfn-ec2-networkinsightspath-filteratsource"></a>
Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.  
*Required*: No  
*Type*: [PathFilter](aws-properties-ec2-networkinsightspath-pathfilter.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Protocol`  <a name="cfn-ec2-networkinsightspath-protocol"></a>
The protocol.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `tcp | udp`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Source`  <a name="cfn-ec2-networkinsightspath-source"></a>
The ID or ARN of the source. If the resource is in another account, you must specify an ARN.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceIp`  <a name="cfn-ec2-networkinsightspath-sourceip"></a>
The IP address of the source.  
*Required*: No  
*Type*: String  
*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`  
*Minimum*: `0`  
*Maximum*: `15`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-ec2-networkinsightspath-tags"></a>
The tags to add to the path.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ec2-networkinsightspath-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-ec2-networkinsightspath-return-values"></a>

### Ref
<a name="aws-resource-ec2-networkinsightspath-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the path.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-ec2-networkinsightspath-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-ec2-networkinsightspath-return-values-fn--getatt-fn--getatt"></a>

`CreatedDate`  <a name="CreatedDate-fn::getatt"></a>
The time stamp when the path was created.

`DestinationArn`  <a name="DestinationArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the destination.

`NetworkInsightsPathArn`  <a name="NetworkInsightsPathArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the path.

`NetworkInsightsPathId`  <a name="NetworkInsightsPathId-fn::getatt"></a>
The ID of the path.

`SourceArn`  <a name="SourceArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the source.

# AWS::EC2::NetworkInsightsPath FilterPortRange
<a name="aws-properties-ec2-networkinsightspath-filterportrange"></a>

Describes a port range.

## Syntax
<a name="aws-properties-ec2-networkinsightspath-filterportrange-syntax"></a>

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

### JSON
<a name="aws-properties-ec2-networkinsightspath-filterportrange-syntax.json"></a>

```
{
  "[FromPort](#cfn-ec2-networkinsightspath-filterportrange-fromport)" : Integer,
  "[ToPort](#cfn-ec2-networkinsightspath-filterportrange-toport)" : Integer
}
```

### YAML
<a name="aws-properties-ec2-networkinsightspath-filterportrange-syntax.yaml"></a>

```
  [FromPort](#cfn-ec2-networkinsightspath-filterportrange-fromport): Integer
  [ToPort](#cfn-ec2-networkinsightspath-filterportrange-toport): Integer
```

## Properties
<a name="aws-properties-ec2-networkinsightspath-filterportrange-properties"></a>

`FromPort`  <a name="cfn-ec2-networkinsightspath-filterportrange-fromport"></a>
The first port in the range.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `65535`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ToPort`  <a name="cfn-ec2-networkinsightspath-filterportrange-toport"></a>
The last port in the range.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `65535`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EC2::NetworkInsightsPath PathFilter
<a name="aws-properties-ec2-networkinsightspath-pathfilter"></a>

Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.

## Syntax
<a name="aws-properties-ec2-networkinsightspath-pathfilter-syntax"></a>

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

### JSON
<a name="aws-properties-ec2-networkinsightspath-pathfilter-syntax.json"></a>

```
{
  "[DestinationAddress](#cfn-ec2-networkinsightspath-pathfilter-destinationaddress)" : String,
  "[DestinationPortRange](#cfn-ec2-networkinsightspath-pathfilter-destinationportrange)" : FilterPortRange,
  "[SourceAddress](#cfn-ec2-networkinsightspath-pathfilter-sourceaddress)" : String,
  "[SourcePortRange](#cfn-ec2-networkinsightspath-pathfilter-sourceportrange)" : FilterPortRange
}
```

### YAML
<a name="aws-properties-ec2-networkinsightspath-pathfilter-syntax.yaml"></a>

```
  [DestinationAddress](#cfn-ec2-networkinsightspath-pathfilter-destinationaddress): String
  [DestinationPortRange](#cfn-ec2-networkinsightspath-pathfilter-destinationportrange): 
    FilterPortRange
  [SourceAddress](#cfn-ec2-networkinsightspath-pathfilter-sourceaddress): String
  [SourcePortRange](#cfn-ec2-networkinsightspath-pathfilter-sourceportrange): 
    FilterPortRange
```

## Properties
<a name="aws-properties-ec2-networkinsightspath-pathfilter-properties"></a>

`DestinationAddress`  <a name="cfn-ec2-networkinsightspath-pathfilter-destinationaddress"></a>
The destination IPv4 address.  
*Required*: No  
*Type*: String  
*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`  
*Minimum*: `0`  
*Maximum*: `15`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DestinationPortRange`  <a name="cfn-ec2-networkinsightspath-pathfilter-destinationportrange"></a>
The destination port range.  
*Required*: No  
*Type*: [FilterPortRange](aws-properties-ec2-networkinsightspath-filterportrange.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceAddress`  <a name="cfn-ec2-networkinsightspath-pathfilter-sourceaddress"></a>
The source IPv4 address.  
*Required*: No  
*Type*: String  
*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$`  
*Minimum*: `0`  
*Maximum*: `15`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourcePortRange`  <a name="cfn-ec2-networkinsightspath-pathfilter-sourceportrange"></a>
The source port range.  
*Required*: No  
*Type*: [FilterPortRange](aws-properties-ec2-networkinsightspath-filterportrange.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EC2::NetworkInsightsPath Tag
<a name="aws-properties-ec2-networkinsightspath-tag"></a>

Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).

## Syntax
<a name="aws-properties-ec2-networkinsightspath-tag-syntax"></a>

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

### JSON
<a name="aws-properties-ec2-networkinsightspath-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ec2-networkinsightspath-tag-key)" : String,
  "[Value](#cfn-ec2-networkinsightspath-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ec2-networkinsightspath-tag-syntax.yaml"></a>

```
  [Key](#cfn-ec2-networkinsightspath-tag-key): String
  [Value](#cfn-ec2-networkinsightspath-tag-value): String
```

## Properties
<a name="aws-properties-ec2-networkinsightspath-tag-properties"></a>

`Key`  <a name="cfn-ec2-networkinsightspath-tag-key"></a>
The tag key.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ec2-networkinsightspath-tag-value"></a>
The tag value.  
*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)

## Examples
<a name="aws-properties-ec2-networkinsightspath-tag--examples"></a>

### 
<a name="aws-properties-ec2-networkinsightspath-tag--examples--"></a>

This example specifies two tags for the path.

#### JSON
<a name="aws-properties-ec2-networkinsightspath-tag--examples----json"></a>

```
"Tags" : [
   {
      "Key" : "key1",
      "Value" : "value1"
   },
   {
      "Key" : "key2",
      "Value" : "value2"
   }
]
```

#### YAML
<a name="aws-properties-ec2-networkinsightspath-tag--examples----yaml"></a>

```
Tags: 
  - Key: "key1"
    Value: "value1"
  - Key: "key2"
    Value: "value2"
```