[ aws . ec2 ]

create-network-insights-access-scope

Description

Creates a Network Access Scope.

Amazon Web Services Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on Amazon Web Services conform to their network security and governance objectives. For more information, see the Amazon Web Services Network Access Analyzer Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-network-insights-access-scope
[--match-paths <value>]
[--exclude-paths <value>]
[--client-token <value>]
[--tag-specifications <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--match-paths (list)

The paths to match.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

JSON Syntax:

[
  {
    "Source": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "Destination": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "ThroughResources": [
      {
        "ResourceStatement": {
          "Resources": ["string", ...],
          "ResourceTypes": ["string", ...]
        }
      }
      ...
    ]
  }
  ...
]

--exclude-paths (list)

The paths to exclude.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

JSON Syntax:

[
  {
    "Source": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "Destination": {
      "PacketHeaderStatement": {
        "SourceAddresses": ["string", ...],
        "DestinationAddresses": ["string", ...],
        "SourcePorts": ["string", ...],
        "DestinationPorts": ["string", ...],
        "SourcePrefixLists": ["string", ...],
        "DestinationPrefixLists": ["string", ...],
        "Protocols": ["tcp"|"udp", ...]
      },
      "ResourceStatement": {
        "Resources": ["string", ...],
        "ResourceTypes": ["string", ...]
      }
    },
    "ThroughResources": [
      {
        "ResourceStatement": {
          "Resources": ["string", ...],
          "ResourceTypes": ["string", ...]
        }
      }
      ...
    ]
  }
  ...
]

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

--tag-specifications (list)

The tags to apply.

(structure)

The tags to apply to a resource when the resource is being created.

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"|"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-route-table"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-service"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log",
    "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 .

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

See ‘aws help’ for descriptions of global parameters.

Examples

To create Network Insights access scopes

The following create-network-insights-access-scope example creates an access scope in your AWS account.

aws ec2 create-network-insights-access-scope \
    --cli-input-json file://access-scope-file.json

Contents of access-scope-file.json:

{
    {
         "MatchPaths": [
              {
                   "Source": {
                        "ResourceStatement": {
                             "Resources": [
                                  "vpc-abcd12e3"
                             ]
                        }
                   }
              }
         ],
         "ExcludePaths": [
              {
                   "Source": {
                        "ResourceStatement": {
                             "ResourceTypes": [
                                  "AWS::EC2::InternetGateway"
                             ]
                        }
                   }
              }
         ]
    }
}

Output:

{
    "NetworkInsightsAccessScopeAnalysisId": "nisa-123456789111"
}{
    "NetworkInsightsAccessScope": {
        "NetworkInsightsAccessScopeId": "nis-123456789222",
        "NetworkInsightsAccessScopeArn": "arn:aws:ec2:us-east-1:123456789012:network-insights-access-scope/nis-123456789222",
        "CreatedDate": "2022-01-25T19:20:28.796000+00:00",
        "UpdatedDate": "2022-01-25T19:20:28.797000+00:00"
    },
    "NetworkInsightsAccessScopeContent": {
        "NetworkInsightsAccessScopeId": "nis-123456789333",
        "MatchPaths": [
            {
                "Source": {
                    "ResourceStatement": {
                        "Resources": [
                            "vpc-abcd12e3"
                        ]
                    }
                }
            }
        ],
        "ExcludePaths": [
            {
                "Source": {
                    "ResourceStatement": {
                        "ResourceTypes": [
                            "AWS::EC2::InternetGateway"
                        ]
                    }
                }
            }
        ]
    }
}

For more information, see Getting started with Network Access Analyzer using the AWS CLI in the Network Access Analyzer Guide.

Output

NetworkInsightsAccessScope -> (structure)

The Network Access Scope.

NetworkInsightsAccessScopeId -> (string)

The ID of the Network Access Scope.

NetworkInsightsAccessScopeArn -> (string)

The Amazon Resource Name (ARN) of the Network Access Scope.

CreatedDate -> (timestamp)

The creation date.

UpdatedDate -> (timestamp)

The last updated date.

Tags -> (list)

The tags.

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

NetworkInsightsAccessScopeContent -> (structure)

The Network Access Scope content.

NetworkInsightsAccessScopeId -> (string)

The ID of the Network Access Scope.

MatchPaths -> (list)

The paths to match.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ExcludePaths -> (list)

The paths to exclude.

(structure)

Describes a path.

Source -> (structure)

The source.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

Destination -> (structure)

The destination.

PacketHeaderStatement -> (structure)

The packet header statement.

SourceAddresses -> (list)

The source addresses.

(string)

DestinationAddresses -> (list)

The destination addresses.

(string)

SourcePorts -> (list)

The source ports.

(string)

DestinationPorts -> (list)

The destination ports.

(string)

SourcePrefixLists -> (list)

The source prefix lists.

(string)

DestinationPrefixLists -> (list)

The destination prefix lists.

(string)

Protocols -> (list)

The protocols.

(string)

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)

ThroughResources -> (list)

The through resources.

(structure)

Describes a through resource statement.

ResourceStatement -> (structure)

The resource statement.

Resources -> (list)

The resources.

(string)

ResourceTypes -> (list)

The resource types.

(string)