Start Flow Flush

networkfirewall_start_flow_flush

R Documentation

Begins the flushing of traffic from the firewall, according to the filters you define¶

Description¶

Begins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table.

While the flush completes, impacted flows are processed as midstream traffic. This may result in a temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy before you perform a flush operation.

Usage¶

networkfirewall_start_flow_flush(FirewallArn, AvailabilityZone,
  MinimumFlowAgeInSeconds, FlowFilters)

Arguments¶

FirewallArn

[required] The Amazon Resource Name (ARN) of the firewall.

AvailabilityZone

The ID of the Availability Zone where the firewall is located. For example, ⁠us-east-2a⁠.

Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

MinimumFlowAgeInSeconds

The reqested FlowOperation ignores flows with an age (in seconds) lower than MinimumFlowAgeInSeconds. You provide this for start commands.

FlowFilters

[required] Defines the scope a flow operation. You can use up to 20 filters to configure a single flow operation.

Value¶

A list with the following syntax:

list(
  FirewallArn = "string",
  FlowOperationId = "string",
  FlowOperationStatus = "COMPLETED"|"IN_PROGRESS"|"FAILED"|"COMPLETED_WITH_ERRORS"
)

Request syntax¶

svc$start_flow_flush(
  FirewallArn = "string",
  AvailabilityZone = "string",
  MinimumFlowAgeInSeconds = 123,
  FlowFilters = list(
    list(
      SourceAddress = list(
        AddressDefinition = "string"
      ),
      DestinationAddress = list(
        AddressDefinition = "string"
      ),
      SourcePort = "string",
      DestinationPort = "string",
      Protocols = list(
        "string"
      )
    )
  )
)