github.com/aavshr/aws-sdk-go@v1.41.3/service/networkfirewall/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package networkfirewall provides the client and types for making API
     4  // requests to AWS Network Firewall.
     5  //
     6  // This is the API Reference for AWS Network Firewall. This guide is for developers
     7  // who need detailed information about the Network Firewall API actions, data
     8  // types, and errors.
     9  //
    10  //    * The REST API requires you to handle connection details, such as calculating
    11  //    signatures, handling request retries, and error handling. For general
    12  //    information about using the AWS REST APIs, see AWS APIs (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html).
    13  //    To access Network Firewall using the REST API endpoint: https://network-firewall.<region>.amazonaws.com
    14  //
    15  //    * Alternatively, you can use one of the AWS SDKs to access an API that's
    16  //    tailored to the programming language or platform that you're using. For
    17  //    more information, see AWS SDKs (http://aws.amazon.com/tools/#SDKs).
    18  //
    19  //    * For descriptions of Network Firewall features, including and step-by-step
    20  //    instructions on how to use them through the Network Firewall console,
    21  //    see the Network Firewall Developer Guide (https://docs.aws.amazon.com/network-firewall/latest/developerguide/).
    22  //
    23  // Network Firewall is a stateful, managed, network firewall and intrusion detection
    24  // and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With
    25  // Network Firewall, you can filter traffic at the perimeter of your VPC. This
    26  // includes filtering traffic going to and coming from an internet gateway,
    27  // NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules
    28  // that are compatible with Suricata, a free, open source intrusion detection
    29  // system (IDS) engine. AWS Network Firewall supports Suricata version 5.0.2.
    30  // For information about Suricata, see the Suricata website (https://suricata-ids.org/).
    31  //
    32  // You can use Network Firewall to monitor and protect your VPC traffic in a
    33  // number of ways. The following are just a few examples:
    34  //
    35  //    * Allow domains or IP addresses for known AWS service endpoints, such
    36  //    as Amazon S3, and block all other forms of traffic.
    37  //
    38  //    * Use custom lists of known bad domains to limit the types of domain names
    39  //    that your applications can access.
    40  //
    41  //    * Perform deep packet inspection on traffic entering or leaving your VPC.
    42  //
    43  //    * Use stateful protocol detection to filter protocols like HTTPS, regardless
    44  //    of the port used.
    45  //
    46  // To enable Network Firewall for your VPCs, you perform steps in both Amazon
    47  // VPC and in Network Firewall. For information about using Amazon VPC, see
    48  // Amazon VPC User Guide (https://docs.aws.amazon.com/vpc/latest/userguide/).
    49  //
    50  // To start using Network Firewall, do the following:
    51  //
    52  // (Optional) If you don't already have a VPC that you want to protect, create
    53  // it in Amazon VPC.
    54  //
    55  // In Amazon VPC, in each Availability Zone where you want to have a firewall
    56  // endpoint, create a subnet for the sole use of Network Firewall.
    57  //
    58  // In Network Firewall, create stateless and stateful rule groups, to define
    59  // the components of the network traffic filtering behavior that you want your
    60  // firewall to have.
    61  //
    62  // In Network Firewall, create a firewall policy that uses your rule groups
    63  // and specifies additional default traffic filtering behavior.
    64  //
    65  // In Network Firewall, create a firewall and specify your new firewall policy
    66  // and VPC subnets. Network Firewall creates a firewall endpoint in each subnet
    67  // that you specify, with the behavior that's defined in the firewall policy.
    68  //
    69  // In Amazon VPC, use ingress routing enhancements to route traffic through
    70  // the new firewall endpoints.
    71  //
    72  // See https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12 for more information on this service.
    73  //
    74  // See networkfirewall package documentation for more information.
    75  // https://docs.aws.amazon.com/sdk-for-go/api/service/networkfirewall/
    76  //
    77  // Using the Client
    78  //
    79  // To contact AWS Network Firewall with the SDK use the New function to create
    80  // a new service client. With that client you can make API requests to the service.
    81  // These clients are safe to use concurrently.
    82  //
    83  // See the SDK's documentation for more information on how to use the SDK.
    84  // https://docs.aws.amazon.com/sdk-for-go/api/
    85  //
    86  // See aws.Config documentation for more information on configuring SDK clients.
    87  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    88  //
    89  // See the AWS Network Firewall client NetworkFirewall for more
    90  // information on creating client for this service.
    91  // https://docs.aws.amazon.com/sdk-for-go/api/service/networkfirewall/#New
    92  package networkfirewall