[ aws . ec2 ]

create-network-insights-path

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 .

See also: AWS API Documentation

Synopsis

  create-network-insights-path
[--source-ip <value>]
[--destination-ip <value>]
--source <value>
[--destination <value>]
--protocol <value>
[--destination-port <value>]
[--tag-specifications <value>]
[--dry-run | --no-dry-run]
[--client-token <value>]
[--filter-at-source <value>]
[--filter-at-destination <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--source-ip (string)

The IP address of the source.

--destination-ip (string)

The IP address of the destination.

--source (string)

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

--destination (string)

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

--protocol (string)

The protocol.

Possible values:

• tcp
• udp

--destination-port (integer)

The destination port.

--tag-specifications (list)

The tags to add to the path.

(structure)

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.

ResourceType -> (string)

The type of resource to tag on creation.

Tags -> (list)

The tags to apply to the resource.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Shorthand Syntax:

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

JSON Syntax:

[
  {
    "ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"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"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--dry-run | --no-dry-run (boolean)

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 .

--client-token (string)

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

--filter-at-source (structure)

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.

SourceAddress -> (string)

The source IPv4 address.

SourcePortRange -> (structure)

The source port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.

DestinationAddress -> (string)

The destination IPv4 address.

DestinationPortRange -> (structure)

The destination port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.

Shorthand Syntax:

SourceAddress=string,SourcePortRange={FromPort=integer,ToPort=integer},DestinationAddress=string,DestinationPortRange={FromPort=integer,ToPort=integer}

JSON Syntax:

{
  "SourceAddress": "string",
  "SourcePortRange": {
    "FromPort": integer,
    "ToPort": integer
  },
  "DestinationAddress": "string",
  "DestinationPortRange": {
    "FromPort": integer,
    "ToPort": integer
  }
}

--filter-at-destination (structure)

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.

SourceAddress -> (string)

The source IPv4 address.

SourcePortRange -> (structure)

The source port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.

DestinationAddress -> (string)

The destination IPv4 address.

DestinationPortRange -> (structure)

The destination port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.

Shorthand Syntax:

SourceAddress=string,SourcePortRange={FromPort=integer,ToPort=integer},DestinationAddress=string,DestinationPortRange={FromPort=integer,ToPort=integer}

JSON Syntax:

{
  "SourceAddress": "string",
  "SourcePortRange": {
    "FromPort": integer,
    "ToPort": integer
  },
  "DestinationAddress": "string",
  "DestinationPortRange": {
    "FromPort": integer,
    "ToPort": integer
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a path

The following create-network-insights-path example creates a path. The source is the specified internet gateway and the destination is the specified EC2 instance. To determine whether the destination is reachable using the specified protocol and port, analyze the path using the start-network-insights-analysis command.

aws ec2 create-network-insights-path \
    --source igw-0797cccdc9d73b0e5 \
    --destination i-0495d385ad28331c7 \
    --destination-port 22 \
    --protocol TCP

Output:

{
    "NetworkInsightsPaths": {
        "NetworkInsightsPathId": "nip-0b26f224f1d131fa8",
        "NetworkInsightsPathArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-path/nip-0b26f224f1d131fa8",
        "CreatedDate": "2021-01-20T22:43:46.933Z",
        "Source": "igw-0797cccdc9d73b0e5",
        "Destination": "i-0495d385ad28331c7",
        "Protocol": "tcp"
    }
}

For more information, see Getting started using the AWS CLI in the Reachability Analyzer Guide.

Output

NetworkInsightsPath -> (structure)

Information about the path.

NetworkInsightsPathId -> (string)

The ID of the path.

NetworkInsightsPathArn -> (string)

The Amazon Resource Name (ARN) of the path.

CreatedDate -> (timestamp)

The time stamp when the path was created.

Source -> (string)

The ID of the source.

Destination -> (string)

The ID of the destination.

SourceArn -> (string)

The Amazon Resource Name (ARN) of the source.

DestinationArn -> (string)

The Amazon Resource Name (ARN) of the destination.

SourceIp -> (string)

The IP address of the source.

DestinationIp -> (string)

The IP address of the destination.

Protocol -> (string)

The protocol.

DestinationPort -> (integer)

The destination port.

Tags -> (list)

The tags associated with the path.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

FilterAtSource -> (structure)

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

SourceAddress -> (string)

The source IPv4 address.

SourcePortRange -> (structure)

The source port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.

DestinationAddress -> (string)

The destination IPv4 address.

DestinationPortRange -> (structure)

The destination port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.

FilterAtDestination -> (structure)

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

SourceAddress -> (string)

The source IPv4 address.

SourcePortRange -> (structure)

The source port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.

DestinationAddress -> (string)

The destination IPv4 address.

DestinationPortRange -> (structure)

The destination port range.

FromPort -> (integer)

The first port in the range.

ToPort -> (integer)

The last port in the range.