AWS::EC2::NetworkInsightsPath - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::EC2::NetworkInsightsPath

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.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::NetworkInsightsPath",
  "Properties" : {
      "Destination" : String,
      "DestinationIp" : String,
      "DestinationPort" : Integer,
      "FilterAtDestination" : PathFilter,
      "FilterAtSource" : PathFilter,
      "Protocol" : String,
      "Source" : String,
      "SourceIp" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EC2::NetworkInsightsPath
Properties:
  Destination: String
  DestinationIp: String
  DestinationPort: Integer
  FilterAtDestination: 
    PathFilter
  FilterAtSource: 
    PathFilter
  Protocol: String
  Source: String
  SourceIp: String
  Tags: 
    - Tag

Properties

Destination

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

DestinationIp

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

DestinationPort

The destination port.

Required: No

Type: Integer

Minimum: 0

Maximum: 65535

Update requires: Replacement

FilterAtDestination

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

Update requires: Replacement

FilterAtSource

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

Update requires: Replacement

Protocol

The protocol.

Required: Yes

Type: String

Allowed values: tcp | udp

Update requires: Replacement

Source

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

SourceIp

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

Tags

The tags to add to the path.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

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 Ref.

Fn::GetAtt

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 Fn::GetAtt.

CreatedDate

The time stamp when the path was created.

DestinationArn

The Amazon Resource Name (ARN) of the destination.

NetworkInsightsPathArn

The Amazon Resource Name (ARN) of the path.

NetworkInsightsPathId

The ID of the path.

SourceArn

The Amazon Resource Name (ARN) of the source.