Show / Hide Table of Contents

Class CfnNetworkInsightsAnalysis

Specifies a network insights analysis.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnNetworkInsightsAnalysis
Implements
IInspectable
INetworkInsightsAnalysisRef
IConstruct
IDependable
IEnvironmentAware
ITaggable
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnNetworkInsightsAnalysis : CfnResource, IInspectable, INetworkInsightsAnalysisRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnNetworkInsightsAnalysis Inherits CfnResource Implements IInspectable, INetworkInsightsAnalysisRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnNetworkInsightsAnalysis = new CfnNetworkInsightsAnalysis(this, "MyCfnNetworkInsightsAnalysis", new CfnNetworkInsightsAnalysisProps {
                 NetworkInsightsPathId = "networkInsightsPathId",

                 // the properties below are optional
                 AdditionalAccounts = new [] { "additionalAccounts" },
                 FilterInArns = new [] { "filterInArns" },
                 FilterOutArns = new [] { "filterOutArns" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnNetworkInsightsAnalysis(Construct, string, ICfnNetworkInsightsAnalysisProps)

Create a new AWS::EC2::NetworkInsightsAnalysis.

Properties

AdditionalAccounts

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

AttrAlternatePathHints

Potential intermediate components.

AttrExplanations

The explanations.

AttrForwardPathComponents

The components in the path from source to destination.

AttrNetworkInsightsAnalysisArn

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

AttrNetworkInsightsAnalysisId

The ID of the network insights analysis.

AttrNetworkPathFound

Indicates whether the destination is reachable from the source.

AttrReturnPathComponents

The components in the path from destination to source.

AttrStartDate

The time the analysis started.

AttrStatus

The status of the network insights analysis.

AttrStatusMessage

The status message, if the status is failed .

AttrSuggestedAccounts

The IDs of potential intermediate accounts.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

Specifies a network insights analysis.

FilterInArns

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

FilterOutArns

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

NetworkInsightsAnalysisRef

A reference to a NetworkInsightsAnalysis resource.

NetworkInsightsPathId

The ID of the path.

Tags

Tag Manager which manages the tags for this resource.

TagsRaw

The tags to apply.

Methods

ArnForNetworkInsightsAnalysis(INetworkInsightsAnalysisRef)

Specifies a network insights analysis.

FromNetworkInsightsAnalysisArn(Construct, string, string)

Creates a new INetworkInsightsAnalysisRef from an ARN.

FromNetworkInsightsAnalysisId(Construct, string, string)

Creates a new INetworkInsightsAnalysisRef from a networkInsightsAnalysisId.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnNetworkInsightsAnalysis(object)

Checks whether the given object is a CfnNetworkInsightsAnalysis.

RenderProperties(IDictionary<string, object>)

Specifies a network insights analysis.

Constructors

CfnNetworkInsightsAnalysis(Construct, string, ICfnNetworkInsightsAnalysisProps)

Create a new AWS::EC2::NetworkInsightsAnalysis.

public CfnNetworkInsightsAnalysis(Construct scope, string id, ICfnNetworkInsightsAnalysisProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnNetworkInsightsAnalysisProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

Properties

AdditionalAccounts

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

public virtual string[]? AdditionalAccounts { get; set; }
Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

AttrAlternatePathHints

Potential intermediate components.

public virtual IResolvable AttrAlternatePathHints { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: AlternatePathHints

AttrExplanations

The explanations.

public virtual IResolvable AttrExplanations { get; }
Property Value

IResolvable

Remarks

For more information, see Reachability Analyzer explanation codes .

CloudformationAttribute: Explanations

AttrForwardPathComponents

The components in the path from source to destination.

public virtual IResolvable AttrForwardPathComponents { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: ForwardPathComponents

AttrNetworkInsightsAnalysisArn

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

public virtual string AttrNetworkInsightsAnalysisArn { get; }
Property Value

string

Remarks

CloudformationAttribute: NetworkInsightsAnalysisArn

AttrNetworkInsightsAnalysisId

The ID of the network insights analysis.

public virtual string AttrNetworkInsightsAnalysisId { get; }
Property Value

string

Remarks

CloudformationAttribute: NetworkInsightsAnalysisId

AttrNetworkPathFound

Indicates whether the destination is reachable from the source.

public virtual IResolvable AttrNetworkPathFound { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: NetworkPathFound

AttrReturnPathComponents

The components in the path from destination to source.

public virtual IResolvable AttrReturnPathComponents { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: ReturnPathComponents

AttrStartDate

The time the analysis started.

public virtual string AttrStartDate { get; }
Property Value

string

Remarks

CloudformationAttribute: StartDate

AttrStatus

The status of the network insights analysis.

public virtual string AttrStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: Status

AttrStatusMessage

The status message, if the status is failed .

public virtual string AttrStatusMessage { get; }
Property Value

string

Remarks

CloudformationAttribute: StatusMessage

AttrSuggestedAccounts

The IDs of potential intermediate accounts.

public virtual string[] AttrSuggestedAccounts { get; }
Property Value

string[]

Remarks

CloudformationAttribute: SuggestedAccounts

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a network insights analysis.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

FilterInArns

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

public virtual string[]? FilterInArns { get; set; }
Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

FilterOutArns

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

public virtual string[]? FilterOutArns { get; set; }
Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

NetworkInsightsAnalysisRef

A reference to a NetworkInsightsAnalysis resource.

public virtual INetworkInsightsAnalysisReference NetworkInsightsAnalysisRef { get; }
Property Value

INetworkInsightsAnalysisReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

NetworkInsightsPathId

The ID of the path.

public virtual string NetworkInsightsPathId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

TagsRaw

The tags to apply.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

Methods

ArnForNetworkInsightsAnalysis(INetworkInsightsAnalysisRef)

Specifies a network insights analysis.

public static string ArnForNetworkInsightsAnalysis(INetworkInsightsAnalysisRef resource)
Parameters
resource INetworkInsightsAnalysisRef
Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnNetworkInsightsAnalysis = new CfnNetworkInsightsAnalysis(this, "MyCfnNetworkInsightsAnalysis", new CfnNetworkInsightsAnalysisProps {
                 NetworkInsightsPathId = "networkInsightsPathId",

                 // the properties below are optional
                 AdditionalAccounts = new [] { "additionalAccounts" },
                 FilterInArns = new [] { "filterInArns" },
                 FilterOutArns = new [] { "filterOutArns" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

FromNetworkInsightsAnalysisArn(Construct, string, string)

Creates a new INetworkInsightsAnalysisRef from an ARN.

public static INetworkInsightsAnalysisRef FromNetworkInsightsAnalysisArn(Construct scope, string id, string arn)
Parameters
scope Construct
id string
arn string
Returns

INetworkInsightsAnalysisRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

FromNetworkInsightsAnalysisId(Construct, string, string)

Creates a new INetworkInsightsAnalysisRef from a networkInsightsAnalysisId.

public static INetworkInsightsAnalysisRef FromNetworkInsightsAnalysisId(Construct scope, string id, string networkInsightsAnalysisId)
Parameters
scope Construct
id string
networkInsightsAnalysisId string
Returns

INetworkInsightsAnalysisRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

IsCfnNetworkInsightsAnalysis(object)

Checks whether the given object is a CfnNetworkInsightsAnalysis.

public static bool IsCfnNetworkInsightsAnalysis(object x)
Parameters
x object
Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies a network insights analysis.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-networkinsightsanalysis.html

CloudformationResource: AWS::EC2::NetworkInsightsAnalysis

ExampleMetadata: fixture=_generated

Implements

IInspectable
INetworkInsightsAnalysisRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggable
Back to top Generated by DocFX