Package software.amazon.awscdk.services.ec2

Class CfnNetworkInsightsAnalysis

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnNetworkInsightsAnalysis
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.814Z") @Stability(Stable) public class CfnNetworkInsightsAnalysis extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::NetworkInsightsAnalysis.

Specifies a network insights analysis.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnNetworkInsightsAnalysis cfnNetworkInsightsAnalysis = CfnNetworkInsightsAnalysis.Builder.create(this, "MyCfnNetworkInsightsAnalysis")
         .networkInsightsPathId("networkInsightsPathId")
         // the properties below are optional
         .additionalAccounts(List.of("additionalAccounts"))
         .filterInArns(List.of("filterInArns"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnNetworkInsightsAnalysis

      protected CfnNetworkInsightsAnalysis(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnNetworkInsightsAnalysis

      protected CfnNetworkInsightsAnalysis(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnNetworkInsightsAnalysis

      @Stability(Stable) public CfnNetworkInsightsAnalysis(@NotNull Construct scope, @NotNull String id, @NotNull CfnNetworkInsightsAnalysisProps props)
      Create a new AWS::EC2::NetworkInsightsAnalysis.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAlternatePathHints

      @Stability(Stable) @NotNull public IResolvable getAttrAlternatePathHints()
      Potential intermediate components.

    • getAttrExplanations

      @Stability(Stable) @NotNull public IResolvable getAttrExplanations()
      The explanations.

      For more information, see Reachability Analyzer explanation codes .

    • getAttrForwardPathComponents

      @Stability(Stable) @NotNull public IResolvable getAttrForwardPathComponents()
      The components in the path from source to destination.

    • getAttrNetworkInsightsAnalysisArn

      @Stability(Stable) @NotNull public String getAttrNetworkInsightsAnalysisArn()
      The Amazon Resource Name (ARN) of the network insights analysis.

    • getAttrNetworkInsightsAnalysisId

      @Stability(Stable) @NotNull public String getAttrNetworkInsightsAnalysisId()
      The ID of the network insights analysis.

    • getAttrNetworkPathFound

      @Stability(Stable) @NotNull public IResolvable getAttrNetworkPathFound()
      Indicates whether the destination is reachable from the source.

    • getAttrReturnPathComponents

      @Stability(Stable) @NotNull public IResolvable getAttrReturnPathComponents()
      The components in the path from destination to source.

    • getAttrStartDate

      @Stability(Stable) @NotNull public String getAttrStartDate()
      The time the analysis started.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the network insights analysis.

    • getAttrStatusMessage

      @Stability(Stable) @NotNull public String getAttrStatusMessage()
      The status message, if the status is failed .

    • getAttrSuggestedAccounts

      @Stability(Stable) @NotNull public List<String> getAttrSuggestedAccounts()
      The IDs of potential intermediate accounts.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags to apply.

    • getNetworkInsightsPathId

      @Stability(Stable) @NotNull public String getNetworkInsightsPathId()
      The ID of the path.

    • setNetworkInsightsPathId

      @Stability(Stable) public void setNetworkInsightsPathId(@NotNull String value)
      The ID of the path.

    • getAdditionalAccounts

      @Stability(Stable) @Nullable public List<String> getAdditionalAccounts()
      The member accounts that contain resources that the path can traverse.

    • setAdditionalAccounts

      @Stability(Stable) public void setAdditionalAccounts(@Nullable List<String> value)
      The member accounts that contain resources that the path can traverse.

    • getFilterInArns

      @Stability(Stable) @Nullable public List<String> getFilterInArns()
      The Amazon Resource Names (ARN) of the resources that the path must traverse.

    • setFilterInArns

      @Stability(Stable) public void setFilterInArns(@Nullable List<String> value)
      The Amazon Resource Names (ARN) of the resources that the path must traverse.