software.amazon.awscdk.services.ec2

Class CfnNetworkInsightsAnalysis

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnNetworkInsightsAnalysis

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.260Z")
 @Stability(value=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
         .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 Example:
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnNetworkInsightsAnalysis(software.constructs.Construct scope, 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
IResolvable	getAttrAlternatePathHints() Potential intermediate components.
IResolvable	getAttrExplanations() The explanations.
IResolvable	getAttrForwardPathComponents() The components in the path from source to destination.
String	getAttrNetworkInsightsAnalysisArn() The Amazon Resource Name (ARN) of the network insights analysis.
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.
String	getAttrStartDate() The time the analysis started.
String	getAttrStatus() The status of the network insights analysis.
String	getAttrStatusMessage() The status message, if the status is `failed` .
protected Map<String,Object>	getCfnProperties()
List<String>	getFilterInArns() The Amazon Resource Names (ARN) of the resources that the path must traverse.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFilterInArns(List<String> value) The Amazon Resource Names (ARN) of the resources that the path must traverse.
void	setNetworkInsightsPathId(String value) The ID of the path.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnNetworkInsightsAnalysis(@NotNull
                                                           software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public IResolvable getAttrAlternatePathHints()

Potential intermediate components.

getAttrExplanations

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrExplanations()

The explanations.

For more information, see Reachability Analyzer explanation codes .

getAttrForwardPathComponents

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrForwardPathComponents()

The components in the path from source to destination.

getAttrNetworkInsightsAnalysisArn

@Stability(value=Stable)
 @NotNull
public String getAttrNetworkInsightsAnalysisArn()

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

getAttrNetworkInsightsAnalysisId

@Stability(value=Stable)
 @NotNull
public String getAttrNetworkInsightsAnalysisId()

The ID of the network insights analysis.

getAttrNetworkPathFound

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrNetworkPathFound()

Indicates whether the destination is reachable from the source.

getAttrReturnPathComponents

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrReturnPathComponents()

The components in the path from destination to source.

getAttrStartDate

@Stability(value=Stable)
 @NotNull
public String getAttrStartDate()

The time the analysis started.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The status of the network insights analysis.

getAttrStatusMessage

@Stability(value=Stable)
 @NotNull
public String getAttrStatusMessage()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags to apply.

getNetworkInsightsPathId

@Stability(value=Stable)
 @NotNull
public String getNetworkInsightsPathId()

The ID of the path.

setNetworkInsightsPathId

@Stability(value=Stable)
public void setNetworkInsightsPathId(@NotNull
                                                              String value)

The ID of the path.

getFilterInArns

@Stability(value=Stable)
 @Nullable
public List<String> getFilterInArns()

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

setFilterInArns

@Stability(value=Stable)
public void setFilterInArns(@Nullable
                                                     List<String> value)

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