software.amazon.awscdk.services.ec2

Class CfnNetworkInsightsAnalysis

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.621Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnNetworkInsightsAnalysis.AdditionalDetailProperty Describes an additional detail for a path analysis.
static interface	CfnNetworkInsightsAnalysis.AlternatePathHintProperty Describes an potential intermediate component of a feasible path.
static interface	CfnNetworkInsightsAnalysis.AnalysisAclRuleProperty Describes a network access control (ACL) rule.
static interface	CfnNetworkInsightsAnalysis.AnalysisComponentProperty Describes a path component.
static interface	CfnNetworkInsightsAnalysis.AnalysisLoadBalancerListenerProperty Describes a load balancer listener.
static interface	CfnNetworkInsightsAnalysis.AnalysisLoadBalancerTargetProperty Describes a load balancer target.
static interface	CfnNetworkInsightsAnalysis.AnalysisPacketHeaderProperty Describes a header.
static interface	CfnNetworkInsightsAnalysis.AnalysisRouteTableRouteProperty Describes a route table route.
static interface	CfnNetworkInsightsAnalysis.AnalysisSecurityGroupRuleProperty Describes a security group rule.
static class	CfnNetworkInsightsAnalysis.Builder A fluent builder for CfnNetworkInsightsAnalysis.
static interface	CfnNetworkInsightsAnalysis.ExplanationProperty Describes an explanation code for an unreachable path.
static interface	CfnNetworkInsightsAnalysis.PathComponentProperty Describes a path component.
static interface	CfnNetworkInsightsAnalysis.PortRangeProperty Describes a range of ports.
static interface	CfnNetworkInsightsAnalysis.TransitGatewayRouteTableRouteProperty Describes a route in a transit gateway route table.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnNetworkInsightsAnalysis(Construct scope, java.lang.String id, CfnNetworkInsightsAnalysisProps props) Create a new `AWS::EC2::NetworkInsightsAnalysis`.
protected	CfnNetworkInsightsAnalysis(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNetworkInsightsAnalysis(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAdditionalAccounts() The member accounts that contain resources that the path can traverse.
IResolvable	getAttrAlternatePathHints() Potential intermediate components.
IResolvable	getAttrExplanations() The explanations.
IResolvable	getAttrForwardPathComponents() The components in the path from source to destination.
java.lang.String	getAttrNetworkInsightsAnalysisArn() The Amazon Resource Name (ARN) of the network insights analysis.
java.lang.String	getAttrNetworkInsightsAnalysisId() The ID of the network insights analysis.
IResolvable	getAttrNetworkPathFound() Indicates whether the destination is reachable from the source.
IResolvable	getAttrReturnPathComponents() The components in the path from destination to source.
java.lang.String	getAttrStartDate() The time the analysis started.
java.lang.String	getAttrStatus() The status of the network insights analysis.
java.lang.String	getAttrStatusMessage() The status message, if the status is `failed` .
java.util.List<java.lang.String>	getAttrSuggestedAccounts() The IDs of potential intermediate accounts.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.util.List<java.lang.String>	getFilterInArns() The Amazon Resource Names (ARN) of the resources that the path must traverse.
java.lang.String	getNetworkInsightsPathId() The ID of the path.
TagManager	getTags() The tags to apply.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAdditionalAccounts(java.util.List<java.lang.String> value) The member accounts that contain resources that the path can traverse.
void	setFilterInArns(java.util.List<java.lang.String> value) The Amazon Resource Names (ARN) of the resources that the path must traverse.
void	setNetworkInsightsPathId(java.lang.String value) The ID of the path.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnNetworkInsightsAnalysis

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

CfnNetworkInsightsAnalysis

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

CfnNetworkInsightsAnalysis

public CfnNetworkInsightsAnalysis(Construct scope,
                                  java.lang.String id,
                                  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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAlternatePathHints

public IResolvable getAttrAlternatePathHints()

Potential intermediate components.

getAttrExplanations

public IResolvable getAttrExplanations()

The explanations.

For more information, see Reachability Analyzer explanation codes .

getAttrForwardPathComponents

public IResolvable getAttrForwardPathComponents()

The components in the path from source to destination.

getAttrNetworkInsightsAnalysisArn

public java.lang.String getAttrNetworkInsightsAnalysisArn()

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

getAttrNetworkInsightsAnalysisId

public java.lang.String getAttrNetworkInsightsAnalysisId()

The ID of the network insights analysis.

getAttrNetworkPathFound

public IResolvable getAttrNetworkPathFound()

Indicates whether the destination is reachable from the source.

getAttrReturnPathComponents

public IResolvable getAttrReturnPathComponents()

The components in the path from destination to source.

getAttrStartDate

public java.lang.String getAttrStartDate()

The time the analysis started.

getAttrStatus

public java.lang.String getAttrStatus()

The status of the network insights analysis.

getAttrStatusMessage

public java.lang.String getAttrStatusMessage()

The status message, if the status is `failed` .

getAttrSuggestedAccounts

public java.util.List<java.lang.String> getAttrSuggestedAccounts()

The IDs of potential intermediate accounts.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags to apply.

getNetworkInsightsPathId

public java.lang.String getNetworkInsightsPathId()

The ID of the path.

setNetworkInsightsPathId

public void setNetworkInsightsPathId(java.lang.String value)

The ID of the path.

getAdditionalAccounts

public java.util.List<java.lang.String> getAdditionalAccounts()

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

setAdditionalAccounts

public void setAdditionalAccounts(java.util.List<java.lang.String> value)

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

getFilterInArns

public java.util.List<java.lang.String> getFilterInArns()

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

setFilterInArns

public void setFilterInArns(java.util.List<java.lang.String> value)

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