AWS::EC2::NetworkInsightsAnalysis - AWS CloudFormation (original) (raw)

Specifies a network insights analysis.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::NetworkInsightsAnalysis",
  "Properties" : {
      "AdditionalAccounts" : [ String, ... ],
      "FilterInArns" : [ String, ... ],
      "NetworkInsightsPathId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EC2::NetworkInsightsAnalysis
Properties:
  AdditionalAccounts: 
    - String
  FilterInArns: 
    - String
  NetworkInsightsPathId: String
  Tags: 
    - Tag

Properties

AdditionalAccounts

The member accounts that contain resources that the path can traverse.

Required: No

Type: Array of String

Update requires: No interruption

FilterInArns

The Amazon Resource Names (ARN) of the resources that the path must traverse.

Required: No

Type: Array of String

Update requires: Replacement

NetworkInsightsPathId

The ID of the path.

Required: Yes

Type: String

Update requires: Replacement

Tags

The tags to apply.

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 network insights analysis.

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.

AlternatePathHints

Potential intermediate components.

Explanations

The explanations. For more information, see Reachability Analyzer explanation codes.

ForwardPathComponents

The components in the path from source to destination.

NetworkInsightsAnalysisArn

The Amazon Resource Name (ARN) of the network insights analysis.

NetworkInsightsAnalysisId

The ID of the network insights analysis.

NetworkPathFound

Indicates whether the destination is reachable from the source.

ReturnPathComponents

The components in the path from destination to source.

StartDate

The time the analysis started.

Status

The status of the network insights analysis.

StatusMessage

The status message, if the status is failed.

SuggestedAccounts

The IDs of potential intermediate accounts.