@aws-sdk/client-network-firewall 3.816.0 → 3.819.0

package/dist-types/commands/ListVpcEndpointAssociationsCommand.d.ts

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListVpcEndpointAssociationsRequest, ListVpcEndpointAssociationsResponse } from "../models/models_0";
+import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListVpcEndpointAssociationsCommand}.
+ */
+export interface ListVpcEndpointAssociationsCommandInput extends ListVpcEndpointAssociationsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListVpcEndpointAssociationsCommand}.
+ */
+export interface ListVpcEndpointAssociationsCommandOutput extends ListVpcEndpointAssociationsResponse, __MetadataBearer {
+}
+declare const ListVpcEndpointAssociationsCommand_base: {
+    new (input: ListVpcEndpointAssociationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListVpcEndpointAssociationsCommandInput, ListVpcEndpointAssociationsCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListVpcEndpointAssociationsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListVpcEndpointAssociationsCommandInput, ListVpcEndpointAssociationsCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll,
+ *        this returns only the endpoint associations for that firewall. </p>
+ *          <p>Depending on your setting for max results and the number of associations, a single call
+ *          might not return the full list. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { NetworkFirewallClient, ListVpcEndpointAssociationsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
+ * // const { NetworkFirewallClient, ListVpcEndpointAssociationsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
+ * const client = new NetworkFirewallClient(config);
+ * const input = { // ListVpcEndpointAssociationsRequest
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ *   FirewallArn: "STRING_VALUE",
+ * };
+ * const command = new ListVpcEndpointAssociationsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListVpcEndpointAssociationsResponse
+ * //   NextToken: "STRING_VALUE",
+ * //   VpcEndpointAssociations: [ // VpcEndpointAssociations
+ * //     { // VpcEndpointAssociationMetadata
+ * //       VpcEndpointAssociationArn: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListVpcEndpointAssociationsCommandInput - {@link ListVpcEndpointAssociationsCommandInput}
+ * @returns {@link ListVpcEndpointAssociationsCommandOutput}
+ * @see {@link ListVpcEndpointAssociationsCommandInput} for command's `input` shape.
+ * @see {@link ListVpcEndpointAssociationsCommandOutput} for command's `response` shape.
+ * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
+ *
+ * @throws {@link InternalServerError} (server fault)
+ *  <p>Your request is valid, but Network Firewall couldn't perform the operation because of a
+ *          system problem. Retry your request. </p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The operation failed because of a problem with your request. Examples include: </p>
+ *          <ul>
+ *             <li>
+ *                <p>You specified an unsupported parameter name or value.</p>
+ *             </li>
+ *             <li>
+ *                <p>You tried to update a property with a value that isn't among the available
+ *                types.</p>
+ *             </li>
+ *             <li>
+ *                <p>Your request references an ARN that is malformed, or corresponds to a resource
+ *                that isn't valid in the context of the request.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Unable to process the request due to throttling limitations.</p>
+ *
+ * @throws {@link NetworkFirewallServiceException}
+ * <p>Base exception class for all service exceptions from NetworkFirewall service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListVpcEndpointAssociationsCommand extends ListVpcEndpointAssociationsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListVpcEndpointAssociationsRequest;
+            output: ListVpcEndpointAssociationsResponse;
+        };
+        sdk: {
+            input: ListVpcEndpointAssociationsCommandInput;
+            output: ListVpcEndpointAssociationsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/PutResourcePolicyCommand.d.ts

@@ -27,10 +27,11 @@ declare const PutResourcePolicyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service
- *            to manage resource sharing for Network Firewall. </p>
- *          <p>Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform. </p>
- *          <p>When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy. </p>
+ * <p>Creates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall. </p>
+ *          <p>For information about using sharing with Network Firewall resources, see
+ *     <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/sharing.html">Sharing Network Firewall resources</a> in the <i>Network Firewall Developer Guide</i>.</p>
+ *          <p>Use this operation to create or update a resource policy for your Network Firewall rule group, firewall policy, or firewall. In the resource policy, you specify the accounts that you want to share the Network Firewall resource with and the operations that you want the accounts to be able to perform. </p>
+ *          <p>When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared resource. </p>
  *          <ul>
  *             <li>
  *                <p>

package/dist-types/commands/StartFlowCaptureCommand.d.ts

@@ -45,6 +45,8 @@ declare const StartFlowCaptureCommand_base: {
  * const input = { // StartFlowCaptureRequest
  *   FirewallArn: "STRING_VALUE", // required
  *   AvailabilityZone: "STRING_VALUE",
+ *   VpcEndpointAssociationArn: "STRING_VALUE",
+ *   VpcEndpointId: "STRING_VALUE",
  *   MinimumFlowAgeInSeconds: Number("int"),
  *   FlowFilters: [ // FlowFilters // required
  *     { // FlowFilter

package/dist-types/commands/StartFlowFlushCommand.d.ts

@@ -44,6 +44,8 @@ declare const StartFlowFlushCommand_base: {
  * const input = { // StartFlowFlushRequest
  *   FirewallArn: "STRING_VALUE", // required
  *   AvailabilityZone: "STRING_VALUE",
+ *   VpcEndpointAssociationArn: "STRING_VALUE",
+ *   VpcEndpointId: "STRING_VALUE",
  *   MinimumFlowAgeInSeconds: Number("int"),
  *   FlowFilters: [ // FlowFilters // required
  *     { // FlowFilter

package/dist-types/commands/index.d.ts

@@ -4,12 +4,15 @@ export * from "./CreateFirewallCommand";
 export * from "./CreateFirewallPolicyCommand";
 export * from "./CreateRuleGroupCommand";
 export * from "./CreateTLSInspectionConfigurationCommand";
+export * from "./CreateVpcEndpointAssociationCommand";
 export * from "./DeleteFirewallCommand";
 export * from "./DeleteFirewallPolicyCommand";
 export * from "./DeleteResourcePolicyCommand";
 export * from "./DeleteRuleGroupCommand";
 export * from "./DeleteTLSInspectionConfigurationCommand";
+export * from "./DeleteVpcEndpointAssociationCommand";
 export * from "./DescribeFirewallCommand";
+export * from "./DescribeFirewallMetadataCommand";
 export * from "./DescribeFirewallPolicyCommand";
 export * from "./DescribeFlowOperationCommand";
 export * from "./DescribeLoggingConfigurationCommand";
@@ -17,6 +20,7 @@ export * from "./DescribeResourcePolicyCommand";
 export * from "./DescribeRuleGroupCommand";
 export * from "./DescribeRuleGroupMetadataCommand";
 export * from "./DescribeTLSInspectionConfigurationCommand";
+export * from "./DescribeVpcEndpointAssociationCommand";
 export * from "./DisassociateSubnetsCommand";
 export * from "./GetAnalysisReportResultsCommand";
 export * from "./ListAnalysisReportsCommand";
@@ -27,6 +31,7 @@ export * from "./ListFlowOperationsCommand";
 export * from "./ListRuleGroupsCommand";
 export * from "./ListTLSInspectionConfigurationsCommand";
 export * from "./ListTagsForResourceCommand";
+export * from "./ListVpcEndpointAssociationsCommand";
 export * from "./PutResourcePolicyCommand";
 export * from "./StartAnalysisReportCommand";
 export * from "./StartFlowCaptureCommand";

package/dist-types/index.d.ts

@@ -61,12 +61,17 @@
  *                subnet for the sole use of Network Firewall. </p>
  *             </li>
  *             <li>
- *                <p>In Network Firewall, create stateless and stateful rule groups,
+ *                <p>In Network Firewall, define the firewall behavior as follows: </p>
+ *                <ol>
+ *                   <li>
+ *                      <p>Create stateless and stateful rule groups,
  *                  to define the components of the network traffic filtering behavior that you want your firewall to have. </p>
- *             </li>
- *             <li>
- *                <p>In Network Firewall, create a firewall policy that uses your rule groups and
- *                  specifies additional default traffic filtering behavior. </p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Create a firewall policy that uses your rule groups and
+ *                      specifies additional default traffic filtering behavior. </p>
+ *                   </li>
+ *                </ol>
  *             </li>
  *             <li>
  *                <p>In Network Firewall, create a firewall and specify your new firewall policy and
@@ -78,6 +83,9 @@
  *                endpoints.</p>
  *             </li>
  *          </ol>
+ *          <p>After your firewall is established, you can add firewall endpoints for new Availability Zones by following the prior steps for the Amazon VPC setup and
+ *       firewall subnet definitions. You can also add endpoints to Availability Zones that you're using in the firewall, either for the same VPC
+ *           or for another VPC, by following the prior steps for the Amazon VPC setup, and defining the new VPC subnets as VPC endpoint associations. </p>
  *
  * @packageDocumentation
  */