Create Network Insights Path

ec2_create_network_insights_path

R Documentation

Creates a path to analyze for reachability

Description

Creates a path to analyze for reachability.

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

Usage

ec2_create_network_insights_path(SourceIp, DestinationIp, Source,
  Destination, Protocol, DestinationPort, TagSpecifications, DryRun,
  ClientToken, FilterAtSource, FilterAtDestination)

Arguments

SourceIp

The IP address of the source.

DestinationIp

The IP address of the destination.

Source

[required] The ID or ARN of the source. If the resource is in another account, you must specify an ARN.

Destination

The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.

Protocol

[required] The protocol.

DestinationPort

The destination port.

TagSpecifications

The tags to add to the path.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

ClientToken

[required] Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

FilterAtSource

Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port.

FilterAtDestination

Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address.

Value

A list with the following syntax:

list(
  NetworkInsightsPath = list(
    NetworkInsightsPathId = "string",
    NetworkInsightsPathArn = "string",
    CreatedDate = as.POSIXct(
      "2015-01-01"
    ),
    Source = "string",
    Destination = "string",
    SourceArn = "string",
    DestinationArn = "string",
    SourceIp = "string",
    DestinationIp = "string",
    Protocol = "tcp"|"udp",
    DestinationPort = 123,
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    FilterAtSource = list(
      SourceAddress = "string",
      SourcePortRange = list(
        FromPort = 123,
        ToPort = 123
      ),
      DestinationAddress = "string",
      DestinationPortRange = list(
        FromPort = 123,
        ToPort = 123
      )
    ),
    FilterAtDestination = list(
      SourceAddress = "string",
      SourcePortRange = list(
        FromPort = 123,
        ToPort = 123
      ),
      DestinationAddress = "string",
      DestinationPortRange = list(
        FromPort = 123,
        ToPort = 123
      )
    )
  )
)

Request syntax

svc$create_network_insights_path(
  SourceIp = "string",
  DestinationIp = "string",
  Source = "string",
  Destination = "string",
  Protocol = "tcp"|"udp",
  DestinationPort = 123,
  TagSpecifications = list(
    list(
      ResourceType = "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"ipam-external-resource-verification-token",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  DryRun = TRUE|FALSE,
  ClientToken = "string",
  FilterAtSource = list(
    SourceAddress = "string",
    SourcePortRange = list(
      FromPort = 123,
      ToPort = 123
    ),
    DestinationAddress = "string",
    DestinationPortRange = list(
      FromPort = 123,
      ToPort = 123
    )
  ),
  FilterAtDestination = list(
    SourceAddress = "string",
    SourcePortRange = list(
      FromPort = 123,
      ToPort = 123
    ),
    DestinationAddress = "string",
    DestinationPortRange = list(
      FromPort = 123,
      ToPort = 123
    )
  )
)