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::NetworkInsightsAnalysis Specifies a network insights analysis. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::EC2::NetworkInsightsAnalysis", "Properties" : { "[AdditionalAccounts](#cfn-ec2-networkinsightsanalysis-additionalaccounts)" : {{[ String, ... ]}}, "[FilterInArns](#cfn-ec2-networkinsightsanalysis-filterinarns)" : {{[ String, ... ]}}, "[FilterOutArns](#cfn-ec2-networkinsightsanalysis-filteroutarns)" : {{[ String, ... ]}}, "[NetworkInsightsPathId](#cfn-ec2-networkinsightsanalysis-networkinsightspathid)" : {{String}}, "[Tags](#cfn-ec2-networkinsightsanalysis-tags)" : {{[ Tag, ... ]}} } } ``` ### YAML ``` Type: AWS::EC2::NetworkInsightsAnalysis Properties: [AdditionalAccounts](#cfn-ec2-networkinsightsanalysis-additionalaccounts): {{ - String}} [FilterInArns](#cfn-ec2-networkinsightsanalysis-filterinarns): {{ - String}} [FilterOutArns](#cfn-ec2-networkinsightsanalysis-filteroutarns): {{ - String}} [NetworkInsightsPathId](#cfn-ec2-networkinsightsanalysis-networkinsightspathid): {{String}} [Tags](#cfn-ec2-networkinsightsanalysis-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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FilterInArns` The Amazon Resource Names (ARN) of the resources that the path must traverse. *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FilterOutArns` The Amazon Resource Names (ARN) of the resources that the path must ignore. *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `NetworkInsightsPathId` The ID of the path. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` The tags to apply. *Required*: No *Type*: Array of [Tag](aws-properties-ec2-networkinsightsanalysis-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 ### 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 [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 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). #### `AlternatePathHints` Potential intermediate components. `Explanations` The explanations. For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html). `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.