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, 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.268Z")
 @Stability(value=Stable)
public class CfnNetworkInsightsPath
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::NetworkInsightsPath`.

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")
         .destination("destination")
         .protocol("protocol")
         .source("source")
         // the properties below are optional
         .destinationIp("destinationIp")
         .destinationPort(123)
         .sourceIp("sourceIp")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnNetworkInsightsPath.Builder A fluent builder for CfnNetworkInsightsPath.

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
	CfnNetworkInsightsPath(software.constructs.Construct scope, String id, CfnNetworkInsightsPathProps props) Create a new `AWS::EC2::NetworkInsightsPath`.
protected	CfnNetworkInsightsPath(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNetworkInsightsPath(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCreatedDate() The time stamp when the path was created.
String	getAttrNetworkInsightsPathArn() The Amazon Resource Name (ARN) of the path.
String	getAttrNetworkInsightsPathId() The ID of the path.
protected Map<String,Object>	getCfnProperties()
String	getDestination() The AWS resource that is the destination of the path.
String	getDestinationIp() The IP address of the AWS resource that is the destination of the path.
Number	getDestinationPort() The destination port.
String	getProtocol() The protocol.
String	getSource() The AWS resource that is the source of the path.
String	getSourceIp() The IP address of the AWS resource that is the source of the path.
TagManager	getTags() 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 AWS resource that is the destination of the path.
void	setDestinationIp(String value) The IP address of the AWS resource that is the destination of the path.
void	setDestinationPort(Number value) The destination port.
void	setProtocol(String value) The protocol.
void	setSource(String value) The AWS resource that is the source of the path.
void	setSourceIp(String value) The IP address of the AWS resource that is the source 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

CfnNetworkInsightsPath

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

CfnNetworkInsightsPath

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

CfnNetworkInsightsPath

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

Create a new `AWS::EC2::NetworkInsightsPath`.

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.

getAttrCreatedDate

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

The time stamp when the path was created.

getAttrNetworkInsightsPathArn

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

The Amazon Resource Name (ARN) of the path.

getAttrNetworkInsightsPathId

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

The ID of the path.

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 add to the path.

getDestination

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

The AWS resource that is the destination of the path.

setDestination

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

The AWS resource that is the destination of the path.

getProtocol

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

The protocol.

setProtocol

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

The protocol.

getSource

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

The AWS resource that is the source of the path.

setSource

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

The AWS resource that is the source of the path.

getDestinationIp

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

The IP address of the AWS resource that is the destination of the path.

setDestinationIp

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

The IP address of the AWS resource that is the destination of the path.

getDestinationPort

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

The destination port.

setDestinationPort

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

The destination port.

getSourceIp

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

The IP address of the AWS resource that is the source of the path.

setSourceIp

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

The IP address of the AWS resource that is the source of the path.