Package software.amazon.awscdk.services.ec2

Class CfnNetworkInsightsPath

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.CfnNetworkInsightsPath

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-03-01T20:58:22.948Z")
@Stability(Stable)
public class CfnNetworkInsightsPath
extends CfnResource
implements IInspectable, ITaggable

Specifies a path to analyze for reachability.

VPC Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the Reachability Analyzer User Guide .

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.*;
 CfnNetworkInsightsPath cfnNetworkInsightsPath = CfnNetworkInsightsPath.Builder.create(this, "MyCfnNetworkInsightsPath")
         .protocol("protocol")
         .source("source")
         // the properties below are optional
         .destination("destination")
         .destinationIp("destinationIp")
         .destinationPort(123)
         .filterAtDestination(PathFilterProperty.builder()
                 .destinationAddress("destinationAddress")
                 .destinationPortRange(FilterPortRangeProperty.builder()
                         .fromPort(123)
                         .toPort(123)
                         .build())
                 .sourceAddress("sourceAddress")
                 .sourcePortRange(FilterPortRangeProperty.builder()
                         .fromPort(123)
                         .toPort(123)
                         .build())
                 .build())
         .filterAtSource(PathFilterProperty.builder()
                 .destinationAddress("destinationAddress")
                 .destinationPortRange(FilterPortRangeProperty.builder()
                         .fromPort(123)
                         .toPort(123)
                         .build())
                 .sourceAddress("sourceAddress")
                 .sourcePortRange(FilterPortRangeProperty.builder()
                         .fromPort(123)
                         .toPort(123)
                         .build())
                 .build())
         .sourceIp("sourceIp")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightspath.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnNetworkInsightsPath.Builder	A fluent builder for CfnNetworkInsightsPath.
static interface	CfnNetworkInsightsPath.FilterPortRangeProperty	Describes a port range.
static interface	CfnNetworkInsightsPath.PathFilterProperty	Describes a set of filters for a path analysis.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnNetworkInsightsPath(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNetworkInsightsPath(software.amazon.jsii.JsiiObjectRef objRef)
	CfnNetworkInsightsPath(software.constructs.Construct scope, String id, CfnNetworkInsightsPathProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedDate()	The time stamp when the path was created.
String	getAttrDestinationArn()	The Amazon Resource Name (ARN) of the destination.
String	getAttrNetworkInsightsPathArn()	The Amazon Resource Name (ARN) of the path.
String	getAttrNetworkInsightsPathId()	The ID of the path.
String	getAttrSourceArn()	The Amazon Resource Name (ARN) of the source.
protected Map<String,Object>	getCfnProperties()
String	getDestination()	The ID or ARN of the destination.
String	getDestinationIp()	The IP address of the destination.
Number	getDestinationPort()	The destination port.
Object	getFilterAtDestination()	Scopes the analysis to network paths that match specific filters at the destination.
Object	getFilterAtSource()	Scopes the analysis to network paths that match specific filters at the source.
String	getProtocol()	The protocol.
String	getSource()	The ID or ARN of the source.
String	getSourceIp()	The IP address of the source.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags to add to the path.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDestination(String value)	The ID or ARN of the destination.
void	setDestinationIp(String value)	The IP address of the destination.
void	setDestinationPort(Number value)	The destination port.
void	setFilterAtDestination(IResolvable value)	Scopes the analysis to network paths that match specific filters at the destination.
void	setFilterAtDestination(CfnNetworkInsightsPath.PathFilterProperty value)	Scopes the analysis to network paths that match specific filters at the destination.
void	setFilterAtSource(IResolvable value)	Scopes the analysis to network paths that match specific filters at the source.
void	setFilterAtSource(CfnNetworkInsightsPath.PathFilterProperty value)	Scopes the analysis to network paths that match specific filters at the source.
void	setProtocol(String value)	The protocol.
void	setSource(String value)	The ID or ARN of the source.
void	setSourceIp(String value)	The IP address of the source.
void	setTagsRaw(List<CfnTag> value)	The tags to add to the path.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 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

CfnNetworkInsightsPath

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

CfnNetworkInsightsPath

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

CfnNetworkInsightsPath

@Stability(Stable)
public CfnNetworkInsightsPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnNetworkInsightsPathProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrCreatedDate

@Stability(Stable)
@NotNull
public String getAttrCreatedDate()

The time stamp when the path was created.

getAttrDestinationArn

@Stability(Stable)
@NotNull
public String getAttrDestinationArn()

The Amazon Resource Name (ARN) of the destination.

getAttrNetworkInsightsPathArn

@Stability(Stable)
@NotNull
public String getAttrNetworkInsightsPathArn()

The Amazon Resource Name (ARN) of the path.

getAttrNetworkInsightsPathId

@Stability(Stable)
@NotNull
public String getAttrNetworkInsightsPathId()

The ID of the path.

getAttrSourceArn

@Stability(Stable)
@NotNull
public String getAttrSourceArn()

The Amazon Resource Name (ARN) of the source.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getProtocol

@Stability(Stable)
@NotNull
public String getProtocol()

The protocol.

setProtocol

@Stability(Stable)
public void setProtocol(@NotNull
 String value)

The protocol.

getSource

@Stability(Stable)
@NotNull
public String getSource()

The ID or ARN of the source.

setSource

@Stability(Stable)
public void setSource(@NotNull
 String value)

The ID or ARN of the source.

getDestination

@Stability(Stable)
@Nullable
public String getDestination()

The ID or ARN of the destination.

setDestination

@Stability(Stable)
public void setDestination(@Nullable
 String value)

The ID or ARN of the destination.

getDestinationIp

@Stability(Stable)
@Nullable
public String getDestinationIp()

The IP address of the destination.

setDestinationIp

@Stability(Stable)
public void setDestinationIp(@Nullable
 String value)

The IP address of the destination.

getDestinationPort

@Stability(Stable)
@Nullable
public Number getDestinationPort()

The destination port.

setDestinationPort

@Stability(Stable)
public void setDestinationPort(@Nullable
 Number value)

The destination port.

getFilterAtDestination

@Stability(Stable)
@Nullable
public Object getFilterAtDestination()

Scopes the analysis to network paths that match specific filters at the destination.

setFilterAtDestination

@Stability(Stable)
public void setFilterAtDestination(@Nullable
 IResolvable value)

Scopes the analysis to network paths that match specific filters at the destination.

setFilterAtDestination

@Stability(Stable)
public void setFilterAtDestination(@Nullable
 CfnNetworkInsightsPath.PathFilterProperty value)

Scopes the analysis to network paths that match specific filters at the destination.

getFilterAtSource

@Stability(Stable)
@Nullable
public Object getFilterAtSource()

Scopes the analysis to network paths that match specific filters at the source.

setFilterAtSource

@Stability(Stable)
public void setFilterAtSource(@Nullable
 IResolvable value)

Scopes the analysis to network paths that match specific filters at the source.

setFilterAtSource

@Stability(Stable)
public void setFilterAtSource(@Nullable
 CfnNetworkInsightsPath.PathFilterProperty value)

Scopes the analysis to network paths that match specific filters at the source.

getSourceIp

@Stability(Stable)
@Nullable
public String getSourceIp()

The IP address of the source.

setSourceIp

@Stability(Stable)
public void setSourceIp(@Nullable
 String value)

The IP address of the source.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags to add to the path.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags to add to the path.