Package software.amazon.awscdk.services.ec2

Class CfnNetworkInsightsAccessScope

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:07.956Z")
@Stability(Stable)
public class CfnNetworkInsightsAccessScope
extends CfnResource
implements IInspectable, ITaggable

Describes a Network Access Scope.

A Network Access Scope defines outbound (egress) and inbound (ingress) traffic patterns, including sources, destinations, paths, and traffic types.

Network Access Analyzer identifies unintended network access to your resources on AWS . When you start an analysis on a Network Access Scope, Network Access Analyzer produces findings. For more information, see the Network Access 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.*;
 CfnNetworkInsightsAccessScope cfnNetworkInsightsAccessScope = CfnNetworkInsightsAccessScope.Builder.create(this, "MyCfnNetworkInsightsAccessScope")
         .excludePaths(List.of(AccessScopePathRequestProperty.builder()
                 .destination(PathStatementRequestProperty.builder()
                         .packetHeaderStatement(PacketHeaderStatementRequestProperty.builder()
                                 .destinationAddresses(List.of("destinationAddresses"))
                                 .destinationPorts(List.of("destinationPorts"))
                                 .destinationPrefixLists(List.of("destinationPrefixLists"))
                                 .protocols(List.of("protocols"))
                                 .sourceAddresses(List.of("sourceAddresses"))
                                 .sourcePorts(List.of("sourcePorts"))
                                 .sourcePrefixLists(List.of("sourcePrefixLists"))
                                 .build())
                         .resourceStatement(ResourceStatementRequestProperty.builder()
                                 .resources(List.of("resources"))
                                 .resourceTypes(List.of("resourceTypes"))
                                 .build())
                         .build())
                 .source(PathStatementRequestProperty.builder()
                         .packetHeaderStatement(PacketHeaderStatementRequestProperty.builder()
                                 .destinationAddresses(List.of("destinationAddresses"))
                                 .destinationPorts(List.of("destinationPorts"))
                                 .destinationPrefixLists(List.of("destinationPrefixLists"))
                                 .protocols(List.of("protocols"))
                                 .sourceAddresses(List.of("sourceAddresses"))
                                 .sourcePorts(List.of("sourcePorts"))
                                 .sourcePrefixLists(List.of("sourcePrefixLists"))
                                 .build())
                         .resourceStatement(ResourceStatementRequestProperty.builder()
                                 .resources(List.of("resources"))
                                 .resourceTypes(List.of("resourceTypes"))
                                 .build())
                         .build())
                 .throughResources(List.of(ThroughResourcesStatementRequestProperty.builder()
                         .resourceStatement(ResourceStatementRequestProperty.builder()
                                 .resources(List.of("resources"))
                                 .resourceTypes(List.of("resourceTypes"))
                                 .build())
                         .build()))
                 .build()))
         .matchPaths(List.of(AccessScopePathRequestProperty.builder()
                 .destination(PathStatementRequestProperty.builder()
                         .packetHeaderStatement(PacketHeaderStatementRequestProperty.builder()
                                 .destinationAddresses(List.of("destinationAddresses"))
                                 .destinationPorts(List.of("destinationPorts"))
                                 .destinationPrefixLists(List.of("destinationPrefixLists"))
                                 .protocols(List.of("protocols"))
                                 .sourceAddresses(List.of("sourceAddresses"))
                                 .sourcePorts(List.of("sourcePorts"))
                                 .sourcePrefixLists(List.of("sourcePrefixLists"))
                                 .build())
                         .resourceStatement(ResourceStatementRequestProperty.builder()
                                 .resources(List.of("resources"))
                                 .resourceTypes(List.of("resourceTypes"))
                                 .build())
                         .build())
                 .source(PathStatementRequestProperty.builder()
                         .packetHeaderStatement(PacketHeaderStatementRequestProperty.builder()
                                 .destinationAddresses(List.of("destinationAddresses"))
                                 .destinationPorts(List.of("destinationPorts"))
                                 .destinationPrefixLists(List.of("destinationPrefixLists"))
                                 .protocols(List.of("protocols"))
                                 .sourceAddresses(List.of("sourceAddresses"))
                                 .sourcePorts(List.of("sourcePorts"))
                                 .sourcePrefixLists(List.of("sourcePrefixLists"))
                                 .build())
                         .resourceStatement(ResourceStatementRequestProperty.builder()
                                 .resources(List.of("resources"))
                                 .resourceTypes(List.of("resourceTypes"))
                                 .build())
                         .build())
                 .throughResources(List.of(ThroughResourcesStatementRequestProperty.builder()
                         .resourceStatement(ResourceStatementRequestProperty.builder()
                                 .resources(List.of("resources"))
                                 .resourceTypes(List.of("resourceTypes"))
                                 .build())
                         .build()))
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnNetworkInsightsAccessScope.AccessScopePathRequestProperty	Describes a path.
static final class	CfnNetworkInsightsAccessScope.Builder	A fluent builder for CfnNetworkInsightsAccessScope.
static interface	CfnNetworkInsightsAccessScope.PacketHeaderStatementRequestProperty	Describes a packet header statement.
static interface	CfnNetworkInsightsAccessScope.PathStatementRequestProperty	Describes a path statement.
static interface	CfnNetworkInsightsAccessScope.ResourceStatementRequestProperty	Describes a resource statement.
static interface	CfnNetworkInsightsAccessScope.ThroughResourcesStatementRequestProperty	Describes a through resource statement.

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	CfnNetworkInsightsAccessScope(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnNetworkInsightsAccessScope(software.amazon.jsii.JsiiObjectRef objRef)
	CfnNetworkInsightsAccessScope(software.constructs.Construct scope, String id)
	CfnNetworkInsightsAccessScope(software.constructs.Construct scope, String id, CfnNetworkInsightsAccessScopeProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedDate()	The creation date.
String	getAttrNetworkInsightsAccessScopeArn()	The ARN of the Network Access Scope.
String	getAttrNetworkInsightsAccessScopeId()	The ID of the Network Access Scope.
String	getAttrUpdatedDate()	The last updated date.
protected Map<String,Object>	getCfnProperties()
Object	getExcludePaths()	The paths to exclude.
Object	getMatchPaths()	The paths to match.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setExcludePaths(List<Object> value)	The paths to exclude.
void	setExcludePaths(IResolvable value)	The paths to exclude.
void	setMatchPaths(List<Object> value)	The paths to match.
void	setMatchPaths(IResolvable value)	The paths to match.
void	setTagsRaw(List<CfnTag> value)	The tags.

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

CfnNetworkInsightsAccessScope

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

CfnNetworkInsightsAccessScope

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

CfnNetworkInsightsAccessScope

@Stability(Stable)
public CfnNetworkInsightsAccessScope(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnNetworkInsightsAccessScopeProps 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.

CfnNetworkInsightsAccessScope

@Stability(Stable)
public CfnNetworkInsightsAccessScope(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

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.

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 creation date.

getAttrNetworkInsightsAccessScopeArn

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

The ARN of the Network Access Scope.

getAttrNetworkInsightsAccessScopeId

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

The ID of the Network Access Scope.

getAttrUpdatedDate

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

The last updated date.

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

getExcludePaths

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

The paths to exclude.

setExcludePaths

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

The paths to exclude.

setExcludePaths

@Stability(Stable)
public void setExcludePaths(@Nullable
 List<Object> value)

The paths to exclude.

getMatchPaths

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

The paths to match.

setMatchPaths

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

The paths to match.

setMatchPaths

@Stability(Stable)
public void setMatchPaths(@Nullable
 List<Object> value)

The paths to match.

getTagsRaw

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

The tags.

setTagsRaw

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

The tags.